Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
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

Public Member Functions

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

Static Public Member Functions

static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoNodeEngine
static SoType getClassTypeId (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
- Static Public Member Functions inherited from SoNode
static void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initClasses (void)
 
static void pickS (SoAction *action, SoNode *node)
 
static void rayPickS (SoAction *action, SoNode *node)
 
static void searchS (SoAction *action, SoNode *node)
 
static void writeS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Public Attributes

SoMFFloat key
 
SoSFFloat set_fraction
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
int getKeyValueIndex (float &interp, int numvalues)
 
- Protected Member Functions inherited from SoNodeEngine
 SoNodeEngine (void)
 
virtual ~SoNodeEngine (void)
 
virtual void evaluate (void)=0
 
virtual void inputChanged (SoField *which)
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
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 ()
 
virtual SoNotRec createNotRec (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
static const SoEngineOutputData ** getOutputDataPtr (void)
 
- Static Protected Member Functions inherited from SoNodeEngine
static const SoFieldData ** getFieldDataPtr (void)
 
static const SoEngineOutputData ** getOutputDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Additional Inherited Members

- Public Types inherited from SoNode
enum  NodeType {
  INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 ,
  INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 ,
  COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 ,
  COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 ,
  COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
 
- Protected Attributes inherited from SoNode
SbUniqueId uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 
- Static Protected Attributes inherited from SoNode
static int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

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/documents/specifications/14772/V2.0/part1/concepts.html#4.6.8

Member Function Documentation

◆ getClassTypeId()

SoType SoVRMLInterpolator::getClassTypeId ( void )
static

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

◆ getFieldData()

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 SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, and SoVRMLScalarInterpolator.

◆ getFieldDataPtr()

const SoFieldData ** SoVRMLInterpolator::getFieldDataPtr ( void )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

◆ getKeyValueIndex()

int SoVRMLInterpolator::getKeyValueIndex ( float & interp,
int numvalues )
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ getOutputData()

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 SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, and SoVRMLScalarInterpolator.

◆ getTypeId()

SoType SoVRMLInterpolator::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

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

◆ initClass()

void SoVRMLInterpolator::initClass ( void )
static

Member Data Documentation

◆ key

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 its 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.

◆ set_fraction

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 its 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: