trusty (3) SoVRMLInterpolator.3.gz

NAME

       SoVRMLInterpolator -

       The SoVRMLInterpolator class is an internal abstract class.

SYNOPSIS

       #include <Inventor/VRMLnodes/SoVRMLInterpolator.h>

       Inherits SoNodeEngine.

       Inherited by SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator,
       SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, and SoVRMLScalarInterpolator.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       virtual const SoEngineOutputData * getOutputData (void) const

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoMFFloat key
       SoSFFloat set_fraction

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       int getKeyValueIndex (float &interp, int numvalues)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoVRMLInterpolator class is an internal abstract class.

       This class collects the two fields that are common for all interpolator nodes, plus common code that
       operates on these fields. Since this is an abstract 'helper' class, it does not represent an actual node
       from the VRML97 specification, so don't use it as such.

       For more information, a detailed discussion of interpolators is available in section 4.6.8 of the VRML97
       specification:

       http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8

Member Function Documentation

   SoType SoVRMLInterpolator::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.

       Reimplemented in SoVRMLPositionInterpolator, SoVRMLColorInterpolator, SoVRMLOrientationInterpolator,
       SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, and SoVRMLScalarInterpolator.

   const SoFieldData * SoVRMLInterpolator::getFieldData (void) const [protected],  [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.

       Reimplemented in SoVRMLPositionInterpolator, SoVRMLColorInterpolator, SoVRMLOrientationInterpolator,
       SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, and SoVRMLScalarInterpolator.

   const SoEngineOutputData * SoVRMLInterpolator::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 SoNodeEngine.

       Reimplemented in SoVRMLPositionInterpolator, SoVRMLColorInterpolator, SoVRMLOrientationInterpolator,
       SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, and SoVRMLScalarInterpolator.

   int SoVRMLInterpolator::getKeyValueIndex (float &interp, intnumvalues) [protected]
       This API member is considered internal to the library, as it is not likely to be of interest to the
       application programmer.

Member Data Documentation

   SoMFFloat SoVRMLInterpolator::key
       This field contains a set of floating point values which the interpolation will run over. The key values
       should be monotonically non-decreasing.

       The field is inherited from it's declaration in the abstract SoVRMLInterpolator class into a range of
       different VRML interpolator nodes.

       See the class documentation of the non-abstract VRML interpolator node you want to use for information on
       what the key values represent in that specific context.

   SoSFFloat SoVRMLInterpolator::set_fraction
       The set_fraction field gets an input signal that triggers a calculation of the next value_changed
       eventOut value.

       The field is inherited from it's declaration in the abstract SoVRMLInterpolator class into a range of
       different VRML interpolator nodes.

Author

       Generated automatically by Doxygen for Coin from the source code.