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
SoVRMLInterpolator Class Reference

The SoVRMLInterpolator class is an internal abstract class. More...

#include <Inventor/VRMLnodes/SoVRMLInterpolator.h>

Inheritance diagram for SoVRMLInterpolator:
SoNodeEngine SoNode SoFieldContainer SoBase SoVRMLColorInterpolator SoVRMLCoordinateInterpolator SoVRMLNormalInterpolator SoVRMLOrientationInterpolator SoVRMLPositionInterpolator SoVRMLScalarInterpolator

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoEngineOutputDatagetOutputData (void) const
- Public Member Functions inherited from SoNodeEngine
void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutputgetOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
SbBool isNotifying (void) const
virtual void notify (SoNotList *nl)
virtual void writeInstance (SoOutput *out)
- Public Member Functions inherited from SoNode
void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNodecopy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
uint32_t getNodeId (void) const
virtual SoChildListgetChildren (void) const
virtual SoNodeaddToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainercopyThroughConnection (void) const
- Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoFieldgetField (const SbName &name) const
virtual SoFieldgetEventIn (const SbName &name) const
virtual SoFieldgetEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
void setUserData (void *userdata) const
void * getUserData (void) const
- Public Member Functions inherited from SoBase
void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorListgetAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (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 SoFieldDatagetFieldData (void) const
int getKeyValueIndex (float &interp)
- Protected Member Functions inherited from SoNodeEngine
 SoNodeEngine (void)
virtual ~SoNodeEngine (void)
virtual void evaluate (void)=0
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)
virtual ~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 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::getClassTypeId ( void  )
static

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

Reimplemented from SoNodeEngine.

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

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

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

Reimplemented from SoNodeEngine.

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

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

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

const SoEngineOutputData ** SoVRMLInterpolator::getOutputDataPtr ( void  )
staticprotected

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

Reimplemented from SoNodeEngine.

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.

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

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

int SoVRMLInterpolator::getKeyValueIndex ( float &  interp)
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.


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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen 1.8.1.