Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvInterpolatorTrail Class Reference

The HBhvInterpolatorTrail class draws a line trail from one keyframe position to the next. More...

#include <HBhvInterpolator.h>

List of all members.

Public Member Functions

virtual HBhvInterpolatorCreateInstance (HBhvAnimation *ainst)
const char * GetType ()
 HBhvInterpolatorTrail (HBhvAnimation *animation=0, const char *name=0)
void Init ()
virtual void Interpolate (int keyframe, float fraction)
virtual void Reset ()
virtual void Serialize (HUtilityXMLGenerator *xmlgen)
void SetTrailColor (const char *color)
void SetTrailStyle (const char *style)
void SetTrailType (TrailInterpolatorType tt)
void SetTrailWeight (int weight)

Static Public Member Functions

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

Protected Attributes

char m_Color [MVO_SMALL_BUFFER_SIZE]
bool m_initialized
int m_lastkeyframe
char m_Style [MVO_SMALL_BUFFER_SIZE]
HC_KEY m_trailKey
HC_KEY m_TrailSegment
TrailInterpolatorType m_TrailType
int m_Weight

Detailed Description

The HBhvInterpolatorTrail class draws a line trail from one keyframe position to the next.

HBhvInterpolatorTrail honors all modifiers from HBhvInterpolatorPosition.


Constructor & Destructor Documentation

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

Constructs an HBhvInterpolatorTrail object.

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

Member Function Documentation

virtual HBhvInterpolator* HBhvInterpolatorTrail::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.

Reimplemented from HBhvInterpolatorPosition.

const char* HBhvInterpolatorTrail::GetType ( ) [virtual]
Returns:
Type of the interpolator is 'Trail'.

Reimplemented from HBhvInterpolatorPosition.

void HBhvInterpolatorTrail::Init ( )

Sets up the Trail

virtual void HBhvInterpolatorTrail::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 HBhvInterpolatorPosition.

virtual void HBhvInterpolatorTrail::Reset ( ) [virtual]

Resets interpolator instance.

Reimplemented from HBhvInterpolatorPosition.

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

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

Reimplemented from HBhvInterpolatorPosition.

static void* HBhvInterpolatorTrail::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.

Reimplemented from HBhvInterpolatorPosition.


Member Data Documentation

char HBhvInterpolatorTrail::m_Color[MVO_SMALL_BUFFER_SIZE] [protected]

For internal use only.

char HBhvInterpolatorTrail::m_Style[MVO_SMALL_BUFFER_SIZE] [protected]

For internal use only.

For internal use only.

TrailInterpolatorType HBhvInterpolatorTrail::m_TrailType [protected]

For internal use only.

For internal use only.


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