Coin Logo http://www.sim.no
http://www.coin3d.org

SoVRMLCoordinateInterpolator Class Reference
[VRML97 classes]

The SoVRMLCoordinateInterpolator class is used to interpolate 3D coordinates.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:. More...

#include <Inventor/VRMLnodes/SoVRMLCoorinateInterpolator.h>

Inheritance diagram for SoVRMLCoordinateInterpolator:

SoVRMLInterpolator SoNodeEngine SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoEngineOutputData * getOutputData (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)

Public Attributes

SoMFVec3f keyValue
SoEngineOutput value_changed

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)


Detailed Description

The SoVRMLCoordinateInterpolator class is used to interpolate 3D coordinates.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:.

  CoordinateInterpolator {
    eventIn      SFFloat set_fraction        # (-inf, inf)
    exposedField MFFloat key           []    # (-inf, inf)
    exposedField MFVec3f keyValue      []    # (-inf, inf)
    eventOut     MFVec3f value_changed
  }
  

This node linearly interpolates among a list of MFVec3f values. The number of coordinates in the keyValue field shall be an integer multiple of the number of keyframes in the key field. That integer multiple defines how many coordinates will be contained in the value_changed events. 4.6.8, Interpolator nodes (<http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8>), contains a more detailed discussion of interpolators.


Member Function Documentation

SoType SoVRMLCoordinateInterpolator::getClassTypeId ( void   )  [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoVRMLInterpolator.

SoType SoVRMLCoordinateInterpolator::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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.

Reimplemented from SoVRMLInterpolator.

const SoFieldData ** SoVRMLCoordinateInterpolator::getFieldDataPtr ( void   )  [static, protected]

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoVRMLInterpolator.

const SoFieldData * SoVRMLCoordinateInterpolator::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 SoVRMLInterpolator.

const SoEngineOutputData ** SoVRMLCoordinateInterpolator::getOutputDataPtr ( void   )  [static, protected]

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoVRMLInterpolator.

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

Reimplemented from SoVRMLInterpolator.

void SoVRMLCoordinateInterpolator::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 SoVRMLInterpolator.


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:06 2009 for Coin by Doxygen. 1.5.8