newspeoplefor developersdocumentationdownloads

nUvAnimator Class Reference
[Scene System]

#include <nuvanimator.h>

Inheritance diagram for nUvAnimator:

nAnimator nSceneNode nRoot nObject nNode nReferenced nSignalEmitter List of all members.

Detailed Description

Animates the UV transform parameters on an nAbstractShaderNode.

See also nUvAnimator Script Interface

-01-Nov-06 kims Changed vector2 to vector3 type on AddEulerKey() and GetEulerKeyAt() functions. The changes were done for uv animation.

(C) 2004 RadonLabs GmbH

Definition at line 22 of file nuvanimator.h.


Public Member Functions

 nUvAnimator ()
 constructor
virtual ~nUvAnimator ()
 destructor
virtual bool SaveCmds (nPersistServer *ps)
 save object to persistent stream
virtual Type GetAnimatorType () const
 return the type of this animator object (SHADER)
virtual void Animate (nSceneNode *sceneNode, nRenderContext *renderContext)
 called by scene node objects which wish to be animated by this object
void AddPosKey (uint texLayer, float time, const vector2 &key)
 add a position key
void AddEulerKey (uint texLayer, float time, const vector3 &key)
 add a euler angle key
void AddScaleKey (uint texLayer, float time, const vector2 &key)
 add a scale key
int GetNumPosKeys (uint texLayer) const
 get number of position keys
void GetPosKeyAt (uint texLayer, uint keyIndex, float &time, vector2 &key) const
 get position key at index
int GetNumEulerKeys (uint texLayer) const
 get number of euler angle keys
void GetEulerKeyAt (uint texLayer, uint keyIndex, float &time, vector3 &key) const
 get euler key at index
int GetNumScaleKeys (uint texLayer) const
 get number of scale keys
void GetScaleKeyAt (uint texLayer, uint keyIndex, float &time, vector2 &key) const
 get scale key at index

Constructor & Destructor Documentation

nUvAnimator::nUvAnimator  ) 
 

constructor

Definition at line 14 of file nuvanimator_main.cc.

nUvAnimator::~nUvAnimator  )  [virtual]
 

destructor

Definition at line 22 of file nuvanimator_main.cc.


Member Function Documentation

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

save object to persistent stream

Reimplemented from nAnimator.

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

return the type of this animator object (SHADER)

Reimplemented from nAnimator.

Definition at line 31 of file nuvanimator_main.cc.

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

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

This does the actual work of manipulate the target object.

Parameters:
sceneNode object to manipulate (must be of class nTransformNode)
renderContext current render context
-01-Nov-06 kims Updated to be enable to animate texture uvs. Thank ZHANG Zikai for the patch.

Reimplemented from nAnimator.

Definition at line 47 of file nuvanimator_main.cc.

void nUvAnimator::AddPosKey uint  texLayer,
float  time,
const vector2 key
[inline]
 

add a position key

Definition at line 66 of file nuvanimator.h.

void nUvAnimator::AddEulerKey uint  texLayer,
float  time,
const vector3 key
[inline]
 

add a euler angle key

-01-Nov-06 kims Changed to have vector3 in-arg for uv animation.

Definition at line 79 of file nuvanimator.h.

void nUvAnimator::AddScaleKey uint  texLayer,
float  time,
const vector2 key
[inline]
 

add a scale key

Definition at line 91 of file nuvanimator.h.

int nUvAnimator::GetNumPosKeys uint  texLayer  )  const [inline]
 

get number of position keys

Definition at line 103 of file nuvanimator.h.

void nUvAnimator::GetPosKeyAt uint  texLayer,
uint  keyIndex,
float &  time,
vector2 key
const [inline]
 

get position key at index

Obtain a position key by its index.

Parameters:
texLayer [in] texture layer index
keyIndex [in] index of key to get
time [out] the time stamp of the key
key [out] the value of the key

Definition at line 142 of file nuvanimator.h.

int nUvAnimator::GetNumEulerKeys uint  texLayer  )  const [inline]
 

get number of euler angle keys

Definition at line 114 of file nuvanimator.h.

void nUvAnimator::GetEulerKeyAt uint  texLayer,
uint  keyIndex,
float &  time,
vector3 key
const [inline]
 

get euler key at index

Obtain a euler key by its index.

-01-Nov-06 kims Changed to have vector3 in-arg for uv animation.

Parameters:
texLayer [in] texture layer index
keyIndex [in] index of key to get
time [out] the time stamp of the key
key [out] the value of the key

Definition at line 163 of file nuvanimator.h.

int nUvAnimator::GetNumScaleKeys uint  texLayer  )  const [inline]
 

get number of scale keys

Definition at line 125 of file nuvanimator.h.

void nUvAnimator::GetScaleKeyAt uint  texLayer,
uint  keyIndex,
float &  time,
vector2 key
const [inline]
 

get scale key at index

Obtain a scale key by its index.

Parameters:
texLayer [in] texture layer index
keyIndex [in] index of key to get
time [out] the time stamp of the key
key [out] the value of the key

Definition at line 182 of file nuvanimator.h.


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

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