Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpInterpolator
[Morphing]


Data Structures
struct   RpInterpolator

Functions
RwInt32  RpInterpolatorGetStartMorphTarget (const RpInterpolator *interpolator)
RwInt32  RpInterpolatorGetEndMorphTarget (const RpInterpolator *interpolator)
RwReal  RpInterpolatorGetValue (const RpInterpolator *interpolator)
RwReal  RpInterpolatorGetScale (const RpInterpolator *interpolator)
RpInterpolator *  RpInterpolatorSetStartMorphTarget (RpInterpolator *interpolator, RwInt32 morphTarget, RpAtomic *atomic)
RpInterpolator *  RpInterpolatorSetEndMorphTarget (RpInterpolator *interpolator, RwInt32 morphTarget, RpAtomic *atomic)
RpInterpolator *  RpInterpolatorSetValue (RpInterpolator *interpolator, RwReal value, RpAtomic *atomic)
RpInterpolator *  RpInterpolatorSetScale (RpInterpolator *interpolator, RwReal scale, RpAtomic *atomic)

Detailed Description

Interpolators

RpInterpolator Overview

Requirements

Overview

An Interpolator object contains an instance of dynamic geometry data, interpolated from keyframes stored in Morph Targets. It is this data which ends up being rendered when working with keyframe-animated models.

Function Documentation

RwInt32 RpInterpolatorGetEndMorphTarget (  const RpInterpolator *    interpolator ) 
 

