osgSim::BlinkSequence Class Reference

#include <BlinkSequence.h>

Inheritance diagram for osgSim::BlinkSequence:

Collaboration diagram for osgSim::BlinkSequence:

Public Member Functions
	BlinkSequence ()
	BlinkSequence (const BlinkSequence &bs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgSim, BlinkSequence)
void	addPulse (double length, const osg::Vec4 &color)
int	getNumPulses () const
void	getPulse (unsigned int i, double &length, osg::Vec4 &color) const
void	setPulse (unsigned int i, double length, const osg::Vec4 &color)
double	getPulsePeriod () const
void	setSequenceGroup (SequenceGroup *sg)
SequenceGroup *	getSequenceGroup ()
const SequenceGroup *	getSequenceGroup () const
void	setPhaseShift (double ps)
double	getPhaseShift () const
double	localTime (double time) const
osg::Vec4	color (double time, double length) const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual const char *	className () const =0
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Protected Types
typedef std::pair< double, osg::Vec4 >	IntervalColor
typedef std::vector < IntervalColor >	PulseData

Protected Attributes
double	_pulsePeriod
double	_phaseShift
PulseData	_pulseData
osg::ref_ptr< SequenceGroup >	_sequenceGroup
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Detailed Description

Definition at line 46 of file BlinkSequence.h.

Member Typedef Documentation

typedef std::pair<double,osg::Vec4> osgSim::BlinkSequence::IntervalColor

protected

Definition at line 96 of file BlinkSequence.h.

typedef std::vector<IntervalColor> osgSim::BlinkSequence::PulseData

protected

Definition at line 97 of file BlinkSequence.h.

Constructor & Destructor Documentation

osgSim::BlinkSequence::BlinkSequence

(

)

osgSim::BlinkSequence::BlinkSequence	(	const BlinkSequence &	bs,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

Member Function Documentation

void osgSim::BlinkSequence::addPulse ( double  length, const osg::Vec4 &  color  )

inline

add a pulse of specified color and duration to the BlinkSequence.

Definition at line 113 of file BlinkSequence.h.

osg::Vec4 osgSim::BlinkSequence::color ( double  time, double  length  ) const

inline

compute the color for the time interval sepecifed. Averages the colors if the length is greater than the current pulse.

Definition at line 134 of file BlinkSequence.h.

Here is the call graph for this function:

Here is the caller graph for this function:

int osgSim::BlinkSequence::getNumPulses ( ) const

inline

return the number of pulses.

Definition at line 60 of file BlinkSequence.h.

double osgSim::BlinkSequence::getPhaseShift ( ) const

inline

get the pahse shift.

Definition at line 84 of file BlinkSequence.h.

void osgSim::BlinkSequence::getPulse ( unsigned int  i, double &  length, osg::Vec4 &  color  ) const

inline

return the pulse data at position i.

Definition at line 119 of file BlinkSequence.h.

double osgSim::BlinkSequence::getPulsePeriod ( ) const

inline

get the total pulse period of the blink sequence, which is equal to the sum of all the pulse periods.

Definition at line 69 of file BlinkSequence.h.

SequenceGroup* osgSim::BlinkSequence::getSequenceGroup ( )

inline

get the non const sequence group.

Definition at line 75 of file BlinkSequence.h.

const SequenceGroup* osgSim::BlinkSequence::getSequenceGroup ( ) const

inline

get the const sequence group.

Definition at line 78 of file BlinkSequence.h.

double osgSim::BlinkSequence::localTime ( double  time ) const

inline

compute the local time clamped to this BlinkSequences period, and accounting for the phase shift and sequence group.

Definition at line 106 of file BlinkSequence.h.

Here is the caller graph for this function:

osgSim::BlinkSequence::META_Object	(	osgSim	,
		BlinkSequence
	)

void osgSim::BlinkSequence::setPhaseShift ( double  ps )

inline

set the phase shift of the blink sequence, this would be used to shift a sequence within a sequence group.

Definition at line 81 of file BlinkSequence.h.

void osgSim::BlinkSequence::setPulse ( unsigned int  i, double  length, const osg::Vec4 &  color  )

inline

set pulse of specified color and duration to the BlinkSequence.

Definition at line 126 of file BlinkSequence.h.

Here is the call graph for this function:

void osgSim::BlinkSequence::setSequenceGroup ( SequenceGroup *  sg )

inline

set the sequence group which can be used to synchronize related blink sequences.

Definition at line 72 of file BlinkSequence.h.

Member Data Documentation

double osgSim::BlinkSequence::_phaseShift

protected

Definition at line 100 of file BlinkSequence.h.

PulseData osgSim::BlinkSequence::_pulseData

protected

Definition at line 101 of file BlinkSequence.h.

double osgSim::BlinkSequence::_pulsePeriod

protected

Definition at line 99 of file BlinkSequence.h.

osg::ref_ptr<SequenceGroup> osgSim::BlinkSequence::_sequenceGroup

protected

Definition at line 102 of file BlinkSequence.h.

---

The documentation for this class was generated from the following file:

• osg_head/include/osgSim/BlinkSequence.h