openscenegraph
Public Member Functions | Protected Types | Protected Attributes | List of all members
osgSim::BlinkSequence Class Reference
Inheritance diagram for osgSim::BlinkSequence:
osg::Object osg::Referenced

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)
SequenceGroupgetSequenceGroup ()
const SequenceGroupgetSequenceGroup () 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 ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
virtual const char * className () const =0
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () 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::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Member Functions inherited from osg::Object
virtual ~Object ()

Member Typedef Documentation

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

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.

References _pulseData, and _pulsePeriod.

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.

References _pulseData, and localTime().

Referenced by setPulse().

int osgSim::BlinkSequence::getNumPulses ( ) const
inline

return the number of pulses.

double osgSim::BlinkSequence::getPhaseShift ( ) const
inline

get the pahse shift.

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

return the pulse data at position i.

References _pulseData.

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.

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

get the non const sequence group.

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

get the const sequence group.

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.

References _phaseShift, _pulsePeriod, _sequenceGroup, and osg::ref_ptr< T >::valid().

Referenced by color().

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.

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

set pulse of specified color and duration to the BlinkSequence.

References _pulseData, and color().

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

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

Member Data Documentation

double osgSim::BlinkSequence::_phaseShift
protected

Referenced by localTime().

PulseData osgSim::BlinkSequence::_pulseData
protected

Referenced by addPulse(), color(), getPulse(), and setPulse().

double osgSim::BlinkSequence::_pulsePeriod
protected

Referenced by addPulse(), and localTime().

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

Referenced by localTime().


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