RpInterpolatorGetEndMorphTarget is used to retrieve the index of the end morph target for the given interpolator. The end morph target contains the geometry which will be rendered when the interpolator reaches its maximum value (equal to the interpolator's scale). By default the end morph target has index zero corresponding to the first morph target in the atomic's geometry.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
Returns:
Returns pointer to the end morph target if successful or -1 if there is an error.
See also:
RpInterpolatorSetEndMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetStartMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
RwReal RpInterpolatorGetScale (  const RpInterpolator *    interpolator ) 
 

RpInterpolatorGetScale is used to retrieve the current scale of the specified interpolator. The scale corresponds to the maximum value the interpolator can have. A new atomic has a scale of one.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
Returns:
Returns a RwReal value equal to the interpolator's scale if successful or zero if there is an error or if its value is also zero.
See also:
RpInterpolatorSetScale , RpInterpolatorSetStartMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpAtomicGetInterpolator , RpWorldPluginAttach
RwInt32 RpInterpolatorGetStartMorphTarget (  const RpInterpolator *    interpolator ) 
 

RpInterpolatorGetStartMorphTarget is used to retrieve the index of the start morph target for the given interpolator. The start morph target contains the geometry which will be rendered when the interpolator value is zero. By default the start morph target has index zero corresponding to the first morph target in the atomic's geometry.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
Returns:
Returns pointer to the start morph target if successful or -1 if there is an error.
See also:
RpInterpolatorSetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
RwReal RpInterpolatorGetValue (  const RpInterpolator *    interpolator ) 
 

RpInterpolatorGetValue is used to retrieve the current value of the specified interpolator. Valid interpolator values are in the range from zero up to the interpolator's scale. For a new atomic the value is zero.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
Returns:
Returns a RwReal value equal to the interpolator's value if successful or zero if there is an error or if its value is also zero.
See also:
RpInterpolatorSetValue , RpInterpolatorSetStartMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
RpInterpolator* RpInterpolatorSetEndMorphTarget (  RpInterpolator *    interpolator,
RwInt32    morphTarget,
RpAtomic *    atomic
) 
 

RpInterpolatorSetEndMorphTarget is used to define the index of the end morph target for the given interpolator. The end morph target contains the geometry which will be rendered when the interpolator reaches its maximum value (equal to the interpolator's scale). By default the end morph target has index zero corresponding to the first morph target in the atomic's geometry.

Calling this function will cause the owning atomic's frame to be flagged as dirty, so that it is brought up to date at the next synchronization stage (see RwFrameUpdateObjects). This is so that any changes in the atomics bounding sphere can be taken into account when calculating what sectors the atomic overlaps. This behavior can be overridden (in the case where the application can bring bounding spheres up-to-date in a more efficient manner) by setting the rpINTERPOLATORNOFRAMEDIRTY flag for the interpolator.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
morphTarget  A RwInt32 value equal to the index of the morph target (the first morph trarget has index zero).
atomic  A pointer to the atomic owning this interpolator.
Returns:
Returns pointer to the interpolator if successful or NULL if there is an error.
See also:
RpInterpolatorGetEndMorphTarget , RpInterpolatorSetStartMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
RpInterpolator* RpInterpolatorSetScale (  RpInterpolator *    interpolator,
RwReal    scale,
RpAtomic *    atomic
) 
 

RpInterpolatorSetScale is used to define the current scale for the given interpolator. The scale corresponds to the maximum value the interpolator can have. A new atomic has a scale of one.

Calling this function will cause the owning atomic's frame to be flagged as dirty, so that it is brought up to date at the next synchronization stage (see RwFrameUpdateObjects). This is so that any changes in the atomics bounding sphere can be taken into account when calculating what sectors the atomic overlaps. This behavior can be overridden (in the case where the application can bring bounding spheres up-to-date in a more efficient manner) by setting the rpINTERPOLATORNOFRAMEDIRTY flag for the interpolator.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
scale  A RwReal value equal to the interpolation scale value.
atomic  A pointer to the atomic owning this interpolator.
Returns:
Returns pointer to the interpolator if successful or NULL if there is an error.
See also:
RpInterpolatorGetScale , RpInterpolatorSetStartMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpAtomicGetInterpolator , RpWorldPluginAttach
RpInterpolator* RpInterpolatorSetStartMorphTarget (  RpInterpolator *    interpolator,
RwInt32    morphTarget,
RpAtomic *    atomic
) 
 

RpInterpolatorSetStartMorphTarget is used to define the index of the start morph target for the given interpolator. The start morph target contains the geometry which will be rendered when the interpolator value is zero. By default the start morph target has index zero corresponding to the first morph target in the atomic's geometry.

Calling this function will cause the owning atomic's frame to be flagged as dirty, so that it is brought up to date at the next synchronization stage (see RwFrameUpdateObjects). This is so that any changes in the atomics bounding sphere can be taken into account when calculating what sectors the atomic overlaps. This behavior can be overridden (in the case where the application can bring bounding spheres up-to-date in a more efficient manner) by setting the rpINTERPOLATORNOFRAMEDIRTY flag for the interpolator.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
morphTarget  A RwInt32 value equal to the index of the morph target (the first morph target has index zero).
atomic  A pointer to the atomic owning this interpolator.
Returns:
Returns pointer to the interpolator if successful or NULL if there is an error.
See also:
RpInterpolatorGetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetValue , RpInterpolatorGetValue , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
RpInterpolator* RpInterpolatorSetValue (  RpInterpolator *    interpolator,
RwReal    value,
RpAtomic *    atomic
) 
 

RpInterpolatorSetValue is used to define the current value for the given interpolator. Valid interpolator values are in the range from zero up to the interpolator's scale. For a new atomic the value is zero.

Calling this function will cause the owning atomic's frame to be flagged as dirty, so that it is brought up to date at the next synchronization stage (see RwFrameUpdateObjects). This is so that any changes in the atomics bounding sphere can be taken into account when calculating what sectors the atomic overlaps. This behavior can be overridden (in the case where the application can bring bounding spheres up-to-date in a more efficient manner) by setting the rpINTERPOLATORNOFRAMEDIRTY flag for the interpolator.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

The world plugin must be attached before using this function.

Parameters:
interpolator  Pointer to the interpolator.
value  A RwReal value equal to the interpolation value.
atomic  A pointer to the atomic owning this interpolator.
Returns:
Returns pointer to the interpolator if successful or NULL if there is an error.
See also:
RpInterpolatorGetValue , RpInterpolatorSetStartMorphTarget , RpInterpolatorGetStartMorphTarget , RpInterpolatorSetEndMorphTarget , RpInterpolatorGetEndMorphTarget , RpInterpolatorSetScale , RpInterpolatorGetScale , RpAtomicGetInterpolator , RpWorldPluginAttach
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:18 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)