Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvInterpolatorVertexMorph Class Reference

The HBhvInterpolatorVertexMorph class performs interpolation by interpolating the individual vertex parameters of an object. The result of the animation is that object changes shape but retains the same set of vertices. More...

#include <HBhvInterpolator.h>

List of all members.

Public Member Functions

virtual void AddMorphData (HPoint *md, int pnum, HBaseModel *model, int pos=-1)
virtual HBhvInterpolatorCreateInstance (HBhvAnimation *ainst)
VArray< void * > GetMorphData ()
int GetMorphDataLength ()
const char * GetType ()
 HBhvInterpolatorVertexMorph (HBhvAnimation *animation=0, const char *name=0)
void Insert (char *mident, int l=0)
void InsertDiscrete (char *mident, int l=0)
virtual void Interpolate (int keyframe, float fraction)
void Replace (char *t, int l)
virtual void Serialize (HUtilityXMLGenerator *xmlgen)

Static Public Member Functions

static void * XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData)

Detailed Description

The HBhvInterpolatorVertexMorph class performs interpolation by interpolating the individual vertex parameters of an object. The result of the animation is that object changes shape but retains the same set of vertices.


Constructor & Destructor Documentation

HBhvInterpolatorVertexMorph::HBhvInterpolatorVertexMorph ( HBhvAnimation animation = 0,
const char *  name = 0 
)

Constructs an HBhvInterpolatorVertexMorph object.

Parameters:
animationThe animation that this interpolator belongs to.
nameThe name of the interpolator.

Member Function Documentation

virtual void HBhvInterpolatorVertexMorph::AddMorphData ( HPoint md,
int  pnum,
HBaseModel model,
int  pos = -1 
) [virtual]

This method adds a point array to morph data array. Use this method to morph your data so that it can be added to the keyframe array for this interpolator. Note Insert() and Replace() take the morph data in the form of its indexed position in the Morph Data array.

Parameters:
mdArray of Points
pnumNumber of points in array
modelA pointer to the base model. The Point array is stored as a shell in a special MorphData segment underneath the model segment
posOptional index into the Morph Data array which indicates where to put the point array
virtual HBhvInterpolator* HBhvInterpolatorVertexMorph::CreateInstance ( HBhvAnimation ainst) [virtual]

In special cases, you may want an interpolator that references this interpolator without changing it. Use this method to create the new interpolator passing a pointer to the animation that you want it to be associated with.

Parameters:
ainstThe animation instance that this interpolator is associated with.
Returns:
The newly created interpolator that references this interpolator.

Implements HBhvInterpolator.

VArray< void *> HBhvInterpolatorVertexMorph::GetMorphData ( ) [inline]
Returns:
A pointer to the morph data array.
int HBhvInterpolatorVertexMorph::GetMorphDataLength ( ) [inline]
Returns:
The number of entries in the morph data array.
const char* HBhvInterpolatorVertexMorph::GetType ( ) [virtual]
Returns:
The type of the interpolator 'VertexMorph'.

Implements HBhvInterpolator.

void HBhvInterpolatorVertexMorph::Insert ( char *  mident,
int  l = 0 
) [inline]

This method creates a new keyframe with the passed Morph Data position index and then inserts it after the passed position l into the keyframe array. To use this method, you must first add your vertex position information to the Morph Data using AddMorphData(). Once you have done that, note the position index that your vertex information was added to the Morph Data array. This will be the value of the parameter mident.

Parameters:
midentThe Morph Data position index to your vertex array to use for the new keyframe. Note that although the index is an int, you can use itoa() to convert the index position.
lThe array position to insert item after.

References HKeyframeString::SetTarget().

virtual void HBhvInterpolatorVertexMorph::Interpolate ( int  keyframe,
float  fraction 
) [virtual]

Performs an interpolation on the animation target.

Parameters:
keyframeThe reference keyframe for this interpolation.
fractionThe fraction value from the specified keyframe to the next keyframe. The value is from 0 to 1.

Reimplemented from HBhvInterpolator.

void HBhvInterpolatorVertexMorph::Replace ( char *  t,
int  l 
) [inline]

Replaces the item at the given position in the keyframe array with a new keyframe that was created with the passed morph identifier. To use this method, you must first add your vertex position information to the Morph Data using AddMorphData(). Once you have done that, note the position index that your vertex information was added to the Morph Data array. This will be the value of the parameter t.

Parameters:
tThe Morph Data position index to your vertex array to use for the replace keyframe. Note that although the index is an int, you can use itoa() to convert the index position.
lThe array position to replace.

References HKeyframeString::SetTarget().

virtual void HBhvInterpolatorVertexMorph::Serialize ( HUtilityXMLGenerator *  xmlgen) [virtual]

Writes XML data to a buffer using the passed XML generator.

Reimplemented from HBhvInterpolator.

static void* HBhvInterpolatorVertexMorph::XMLCallback ( HUtilityXMLTag *  xt,
bool  open,
void *  m_pExtraData 
) [static]

This is XML read callback which parses XML data and then populates the member variables with the associated values.


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