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

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions
SoVRMLScalarInterpolator Class Reference

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

#include <Inventor/VRMLnodes/SoVRMLScalarInterpolator.h>

Inheritance diagram for SoVRMLScalarInterpolator:
SoVRMLInterpolator SoNodeEngine SoNode SoFieldContainer SoBase

List of all members.

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
- Public Attributes inherited from SoVRMLInterpolator
SoMFFloat key
SoSFFloat set_fraction

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoVRMLScalarInterpolator ()
- Protected Member Functions inherited from SoVRMLInterpolator
int getKeyValueIndex (float &interp)
- Protected Member Functions inherited from SoNodeEngine
 SoNodeEngine (void)
virtual ~SoNodeEngine ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void inputChanged (SoField *which)
void writeOutputTypes (SoOutput *out)
- Protected Member Functions inherited from SoNode
 SoNode (void)
virtual ~SoNode ()
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 ~SoFieldContainer ()
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

Static Protected Member Functions

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

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/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8).


Constructor & Destructor Documentation

SoVRMLScalarInterpolator::SoVRMLScalarInterpolator ( void  )

Constructor.

References keyValue, and value_changed.

SoVRMLScalarInterpolator::~SoVRMLScalarInterpolator ( )
protectedvirtual

Destructor.


Member Function Documentation

SoType SoVRMLScalarInterpolator::getClassTypeId ( void  )
static

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

Reimplemented from SoVRMLInterpolator.

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
}
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 ** SoVRMLScalarInterpolator::getFieldDataPtr ( void  )
staticprotected

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

Reimplemented from SoVRMLInterpolator.

const SoFieldData * SoVRMLScalarInterpolator::getFieldData ( void  ) const
protectedvirtual

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::getOutputDataPtr ( void  )
staticprotected

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

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.

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


Member Data Documentation

SoMFFloat SoVRMLScalarInterpolator::keyValue

The keyValue vector.

Referenced by SoVRMLScalarInterpolator().

SoEngineOutput SoVRMLScalarInterpolator::value_changed

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

Referenced by SoVRMLScalarInterpolator().


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

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

Generated on Wed Jul 18 2012 for Coin by Doxygen. 1.8.1.1