newspeoplefor developersdocumentationdownloads

nAnimator Class Reference
[Scene System]

#include <nanimator.h>

Inheritance diagram for nAnimator:

nSceneNode nRoot nObject nNode nReferenced nSignalEmitter nBlendShapeAnimator nShaderAnimator nSkinAnimator nTextureAnimator nTransformAnimator nTransformCurveAnimator nUvAnimator nFloatAnimator nIntAnimator nVectorAnimator nCharacter3SkinAnimator List of all members.

Detailed Description

Animator nodes manipulate properties of other scene objects.

They are not attached to the scene, instead they are called back by scene objects which wish to be manipulated.

See also nAnimator Script Interface

(C) 2003 RadonLabs GmbH

Definition at line 25 of file nanimator.h.


Public Types

enum  Type {
  InvalidType,
  Transform,
  Shader,
  BlendShape
}

Public Member Functions

 nAnimator ()
 constructor
virtual ~nAnimator ()
 destructor
virtual bool SaveCmds (nPersistServer *ps)
 save object to persistent stream
virtual Type GetAnimatorType () const
 return the type of this animator object
virtual void Animate (nSceneNode *sceneNode, nRenderContext *renderContext)
 called by scene node objects which wish to be animated by this object
void SetChannel (const char *name)
 set the variable handle which drives this animator object (e.g. time)
const char * GetChannel ()
 get the variable which drives this animator object
void SetLoopType (nAnimLoopType::Type t)
 set the loop type
nAnimLoopType::Type GetLoopType () const
 get the loop type

Protected Attributes

nAnimLoopType::Type loopType
nVariable::Handle channelVarHandle
nVariable::Handle channelOffsetVarHandle

Member Enumeration Documentation

enum nAnimator::Type
 

Enumerator:
InvalidType 
Transform 
Shader 
BlendShape 

Definition at line 28 of file nanimator.h.


Constructor & Destructor Documentation

nAnimator::nAnimator  ) 
 

constructor

Definition at line 13 of file nanimator_main.cc.

nAnimator::~nAnimator  )  [virtual]
 

destructor

Definition at line 23 of file nanimator_main.cc.


Member Function Documentation

virtual bool nAnimator::SaveCmds nPersistServer ps  )  [virtual]
 

save object to persistent stream

Reimplemented from nSceneNode.

Reimplemented in nBlendShapeAnimator, nFloatAnimator, nIntAnimator, nShaderAnimator, nSkinAnimator, nTextureAnimator, nTransformAnimator, nTransformCurveAnimator, nUvAnimator, and nVectorAnimator.

nAnimator::Type nAnimator::GetAnimatorType  )  const [virtual]
 

return the type of this animator object

Returns the type of the animator object. Subclasses should return something meaningful here.

Reimplemented in nBlendShapeAnimator, nShaderAnimator, nTextureAnimator, nTransformAnimator, nTransformCurveAnimator, and nUvAnimator.

Definition at line 34 of file nanimator_main.cc.

void nAnimator::Animate nSceneNode sceneNode,
nRenderContext renderContext
[virtual]
 

called by scene node objects which wish to be animated by this object

This method is called back by scene node objects which wish to be animated.

Reimplemented in nBlendShapeAnimator, nCharacter3SkinAnimator, nFloatAnimator, nIntAnimator, nSkinAnimator, nTextureAnimator, nTransformAnimator, nTransformCurveAnimator, nUvAnimator, and nVectorAnimator.

Definition at line 45 of file nanimator_main.cc.

void nAnimator::SetChannel const char *  name  ) 
 

set the variable handle which drives this animator object (e.g. time)

Sets the "animation channel" which drives this animation. This could be something like "time", but the actual names are totally up to the application. The actual channel value will be pulled from the render context provided in the Animate() method.

Definition at line 58 of file nanimator_main.cc.

const char * nAnimator::GetChannel  ) 
 

get the variable which drives this animator object

Return the animation channel which drives this animation.

Definition at line 70 of file nanimator_main.cc.

void nAnimator::SetLoopType nAnimLoopType::Type  t  )  [inline]
 

set the loop type

Set the loop type for this animation.

Definition at line 67 of file nanimator.h.

nAnimLoopType::Type nAnimator::GetLoopType  )  const [inline]
 

get the loop type

Get the loop type for this animation.

Definition at line 78 of file nanimator.h.


Member Data Documentation

nAnimLoopType::Type nAnimator::loopType [protected]
 

Definition at line 56 of file nanimator.h.

nVariable::Handle nAnimator::channelVarHandle [protected]
 

Definition at line 57 of file nanimator.h.

nVariable::Handle nAnimator::channelOffsetVarHandle [protected]
 

Definition at line 58 of file nanimator.h.


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

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.