Irrlicht 3D Engine
irr::scene::ISceneNodeAnimator Class Referenceabstract

Animates a scene node. Can animate position, rotation, material, and so on. More...

#include <ISceneNodeAnimator.h>

+ Inheritance diagram for irr::scene::ISceneNodeAnimator:

Public Member Functions

virtual void animateNode (ISceneNode *node, u32 timeMs)=0
 Animates a scene node. More...
 
virtual ISceneNodeAnimatorcreateClone (ISceneNode *node, ISceneManager *newManager=0)=0
 Creates a clone of this animator. More...
 
virtual ESCENE_NODE_ANIMATOR_TYPE getType () const
 Returns type of the scene node animator. More...
 
virtual bool hasFinished (void) const
 Returns if the animator has finished. More...
 
virtual bool isEventReceiverEnabled () const
 Returns true if this animator receives events. More...
 
virtual bool OnEvent (const SEvent &event)
 Event receiver, override this function for camera controlling animators. More...
 
- Public Member Functions inherited from irr::io::IAttributeExchangingObject
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
 Reads attributes of the object. More...
 
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
 Writes attributes of the object. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
- Public Member Functions inherited from irr::IEventReceiver
virtual ~IEventReceiver ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Animates a scene node. Can animate position, rotation, material, and so on.

A scene node animator is able to animate a scene node in a very simple way. It may change its position, rotation, scale and/or material. There are lots of animators to choose from. You can create scene node animators with the ISceneManager interface.

Definition at line 30 of file ISceneNodeAnimator.h.

Member Function Documentation

§ animateNode()

virtual void irr::scene::ISceneNodeAnimator::animateNode ( ISceneNode node,
u32  timeMs 
)
pure virtual

Animates a scene node.

Parameters
nodeNode to animate.
timeMsCurrent time in milli seconds.

Referenced by irr::scene::ISceneNode::OnAnimate().

§ createClone()

virtual ISceneNodeAnimator* irr::scene::ISceneNodeAnimator::createClone ( ISceneNode node,
ISceneManager newManager = 0 
)
pure virtual

Creates a clone of this animator.

Please note that you will have to drop (IReferenceCounted::drop()) the returned pointer after calling this.

Referenced by irr::scene::ISceneNode::cloneMembers().

§ getType()

virtual ESCENE_NODE_ANIMATOR_TYPE irr::scene::ISceneNodeAnimator::getType ( ) const
inlinevirtual

Returns type of the scene node animator.

Definition at line 59 of file ISceneNodeAnimator.h.

References irr::scene::ESNAT_UNKNOWN.

§ hasFinished()

virtual bool irr::scene::ISceneNodeAnimator::hasFinished ( void  ) const
inlinevirtual

Returns if the animator has finished.

This is only valid for non-looping animators with a discrete end state.

Returns
true if the animator has finished, false if it is still running.

Definition at line 67 of file ISceneNodeAnimator.h.

§ isEventReceiverEnabled()

virtual bool irr::scene::ISceneNodeAnimator::isEventReceiverEnabled ( ) const
inlinevirtual

Returns true if this animator receives events.

When attached to an active camera, this animator will be able to respond to events such as mouse and keyboard events.

Definition at line 47 of file ISceneNodeAnimator.h.

§ OnEvent()

virtual bool irr::scene::ISceneNodeAnimator::OnEvent ( const SEvent event)
inlinevirtual

Event receiver, override this function for camera controlling animators.

Implements irr::IEventReceiver.

Definition at line 53 of file ISceneNodeAnimator.h.


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