openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Sequence Class Reference

#include <Sequence>

Inheritance diagram for osg::Sequence:
osg::Group osg::Node osg::Object osg::Referenced

Public Types

enum  LoopMode { LOOP , SWING }
 
enum  SequenceMode { START , STOP , PAUSE , RESUME }
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 Sequence ()
 
 Sequence (const Sequence &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Sequence)
 
virtual void traverse (NodeVisitor &nv)
 
virtual bool addChild (Node *child)
 
virtual bool addChild (Node *child, double t)
 
template<class T >
bool addChild (const ref_ptr< T > &child, double t)
 
virtual bool insertChild (unsigned int index, Node *child)
 
virtual bool insertChild (unsigned int index, Node *child, double t)
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child, double t)
 
virtual bool removeChild (Node *child)
 
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 
void setValue (int value)
 
int getValue () const
 
void setTime (unsigned int frame, double t)
 
double getTime (unsigned int frame) const
 
void setTimeList (const std::vector< double > &timeList)
 
const std::vector< double > & getTimeList () const
 
void setDefaultTime (double t)
 
double getDefaultTime (void) const
 
void setLastFrameTime (double t)
 
double getLastFrameTime (void) const
 
unsigned int getNumFrames () const
 
void setLoopMode (LoopMode mode)
 
LoopMode getLoopMode () const
 
void setBegin (int begin)
 
int getBegin () const
 
void setEnd (int end)
 
int getEnd () const
 
void setInterval (LoopMode mode, int begin, int end)
 
void getInterval (LoopMode &mode, int &begin, int &end) const
 
void setSpeed (float speed)
 
float getSpeed () const
 
void setNumRepeats (int nreps)
 
int getNumRepeats () const
 
void setDuration (float speed, int nreps=-1)
 
void getDuration (float &speed, int &nreps) const
 
void setMode (SequenceMode mode)
 
SequenceMode getMode () const
 
void setSync (bool sync)
 
bool getSync () const
 
void setClearOnStop (bool clearOnStop)
 
bool getClearOnStop () const
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Group)
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
template<class T >
bool addChild (const ref_ptr< T > &child)
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child)
 
template<class T >
bool removeChild (const ref_ptr< T > &child)
 
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 
virtual bool replaceChild (Node *origChild, Node *newChild)
 
template<class T , class R >
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
 
virtual unsigned int getNumChildren () const
 
virtual bool setChild (unsigned int i, Node *node)
 
NodegetChild (unsigned int i)
 
const NodegetChild (unsigned int i) const
 
bool containsNode (const Node *node) const
 
template<class T >
bool containsNode (const ref_ptr< T > &node) const
 
unsigned int getChildIndex (const Node *node) const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
virtual BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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)
 
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 &)
 
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 Member Functions

virtual ~Sequence ()
 
int _getNextValue (void)
 
void _update (void)
 
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
 
virtual void childRemoved (unsigned int, unsigned int)
 
virtual void childInserted (unsigned int)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- 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
 

Protected Attributes

int _value
 
double _now
 
double _start
 
std::vector< double > _frameTime
 
double _totalTime
 
bool _resetTotalTime
 
LoopMode _loopMode
 
int _begin
 
int _end
 
float _speed
 
int _nreps
 
int _nrepsRemain
 
int _step
 
double _defaultTime
 
double _lastFrameTime
 
double _saveRealLastFrameTime
 
unsigned int _saveRealLastFrameValue
 
SequenceMode _mode
 
bool _sync
 
bool _clearOnStop
 
- Protected Attributes inherited from osg::Group
NodeList _children
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- 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

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

Sequence is a Group node which allows automatic, time based switching between children.

Member Enumeration Documentation

◆ LoopMode

Interval modes. 'Loop' repeats frames 1-N; 'swing' repeats 1->N, (N-1)->1.

Enumerator
LOOP 
SWING 

◆ SequenceMode

Sequence modes.

