Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RtCmpKey
[Animation Tools]


Data Structures
struct   RtCompressedKeyFrame
struct   RtCompressedKeyFrameCustomData

Typedefs
typedef RpHAnimInterpFrame  RtCompressedInterpKeyFrame

Functions
RwUInt16  RtCompressedKeyFrameCompressFloat (RwReal I)
void  RtCompressedKeyFrameApply (void *matrix, void *voidIFrame)
void  RtCompressedKeyFrameInterpolate (void *voidOut, void *voidIn1, void *voidIn2, RwReal time, void *customData)
void  RtCompressedKeyFrameBlend (void *voidOut, void *voidIn1, void *voidIn2, RwReal alpha)
RtAnimAnimation *  RtCompressedKeyFrameStreamRead (RwStream *stream, RtAnimAnimation *animation)
RwBool  RtCompressedKeyFrameStreamWrite (RtAnimAnimation *animation, RwStream *stream)
RwInt32  RtCompressedKeyFrameStreamGetSize (RtAnimAnimation *animation)
void  RtCompressedKeyFrameMulRecip (void *voidFrame, void *voidStart)
void  RtCompressedKeyFrameAdd (void *voidOut, void *voidIn1, void *voidIn2)
RwBool  RtCompressedKeyFrameRegister (void)
RtAnimAnimation *  RtCompressedKeyConvertFromStdKey (RtAnimAnimation *stdkeyanim)

Detailed Description

Keyframe system supporting compressed matrix animation

RtCmpKey Overview

Requirements

Overview

This toolkits provides a set of functions and data structures for keyframe animation using compressed data. It is designed to be used with the RtAnim animation toolkit.

See also:
RpHAnim Plugin Overview , RtAnim Toolkit Overview

Typedef Documentation

typedef RpHAnimInterpFrame RtCompressedInterpKeyFrame
 

RtCompressedInterpKeyFrame typedef for RtCompressedInterpKeyFrame. Matches RpHAnimInterpFrame.

Function Documentation

RtAnimAnimation* RtCompressedKeyConvertFromStdKey (  RtAnimAnimation *    stdkeyanim ) 
 

RtCompressedKeyConvertFromStdKey converts a standard keyframe animation to a compressed keyframe animation

Parameters:
stdkeyanim  Standard keyframe animation to convert
Returns:
Compressed keyframe animation
void RtCompressedKeyFrameAdd (  void *    voidOut,
void *    voidIn1,
void *    voidIn2
) 
 

RtCompressedKeyFrameAdd adds two interpolated keyframes together.

Parameters:
voidOut  A void pointer to the output frame.
voidIn1  A void pointer to the first frame to add.
voidIn2  A void pointer to the second frame to add.
Returns:
None
void RtCompressedKeyFrameApply (  void *    matrix,
void *    voidIFrame
) 
 

RtCompressedKeyFrameApply converts a compressed interpolated keyframe to a matrix.

Parameters:
matrix  A pointer to the output matrix
voidIFrame  A pointer to the input frame
Returns:
None
void RtCompressedKeyFrameBlend (  void *    voidOut,
void *    voidIn1,
void *    voidIn2,
RwReal    alpha
) 
 

RtCompressedKeyFrameBlend blends between two RpHAnimInterpFrame objects using a given blend factor.

Parameters:
voidOut  A pointer to the output frame.
voidIn1  A pointer to the first input frame.
voidIn2  A pointer to the second input frame.
alpha  The blending factor.
Returns:
None
RwUInt16 RtCompressedKeyFrameCompressFloat (  RwReal    I ) 
 

RtCompressedKeyFrameCompressFloat converts a float into a compressed 16bit integer representation.

Parameters:
I  float to compress
Returns:
compressed value
void RtCompressedKeyFrameInterpolate (  void *    voidOut,
void *    voidIn1,
void *    voidIn2,
RwReal    time,
void *    customData
) 
 

RtCompressedKeyFrameInterpolate interpolates between two compressed keyframes and returns the result.

Parameters:
voidOut  A pointer to the output frame
voidIn1  A pointer to the first input frame
voidIn2  A pointer to the second input frame
time  The time to which to interpolate
customData  A pointer to a RtCompressedKeyFrameCustomData containing extra data for interpolating the compressed key frames.
Returns:
None
void RtCompressedKeyFrameMulRecip (  void *    voidFrame,
void *    voidStart
) 
 

RtCompressedKeyFrameMulRecip multiplies one keyframe by the reciprocal of another (in place).

Parameters:
voidFrame  A void pointer to the keyframe to modify.
voidStart  A void pointer to the start keyframe to multiply by.
Returns:
None
RwBool RtCompressedKeyFrameRegister (  void    ) 
 

RtCompressedKeyFrameRegister registers the compressed keyframe animation scheme with RtAnim.

Returns:
TRUE on success, or FALSE if an error occurs.
RwInt32 RtCompressedKeyFrameStreamGetSize (  RtAnimAnimation *    animation ) 
 

RtCompressedKeyFrameStreamGetSize calculates the size of a hierarchical compressed animations data (keyframes & custom data) when written to a stream.

Parameters:
animation  A pointer to the hierarchical animation.
Returns:
Size of the hierarchical compressed animation data in bytes.
RtAnimAnimation* RtCompressedKeyFrameStreamRead (  RwStream *    stream,
RtAnimAnimation *    animation
) 
 

RtCompressedKeyFrameStreamRead reads a hierarchical compressed animation from a stream.

Parameters:
stream  A pointer to the stream to be read from.
animation  A pointer to the animation into which to read the data
Returns:
A pointer to the animation, or NULL if an error occurs
RwBool RtCompressedKeyFrameStreamWrite (  RtAnimAnimation *    animation,
RwStream *    stream
) 
 

RtCompressedKeyFrameStreamWrite writes a hierarchical compressed animation to a stream.

Parameters:
animation  A pointer to the animation to be written.
stream  A pointer to the stream to be written to.
Returns:
TRUE on success, or FALSE if an error occurs.
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:54 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)