SoVRMLScalarInterpolator(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🦋 SoVRMLScalarInterpolator(3) — Coin 🦋

okay so bestie, this is a manual page from Coin, section 3, and it's all about a class called SoVRMLScalarInterpolator. Grab a snack, we're doing this together 💅

✨ NAME ✨

SoVRMLScalarInterpolator — the class whose whole job is interpolating scalar values. That's the vibe. 🎀

🌈 SYNOPSIS 🌈

#include <Inventor/VRMLnodes/SoVRMLScalarInterpolator.h>

It inherits SoVRMLInterpolator — so everything that parent class has going on, this one gets too. nepotism but make it C++ 👑

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — the classic type-id getter.
  • virtual const SoEngineOutputData * getOutputData (void) const — hands you the output data.
  • SoVRMLScalarInterpolator (void) — constructor, she's born ✨

Public Member Functions inherited from SoNodeEngine

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (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 SoNode * copy (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)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection (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 SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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 SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🌟 Static Public Member Functions 🌟

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

Static Public Member Functions inherited from SoVRMLInterpolator

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoNodeEngine

  • 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 SoType getClassTypeId (void)

Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • 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 SbUniqueId getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • 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 void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

Static Public Member Functions inherited from SoFieldContainer

  • 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 SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

Static Public Member Functions inherited from SoBase

  • 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 SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🫶 Public Attributes 🫶

  • SoMFFloat keyValue
  • SoEngineOutput value_changed

Public Attributes inherited from SoVRMLInterpolator

  • SoMFFloat key
  • SoSFFloat set_fraction

🔒 Protected Member Functions 🔒

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLScalarInterpolator ()

Protected Member Functions inherited from SoVRMLInterpolator

  • int getKeyValueIndex (float &interp, int numvalues)

Protected Member Functions inherited from SoNodeEngine

  • SoNodeEngine (void)
  • virtual ~SoNodeEngine (void)
  • 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
  • virtual SoNotRec createNotRec (void)

🧚 Static Protected Member Functions 🧚

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

Static Protected Member Functions inherited from SoVRMLInterpolator

  • 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 void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

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 }

okay that's part 1 wrapped — more of this page is loading, don't go anywhere bestie 💖

🫶 Protected Attributes (inherited, lowkey family heirlooms)

  • SbUniqueId uniqueId — inherited from SoNode, just chilling in there.
  • SbBool isBuiltIn — inherited from SoFieldContainer, also vibing.

✨ Static Protected Attributes (inherited from SoNode)

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay bestie, so the SoVRMLScalarInterpolator class is here to interpolate scalar values. that's the whole job. she does one thing and she eats every time. 👑

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

so what she does is linearly interpolate among a list of SFFloat values. she's the moment for literally any parameter that's defined with a single floating point value — think width, radius, intensity fields. iconic versatility honestly. 🌈

heads up bestie: the keyValue field shall contain exactly as many numbers as there are keyframes in the key field. no more, no less. match them up or she will simply not be serving. 💅

if you want the full deep-dive lore on interpolators, there's a whole writeup in 4.6.8, Interpolator nodes — you can find it at http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.8 🦋

🌸 Constructor & Destructor Documentation 🌸

SoVRMLScalarInterpolator::SoVRMLScalarInterpolator (void )

Constructor. that's it, that's the sentence, she's born. 🎀

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

Destructor. she says goodbye, protected-ly and virtually. 💀

💅 Member Function Documentation 💅

SoType SoVRMLScalarInterpolator::getClassTypeId (void ) — [static]

This static method returns the SoType object associated with objects of this class. like a little name tag but make it runtime. ⭐

SoType SoVRMLScalarInterpolator::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. yes, downward in quotes, we love a quoted downward. 🙈

Reimplemented from SoVRMLInterpolator.

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

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: not for you bestie, it's giving staff-only entrance 🚪)

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

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. fr fr, NULL is a real possibility here.

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. same energy as above, internal business only. 🔒

Reimplemented from SoVRMLInterpolator.

void SoVRMLScalarInterpolator::initClass (void ) — [static]

no blurb in the source for this one, it's just listed there being mysterious. we respect the silence. 🤫

🍓 Member Data Documentation 🍓

SoMFFloat SoVRMLScalarInterpolator::keyValue

The keyValue vector. short king of a description, but she's important. 👑

SoEngineOutput SoVRMLScalarInterpolator::value_changed

The eventOut which is sent every time the interpolator has calculated a new value. so every single time she does the math, she tells the world. main character energy fr. 📣

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. not a human, just a robot doing her little documentation dance. 🤖✨

and that's a wrap on the page, bestie! this footer moment came to you courtesy of Version 4.0.10, dated Thu Jun 25 2026 00:00:00, on the SoVRMLScalarInterpolator(3) page — go interpolate something cute, ily, bye 🫶💖🌈

📦 where this page comes from