openscenegraph
Public Member Functions | Protected Member Functions | List of all members
osgParticle::Interpolator Class Reference

An abstract base class for implementing interpolators. More...

Inheritance diagram for osgParticle::Interpolator:
osg::Object osg::Referenced osgParticle::LinearInterpolator

Public Member Functions

 Interpolator ()
 Interpolator (const Interpolator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual const char * libraryName () const
virtual const char * className () const
virtual bool isSameKindAs (const osg::Object *obj) const
virtual float interpolate (float t, float y1, float y2) const =0
 Interpolate between floats. Must be overriden in descendant classes.
virtual osg::Vec2 interpolate (float t, const osg::Vec2 &y1, const osg::Vec2 &y2) const
 Interpolate between 2-dimensional vectors. Default behavior is to interpolate each component separately.
virtual osg::Vec3 interpolate (float t, const osg::Vec3 &y1, const osg::Vec3 &y2) const
 Interpolate between 3-dimensional vectors. Default behavior is to interpolate each component separately.
virtual osg::Vec4 interpolate (float t, const osg::Vec4 &y1, const osg::Vec4 &y2) const
 Interpolate between 4-dimensional vectors. Default behavior is to interpolate each component separately.
template<class ValueType >
ValueType interpolate (float t, const range< ValueType > &r) 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 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 Member Functions

virtual ~Interpolator ()
- 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

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 Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer

Detailed Description

An abstract base class for implementing interpolators.

Constructor & Destructor Documentation

osgParticle::Interpolator::Interpolator ( )
inline
osgParticle::Interpolator::Interpolator ( const Interpolator copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
inline
virtual osgParticle::Interpolator::~Interpolator ( )
inlineprotectedvirtual

Member Function Documentation

virtual const char* osgParticle::Interpolator::className ( ) const
inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Implements osg::Object.

virtual float osgParticle::Interpolator::interpolate ( float  t,
float  y1,
float  y2 
) const
pure virtual

Interpolate between floats. Must be overriden in descendant classes.

Implemented in osgParticle::LinearInterpolator.

Referenced by interpolate().

virtual osg::Vec2 osgParticle::Interpolator::interpolate ( float  t,
const osg::Vec2 y1,
const osg::Vec2 y2 
) const
inlinevirtual

Interpolate between 2-dimensional vectors. Default behavior is to interpolate each component separately.

References interpolate(), osg::Vec2f::x(), and osg::Vec2f::y().

virtual osg::Vec3 osgParticle::Interpolator::interpolate ( float  t,
const osg::Vec3 y1,
const osg::Vec3 y2 
) const
inlinevirtual

Interpolate between 3-dimensional vectors. Default behavior is to interpolate each component separately.

References interpolate(), osg::Vec3f::x(), osg::Vec3f::y(), and osg::Vec3f::z().

virtual osg::Vec4 osgParticle::Interpolator::interpolate ( float  t,
const osg::Vec4 y1,
const osg::Vec4 y2 
) const
inlinevirtual

Interpolate between 4-dimensional vectors. Default behavior is to interpolate each component separately.

References interpolate(), osg::Vec4f::w(), osg::Vec4f::x(), osg::Vec4f::y(), and osg::Vec4f::z().

template<class ValueType >
ValueType osgParticle::Interpolator::interpolate ( float  t,
const range< ValueType > &  r 
) const
inline
virtual bool osgParticle::Interpolator::isSameKindAs ( const osg::Object obj) const
inlinevirtual

Reimplemented from osg::Object.

virtual const char* osgParticle::Interpolator::libraryName ( ) const
inlinevirtual

return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.


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