![]() |
http://www.sim.no/ http://www.coin3d.org/ |
The SoInterpolate class is the base class for all interpolator engines.Interpolators are used to linearly interpolate between two values. More...
#include <Inventor/engines/SoInterpolate.h>
Public Member Functions | |
virtual SoType | getTypeId (void) const |
virtual const SoFieldData * | getFieldData (void) const |
virtual const SoEngineOutputData * | getOutputData (void) const |
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void | initClass (void) |
static void | initClasses (void) |
Public Attributes | |
SoSFFloat | alpha |
SoEngineOutput | output |
Protected Member Functions | |
SoInterpolate () | |
virtual | ~SoInterpolate (void) |
Static Protected Member Functions | |
static const SoFieldData ** | getInputDataPtr (void) |
static const SoEngineOutputData ** | getOutputDataPtr (void) |
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.
SoInterpolate::SoInterpolate | ( | void | ) | [protected] |
Default constructor.
SoInterpolate::~SoInterpolate | ( | void | ) | [protected, virtual] |
Destructor.
SoType SoInterpolate::getClassTypeId | ( | void | ) | [static] |
SoType SoInterpolate::getTypeId | ( | void | ) | const [virtual] |
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.
Usage example:
void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } }
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.
Implements SoBase.
const SoFieldData ** SoInterpolate::getInputDataPtr | ( | void | ) | [static, protected] |
Returns the SoFieldData class which holds information about inputs in this engine.
Reimplemented from SoEngine.
const SoEngineOutputData ** SoInterpolate::getOutputDataPtr | ( | void | ) | [static, protected] |
Returns the SoEngineOutputData class which holds information about the outputs in this engine.
Reimplemented from SoEngine.
const SoFieldData * SoInterpolate::getFieldData | ( | void | ) | const [virtual] |
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL
.
Reimplemented from SoFieldContainer.
const SoEngineOutputData * SoInterpolate::getOutputData | ( | void | ) | const [virtual] |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Implements SoEngine.
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.
void SoInterpolate::initClasses | ( | void | ) | [static] |
This method is provided only for API compatibility, and does nothing in Coin.
Reimplemented from SoEngine.
The 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.
Interpolated 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.
Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.
Generated on Thu Apr 28 2011 03:43:24 for Coin by Doxygen 1.7.4.