OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::AnimationPath Class Reference

#include <AnimationPath.h>

Inheritance diagram for osg::AnimationPath:
Inheritance graph
[legend]
Collaboration diagram for osg::AnimationPath:
Collaboration graph
[legend]

Classes

class  ControlPoint
 

Public Types

enum  LoopMode { SWING, LOOP, NO_LOOPING }
 
typedef std::map< double,
ControlPoint
TimeControlPointMap
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 AnimationPath ()
 
 AnimationPath (const AnimationPath &ap, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Object (osg, AnimationPath)
 
bool getMatrix (double time, Matrixf &matrix) const
 
bool getMatrix (double time, Matrixd &matrix) const
 
bool getInverse (double time, Matrixf &matrix) const
 
bool getInverse (double time, Matrixd &matrix) const
 
virtual bool getInterpolatedControlPoint (double time, ControlPoint &controlPoint) const
 
void insert (double time, const ControlPoint &controlPoint)
 
double getFirstTime () const
 
double getLastTime () const
 
double getPeriod () const
 
void setLoopMode (LoopMode lm)
 
LoopMode getLoopMode () const
 
void setTimeControlPointMap (TimeControlPointMap &tcpm)
 
TimeControlPointMapgetTimeControlPointMap ()
 
const TimeControlPointMapgetTimeControlPointMap () const
 
bool empty () const
 
void clear ()
 
void read (std::istream &in)
 
void write (std::ostream &out) const
 
void write (TimeControlPointMap::const_iterator itr, std::ostream &out) 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
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () 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::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
 
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 ~AnimationPath ()
 
- 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

TimeControlPointMap _timeControlPointMap
 
LoopMode _loopMode
 
- 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 setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

AnimationPath encapsulates a time varying transformation pathway. Can be used for updating camera position and model object position. AnimationPathCallback can be attached directly to Transform nodes to move subgraphs around the scene.

Definition at line 33 of file AnimationPath.h.

Member Typedef Documentation

Definition at line 186 of file AnimationPath.h.

Member Enumeration Documentation

Enumerator
SWING 
LOOP 
NO_LOOPING 

Definition at line 174 of file AnimationPath.h.

Constructor & Destructor Documentation

osg::AnimationPath::AnimationPath ( )
inline

Definition at line 37 of file AnimationPath.h.

osg::AnimationPath::AnimationPath ( const AnimationPath ap,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Definition at line 39 of file AnimationPath.h.

virtual osg::AnimationPath::~AnimationPath ( )
inlineprotectedvirtual

Definition at line 209 of file AnimationPath.h.

Member Function Documentation

void osg::AnimationPath::clear ( )
inline

Definition at line 196 of file AnimationPath.h.

bool osg::AnimationPath::empty ( ) const
inline

Definition at line 194 of file AnimationPath.h.

double osg::AnimationPath::getFirstTime ( ) const
inline

Definition at line 170 of file AnimationPath.h.

virtual bool osg::AnimationPath::getInterpolatedControlPoint ( double  time,
ControlPoint controlPoint 
) const
virtual

Given a specific time, return the local ControlPoint frame for a point.

bool osg::AnimationPath::getInverse ( double  time,
Matrixf matrix 
) const
inline

Given a specific time, return the inverse transformation matrix for a point.

Definition at line 148 of file AnimationPath.h.

Here is the call graph for this function:

bool osg::AnimationPath::getInverse ( double  time,
Matrixd matrix 
) const
inline

Definition at line 156 of file AnimationPath.h.

Here is the call graph for this function:

double osg::AnimationPath::getLastTime ( ) const
inline

Definition at line 171 of file AnimationPath.h.

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

Definition at line 183 of file AnimationPath.h.

bool osg::AnimationPath::getMatrix ( double  time,
Matrixf matrix 
) const
inline

Given a specific time, return the transformation matrix for a point.

Definition at line 130 of file AnimationPath.h.

Here is the call graph for this function:

bool osg::AnimationPath::getMatrix ( double  time,
Matrixd matrix 
) const
inline

Given a specific time, return the transformation matrix for a point.

Definition at line 139 of file AnimationPath.h.

Here is the call graph for this function:

double osg::AnimationPath::getPeriod ( ) const
inline

Definition at line 172 of file AnimationPath.h.

TimeControlPointMap& osg::AnimationPath::getTimeControlPointMap ( )
inline

Definition at line 190 of file AnimationPath.h.

const TimeControlPointMap& osg::AnimationPath::getTimeControlPointMap ( ) const
inline

Definition at line 192 of file AnimationPath.h.

void osg::AnimationPath::insert ( double  time,
const ControlPoint controlPoint 
)

Insert a control point into the AnimationPath.

osg::AnimationPath::META_Object ( osg  ,
AnimationPath   
)
void osg::AnimationPath::read ( std::istream &  in)

Read the animation path from a flat ASCII file stream.

void osg::AnimationPath::setLoopMode ( LoopMode  lm)
inline

Definition at line 181 of file AnimationPath.h.

void osg::AnimationPath::setTimeControlPointMap ( TimeControlPointMap tcpm)
inline

Definition at line 188 of file AnimationPath.h.

void osg::AnimationPath::write ( std::ostream &  out) const

Write the animation path to a flat ASCII file stream.

void osg::AnimationPath::write ( TimeControlPointMap::const_iterator  itr,
std::ostream &  out 
) const

Write the control point to a flat ASCII file stream.

Member Data Documentation

LoopMode osg::AnimationPath::_loopMode
protected

Definition at line 212 of file AnimationPath.h.

TimeControlPointMap osg::AnimationPath::_timeControlPointMap
protected

Definition at line 211 of file AnimationPath.h.


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