Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvInterpolatorColor Class Reference

The HBhvInterpolatorColor class controls color attribute changes. More...

#include <HBhvInterpolator.h>

Inheritance diagram for HBhvInterpolatorColor:

HBhvInterpolator

List of all members.

Public Member Functions

virtual HBhvInterpolatorCreateInstance (HBhvAnimation *ainst)
char * GetColorComponent ()
char * GetGeomType ()
const char * GetType ()
 HBhvInterpolatorColor (HBhvAnimation *animation=0, const char *name=0)
void Insert (HPoint pos, int l=0)
virtual void Interpolate (int keyframe, float fraction)
void Replace (HPoint pos, int l)
virtual void Serialize (HUtilityXMLGenerator *xmlgen)
void SetColorComponent (const char *ColorComponent)
void SetGeomType (const char *geomtype)

Static Public Member Functions

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

Protected Attributes

char m_ColorComponent [MVO_BUFFER_SIZE]
char m_GeomType [MVO_BUFFER_SIZE]


Detailed Description

The HBhvInterpolatorColor class controls color attribute changes.

Constructor & Destructor Documentation

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

Constructs an HBhvInterpolatorColor object.

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


Member Function Documentation

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

char* HBhvInterpolatorColor::GetColorComponent (  )  [inline]

Returns:
The color components that color changes are applied.

char* HBhvInterpolatorColor::GetGeomType (  )  [inline]

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

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

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

Implements HBhvInterpolator.

void HBhvInterpolatorColor::Insert ( HPoint  pos,
int  l = 0 
) [inline]

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

References HKeyframeChannel::m_cp.

virtual void HBhvInterpolatorColor::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 HBhvInterpolatorColor::Replace ( HPoint  pos,
int  l 
) [inline]

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

References HKeyframeChannel::m_cp.

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

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

Reimplemented from HBhvInterpolator.

void HBhvInterpolatorColor::SetColorComponent ( const char *  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.

void HBhvInterpolatorColor::SetGeomType ( const char *  geomtype  ) 

Sets the geometry type that color changes applies to like faces, lines, etc...

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


Member Data Documentation

char HBhvInterpolatorColor::m_ColorComponent[MVO_BUFFER_SIZE] [protected]

For internal use only.

char HBhvInterpolatorColor::m_GeomType[MVO_BUFFER_SIZE] [protected]

For internal use only.


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