Enumerator
START 
STOP 
PAUSE 
RESUME 

Constructor & Destructor Documentation

◆ Sequence() [1/2]

osg::Sequence::Sequence ( )

◆ Sequence() [2/2]

osg::Sequence::Sequence ( const Sequence ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~Sequence()

virtual osg::Sequence::~Sequence ( )
inlineprotectedvirtual

Member Function Documentation

◆ _getNextValue()

int osg::Sequence::_getNextValue ( void  )
protected

◆ _update()

void osg::Sequence::_update ( void  )
protected

◆ addChild() [1/3]

template<class T >
bool osg::Sequence::addChild ( const ref_ptr< T > &  child,
double  t 
)
inline

◆ addChild() [2/3]

virtual bool osg::Sequence::addChild ( Node child)
virtual

Add Node to Group. If node is not NULL then increment its reference count, add it to the child list and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. Otherwise return false. Scene nodes can't be added as child nodes.

Reimplemented from osg::Group.

◆ addChild() [3/3]

virtual bool osg::Sequence::addChild ( Node child,
double  t 
)
virtual

◆ getBegin()

int osg::Sequence::getBegin ( ) const
inline

Get interval beginning.

◆ getClearOnStop()

bool osg::Sequence::getClearOnStop ( ) const
inline

Get whether to show no child nodes after stopping

◆ getDefaultTime()

double osg::Sequence::getDefaultTime ( void  ) const
inline

Get default time in seconds for new child.

◆ getDuration()

void osg::Sequence::getDuration ( float &  speed,
int &  nreps 
) const
inline

Get duration & number of repeats.

◆ getEnd()

int osg::Sequence::getEnd ( ) const
inline

Get interval ending.

◆ getInterval()

void osg::Sequence::getInterval ( LoopMode mode,
int &  begin,
int &  end 
) const
inline

Get sequence mode & interval.

◆ getLastFrameTime()

double osg::Sequence::getLastFrameTime ( void  ) const
inline

Get last frame time in seconds

◆ getLoopMode()

LoopMode osg::Sequence::getLoopMode ( ) const
inline

Get sequence mode.

◆ getMode()

SequenceMode osg::Sequence::getMode ( ) const
inline

Get sequence mode.

◆ getNumFrames()

unsigned int osg::Sequence::getNumFrames ( ) const
inline

Get number of frames

◆ getNumRepeats()

int osg::Sequence::getNumRepeats ( ) const
inline

Get number of repeats.

◆ getSpeed()

float osg::Sequence::getSpeed ( ) const
inline

Get speed.

◆ getSync()

bool osg::Sequence::getSync ( ) const
inline

Get sync value

◆ getTime()

double osg::Sequence::getTime ( unsigned int  frame) const

Get time for child.

◆ getTimeList()

const std::vector< double > & osg::Sequence::getTimeList ( ) const
inline

Get the time list for children.

◆ getValue()

int osg::Sequence::getValue ( ) const
inline

◆ insertChild() [1/3]

template<class T >
bool osg::Sequence::insertChild ( unsigned int  index,
const ref_ptr< T > &  child,
double  t 
)
inline

◆ insertChild() [2/3]

virtual bool osg::Sequence::insertChild ( unsigned int  index,
Node child 
)
virtual

Insert Node to Group at specific location. The new child node is inserted into the child list before the node at the specified index. No nodes are removed from the group with this operation.

Reimplemented from osg::Group.

◆ insertChild() [3/3]

virtual bool osg::Sequence::insertChild ( unsigned int  index,
Node child,
double  t 
)
virtual

◆ META_Node()

osg::Sequence::META_Node ( osg  ,
Sequence   
)

◆ removeChild()

virtual bool osg::Sequence::removeChild ( Node child)
virtual

Remove Node from Group. If Node is contained in Group then remove it from the child list, decrement its reference count, and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. If Node is not found then return false and do not change the reference count of the Node. Note, do not override, only override removeChildren(,) is required.

Reimplemented from osg::Group.

◆ removeChildren()

virtual bool osg::Sequence::removeChildren ( unsigned int  pos,
unsigned int  numChildrenToRemove 
)
virtual

Remove children from Group. Note, must be override by subclasses of Group which add per child attributes.

Reimplemented from osg::Group.

◆ setBegin()

void osg::Sequence::setBegin ( int  begin)
inline

Set interval beginning.

◆ setClearOnStop()

void osg::Sequence::setClearOnStop ( bool  clearOnStop)
inline

If true, show no child nodes after stopping

◆ setDefaultTime()

void osg::Sequence::setDefaultTime ( double  t)
inline

Set default time in seconds for new child. if t<0, t=0

◆ setDuration()

void osg::Sequence::setDuration ( float  speed,
int  nreps = -1 
)

Set duration: speed-up & number of repeats

◆ setEnd()

void osg::Sequence::setEnd ( int  end)
inline

Set interval ending.

◆ setInterval()

void osg::Sequence::setInterval ( LoopMode  mode,
int  begin,
int  end 
)

Set sequence mode & interval (range of children to be displayed).

◆ setLastFrameTime()

void osg::Sequence::setLastFrameTime ( double  t)
inline

Set time of last frame of last loop, in seconds. if t<= 0, then ignored

◆ setLoopMode()

void osg::Sequence::setLoopMode ( LoopMode  mode)
inline

Set sequence mode.

◆ setMode()

void osg::Sequence::setMode ( SequenceMode  mode)

Set sequence mode. Start/stop & pause/resume.

◆ setNumRepeats()

void osg::Sequence::setNumRepeats ( int  nreps)
inline

Set number of repeats.

◆ setSpeed()

void osg::Sequence::setSpeed ( float  speed)
inline

Set speed.

◆ setSync()

void osg::Sequence::setSync ( bool  sync)
inline

If false (default), frames will not be sync'd to frameTime. If true, frames will be sync'd to frameTime.

◆ setTime()

void osg::Sequence::setTime ( unsigned int  frame,
double  t 
)

Set time in seconds for child.

◆ setTimeList()

void osg::Sequence::setTimeList ( const std::vector< double > &  timeList)
inline

Set the time list for children.

◆ setValue()

void osg::Sequence::setValue ( int  value)
inline

value is which child node is to be displayed

◆ traverse()

virtual void osg::Sequence::traverse ( NodeVisitor )
virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

Member Data Documentation

◆ _begin

int osg::Sequence::_begin
protected

◆ _clearOnStop

bool osg::Sequence::_clearOnStop
protected

◆ _defaultTime

double osg::Sequence::_defaultTime
protected

◆ _end

int osg::Sequence::_end
protected

◆ _frameTime

std::vector<double> osg::Sequence::_frameTime
protected

◆ _lastFrameTime

double osg::Sequence::_lastFrameTime
protected

◆ _loopMode

LoopMode osg::Sequence::_loopMode
protected

◆ _mode

SequenceMode osg::Sequence::_mode
protected

◆ _now

double osg::Sequence::_now
protected

◆ _nreps

int osg::Sequence::_nreps
protected

◆ _nrepsRemain

int osg::Sequence::_nrepsRemain
protected

◆ _resetTotalTime

bool osg::Sequence::_resetTotalTime
protected

◆ _saveRealLastFrameTime

double osg::Sequence::_saveRealLastFrameTime
protected

◆ _saveRealLastFrameValue

unsigned int osg::Sequence::_saveRealLastFrameValue
protected

◆ _speed

float osg::Sequence::_speed
protected

◆ _start

double osg::Sequence::_start
protected

◆ _step

int osg::Sequence::_step
protected

◆ _sync

bool osg::Sequence::_sync
protected

◆ _totalTime

double osg::Sequence::_totalTime
protected

◆ _value

int osg::Sequence::_value
protected

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