HBhvInterpolatorColor

Functions

	`HBhvInterpolatorColor`
char const *	`GetType`
HBhvInterpolator *	`CreateInstance`
void	`Insert`
void	`Replace`
void	`Serialize`
void	`SetGeomType`
char *	`GetGeomType`
void	`SetColorComponent`
char *	`GetColorComponent`
void	`Interpolate`
void *	`XMLCallback`

Detailed Description

class HBhvInterpolatorColor : public HBhvInterpolator 

The HBhvInterpolatorColor class controls color attribute changes.

Public Functions

HBhvInterpolatorColor(HBhvAnimation *animation = 0, char const *name = 0)

Constructs an HBhvInterpolatorColor object.

Parameters

animation – The animation that this interpolator belongs to.
name – The name of the interpolator.

virtual char const *GetType()

Returns: The type of the interpolator which is ‘Color’.

virtual HBhvInterpolator *CreateInstance(HBhvAnimation *ainst)

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.

inline void Insert(HPoint pos, int l = 0)

This method creates a new keyframe with the passed color value and then inserts it after the given position l in the keyframe array.

Parameters

pos – The color value you want to set for the new keyframe. Pass r,g, and b values in the x,y and z parameters respectively in HPoint.
l – array position to insert item after

inline void Replace(HPoint pos, int l)

Replaces the item at the given position in the keyframe array with a new keyframe that was created with the passed color value.

Parameters

pos – The color value for the replacement keyframe. Pass r,g, and b values in the x,y and z parameters respectively in HPoint.
l – array position to replace

virtual void Serialize(HUtilityXMLGenerator *xmlgen): Writes XML data to a buffer using the passed XML generator.

void SetGeomType(char const *geomtype): Sets the geometry type that color changes applies to like faces, lines, etc…

inline char *GetGeomType()

Returns: The geometry type that color changes apply to like faces, lines, etc…

void SetColorComponent(char const *ColorComponent)

Sets color components attributes like diffuse, specular and gloss that color changes will be applied to.

Parameters: ColorComponent – The color options that can be set in HC_Set_Color for faces.

inline char *GetColorComponent()

Returns: The color components that are applied.

virtual void Interpolate(int keyframe, float fraction)

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.

Public Static Functions

static void *XMLCallback(HUtilityXMLTag *xt, bool open, void *m_pExtraData): This is XML read callback which parses XML data and then populates the member variables with the associated values.