osg::AnimationPath Class Reference

AnimationPath encapsulates a time varying transformation pathway. More...

Inheritance diagram for osg::AnimationPath:

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
	Given a specific time, return the transformation matrix for a point. More...
bool	getMatrix (double time, Matrixd &matrix) const
	Given a specific time, return the transformation matrix for a point. More...
bool	getInverse (double time, Matrixf &matrix) const
	Given a specific time, return the inverse transformation matrix for a point. More...
bool	getInverse (double time, Matrixd &matrix) const
virtual bool	getInterpolatedControlPoint (double time, ControlPoint &controlPoint) const
	Given a specific time, return the local ControlPoint frame for a point. More...
void	insert (double time, const ControlPoint &controlPoint)
	Insert a control point into the AnimationPath. More...
double	getFirstTime () const
double	getLastTime () const
double	getPeriod () const
void	setLoopMode (LoopMode lm)
LoopMode	getLoopMode () const
void	setTimeControlPointMap (TimeControlPointMap &tcpm)
TimeControlPointMap &	getTimeControlPointMap ()
const TimeControlPointMap &	getTimeControlPointMap () const
bool	empty () const
void	clear ()
void	read (std::istream &in)
	Read the animation path from a flat ASCII file stream. More...
void	write (std::ostream &out) const
	Write the animation path to a flat ASCII file stream. More...
void	write (TimeControlPointMap::const_iterator itr, std::ostream &out) const
	Write the control point to a flat ASCII file stream. More...
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library. More...
virtual const char *	className () const =0
	return the name of the object's class type. More...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...
void	setName (const char *name)
	Set the name of object using a C style string. More...
const std::string &	getName () const
	Get the name of object. More...
void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...
DataVariance	getDataVariance () const
	Get the data variance of this object. More...
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
template<class T >
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () const
	Get const user data. More...
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Member Functions
virtual	~AnimationPath ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...
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::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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.

Member Typedef Documentation

typedef std::map<double,ControlPoint> osg::AnimationPath::TimeControlPointMap

Member Enumeration Documentation

enum osg::AnimationPath::LoopMode

Enumerator
SWING
LOOP
NO_LOOPING

Constructor & Destructor Documentation

osg::AnimationPath::AnimationPath ( )

inline

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

inline

virtual osg::AnimationPath::~AnimationPath ( )

inlineprotectedvirtual

Member Function Documentation

void osg::AnimationPath::clear ( )

inline

bool osg::AnimationPath::empty ( ) const

inline

double osg::AnimationPath::getFirstTime ( ) const

inline

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.

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

inline

double osg::AnimationPath::getLastTime ( ) const

inline

LoopMode osg::AnimationPath::getLoopMode ( ) const

inline

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

inline

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

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

inline

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

double osg::AnimationPath::getPeriod ( ) const

inline

TimeControlPointMap& osg::AnimationPath::getTimeControlPointMap ( )

inline

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

inline

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

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

inline

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

TimeControlPointMap osg::AnimationPath::_timeControlPointMap

protected

---

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

• osg/AnimationPath