Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvInterpolatorAttSwitch Class Reference

The HBhvInterpolatorAttSwitch class switches attributes on segments. More...

#include <HBhvInterpolator.h>

List of all members.

Public Member Functions

virtual HBhvInterpolatorCreateInstance (HBhvAnimation *ainst)
const char * GetType ()
 HBhvInterpolatorAttSwitch (HBhvAnimation *animation=0, const char *name=0)
void Insert (const char *t, int l=0)
virtual void Interpolate (int keyframe, float fraction)
void Replace (const char *spath, int l)
virtual void Serialize (HUtilityXMLGenerator *xmlgen)

Static Public Member Functions

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

Detailed Description

The HBhvInterpolatorAttSwitch class switches attributes on segments.

HBhvInterpolatorAttSwitch uses HC_Style_Segment() to change the attribute on the segments specified in the keyframe list.


Constructor & Destructor Documentation

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

Constructs an HBhvInterpolatorAttSwitch object.

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

Member Function Documentation

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

const char* HBhvInterpolatorAttSwitch::GetType ( ) [virtual]
Returns:
The type of the interpolator which is 'AttSwitch'.

Implements HBhvInterpolator.

void HBhvInterpolatorAttSwitch::Insert ( const char *  t,
int  l = 0 
) [inline]

This method creates a new keyframe with the passed style segment path t and then inserts it after the passed position l into the keyframe array.

Parameters:
tThe style segment path for the new keyframe.
lThe array position to insert item after.

References HKeyframeString::SetTarget().

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

Performs 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 HBhvInterpolatorAttSwitch::Replace ( const char *  spath,
int  l 
) [inline]

Replaces the item at the given position in the keyframe array with a new keyframe that was created with the passed style segment path spath.

Parameters:
spathThe style segment path for the new replacement keyframe.
lThe array position to replace.

References HKeyframeString::SetTarget().

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

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

Reimplemented from HBhvInterpolator.

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