SoVRMLScalarInterpolator.3coin3 man page

SoVRMLScalarInterpolator — The SoVRMLScalarInterpolator class is used to interpolate scalar values.


#include <Inventor/VRMLnodes/SoVRMLScalarInterpolator.h>

Inherits SoVRMLInterpolator.

Public Member Functions

virtual SoType getTypeId (void) const

virtual const SoEngineOutputData * getOutputData (void) const

SoVRMLScalarInterpolator (void)

Static Public Member Functions

static SoType getClassTypeId (void)

static void * createInstance (void)

static void initClass (void)

Public Attributes

SoMFFloat keyValue

SoEngineOutput value_changed

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoVRMLScalarInterpolator ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

static const SoEngineOutputData ** getOutputDataPtr (void)

Additional Inherited Members

Detailed Description

The SoVRMLScalarInterpolator class is used to interpolate scalar values.

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

This node linearly interpolates among a list of SFFloat values. This interpolator is appropriate for any parameter defined using a single floating point value. Examples include width, radius, and intensity fields. The keyValue field shall contain exactly as many numbers as there are keyframes in the key field. A more detailed discussion of interpolators is available in 4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications…).

Constructor & Destructor Documentation

SoVRMLScalarInterpolator::SoVRMLScalarInterpolator (void)


SoVRMLScalarInterpolator::~SoVRMLScalarInterpolator () [protected], [virtual]


Member Function Documentation

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

Reimplemented from SoVRMLInterpolator.

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

Member Data Documentation

SoMFFloat SoVRMLScalarInterpolator::keyValue

The keyValue vector.

SoEngineOutput SoVRMLScalarInterpolator::value_changed

The eventOut which is sent every time the interpolator has calculated a new value.


Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoVRMLScalarInterpolator.3coin2(3) is an alias of SoVRMLScalarInterpolator.3coin3(3).

Coin Version 3.1.3 Mon Sep 5 2016