Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvInterpolatorSegSwitch Class Reference

The HBhvInterpolatorSegSwitch performs animation by switching on and off the visibility of segments. More...

#include <HBhvInterpolator.h>

Inheritance diagram for HBhvInterpolatorSegSwitch:

HBhvInterpolator

List of all members.

Public Member Functions

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

Static Public Member Functions

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


Detailed Description

The HBhvInterpolatorSegSwitch performs animation by switching on and off the visibility of segments.

Constructor & Destructor Documentation

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

Constructs an HBhvInterpolatorSegSwitch object.

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


Member Function Documentation

virtual HBhvInterpolator* HBhvInterpolatorSegSwitch::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:
ainst The animation instance that this interpolator is associated with.
Returns:
The newly created interpolator that references this interpolator.

Implements HBhvInterpolator.

const char* HBhvInterpolatorSegSwitch::GetType (  )  [virtual]

Returns:
The type of the interpolator which is 'SegSwitch'.

Implements HBhvInterpolator.

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

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

Parameters:
t Segment path to insert
l array position to insert item after

References HKeyframeString::SetTarget().

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

Performs an interpolation on the animation target.

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

Reimplemented from HBhvInterpolator.

void HBhvInterpolatorSegSwitch::Replace ( 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 segment path t.

Parameters:
spath Segment path to replace with
l array position to replace

References HKeyframeString::SetTarget().

virtual void HBhvInterpolatorSegSwitch::Reset (  )  [virtual]

Resets the interpolator instance by turning off the visibility of all segments in the keyframe list.

Reimplemented from HBhvInterpolator.

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

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

Reimplemented from HBhvInterpolator.

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