SoInterpolate.3coin2

Langue: en

Version: 376515 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

SoInterpolate -

The SoInterpolate class is the base class for all interpolator engines.

Interpolators are used to linearly interpolate between two values.

SYNOPSIS


#include <Inventor/engines/SoInterpolate.h>

Inherits SoEngine.

Inherited by SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

Static Public Member Functions


static void initClass (void)

static void initClasses (void)

Public Attributes


SoSFFloat alpha

SoEngineOutput output

Protected Member Functions


SoInterpolate ()

virtual ~SoInterpolate ()

Detailed Description

The SoInterpolate class is the base class for all interpolator engines.

Interpolators are used to linearly interpolate between two values.

In Coin, we've chosen to implement all interpolators in separate files. If you want to be OIV compatible when programming, you should include the SoInterpolate.h, and not the interpolator file(s) you need.

Constructor & Destructor Documentation

SoInterpolate::SoInterpolate (void) [protected]Default constructor.

References alpha, and SoType::badType().

SoInterpolate::~SoInterpolate () [protected, virtual]Destructor.

References SoDebugError::postInfo().

Member Function Documentation

void SoInterpolate::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoEngine.

Reimplemented in SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

void SoInterpolate::initClasses (void) [static]This method is provided only for API compatibility, and does nothing in Coin.

Reimplemented from SoEngine.

Member Data Documentation

SoSFFloat SoInterpolate::alphaThe value which says how much we've should interpolate from first value to second value. A value equal to 0 will give an output equal to the first value, alpha equal to 1 gives the second value, any value in between gives a 'weighted' interpolation between the two values.

Referenced by SoInterpolate(), SoPendulum::SoPendulum(), and SoShuttle::SoShuttle().

SoEngineOutput SoInterpolate::outputInterpolated values from the input fields. The type of the output will of course be the same as the type of the input fields of each non-abstract subclass inheriting SoInterpolate.

Referenced by SoPendulum::SoPendulum(), and SoShuttle::SoShuttle().

Author

Generated automatically by Doxygen for Coin from the source code.