SoVRMLCoor...terpolator(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

SoVRMLCoordinateInterpolator — the class that interpolates 3D coordinates ✨

(Also known as SoVRMLCoor...terpolator(3), from the Library Functions Manual, because the title got squished and honestly bestie, same. 🫶)

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLCoorinateInterpolator.h>

Inherits SoVRMLInterpolator. Yes she's a nepo baby but she EARNED it. 👑

🎀 Public Member Functions 🎀

  • virtual SoType getTypeId (void) const — gives you the type id, like a little name tag at the function party 🏷️
  • virtual const SoEngineOutputData * getOutputData (void) const — hands over the output data, the whole blueprint of what she puts out into the world 💅

🦋 Public Member Functions inherited from SoNodeEngine 🦋

  • void evaluateWrapper (void) — the lil wrapper that kicks off evaluation
  • virtual int getOutputs (SoEngineOutputList &l) const — dumps all the outputs into your list
  • SoEngineOutput * getOutput (const SbName &outputname) const — grabs one output by name
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const — reverse lookup, name for an output
  • SbBool isNotifying (void) const — is she in her notifying era? 💌
  • virtual void notify (SoNotList *nl) — the notification moment
  • virtual void writeInstance (SoOutput *out) — writes the instance out, putting it on paper 📝

🌸 Public Member Functions inherited from SoNode 🌸

  • void setOverride (const SbBool state) — turn override mode on or off
  • SbBool isOverride (void) const — are we overriding rn?
  • void setNodeType (const NodeType type) — assign her a node type
  • NodeType getNodeType (void) const — read back that node type
  • virtual SoNode * copy (SbBool copyconnections=0) const — clone her, optionally with the connections too
  • virtual SbBool affectsState (void) const — does she change the state?
  • virtual void doAction (SoAction *action) — do the action, go girl
  • virtual void GLRender (SoGLRenderAction *action) — render her in GL
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render, below-path flavor
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render, in-path flavor
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render, off-path flavor
  • virtual void callback (SoCallbackAction *action) — run the callback action
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — get the bounding box 📦
  • virtual void getMatrix (SoGetMatrixAction *action) — get the matrix, math girlie
  • virtual void handleEvent (SoHandleEventAction *action) — handle an event
  • virtual void pick (SoPickAction *action) — the picking action
  • virtual void rayPick (SoRayPickAction *action) — ray picking, the cooler cousin
  • virtual void search (SoSearchAction *action) — the search action
  • virtual void write (SoWriteAction *action) — write it out
  • virtual void audioRender (SoAudioRenderAction *action) — audio render, yes she does sound too 🎧
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — count the primitives
  • virtual void grabEventsSetup (void) — set up event grabbing
  • virtual void grabEventsCleanup (void) — clean up that event grabbing
  • virtual void startNotify (void) — begin the notify
  • uint32_t getNodeId (void) const — her node id number
  • virtual SoChildList * getChildren (void) const — get the children
  • virtual SoNode * addToCopyDict (void) const — add herself to the copy dict
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy the contents over
  • virtual SoFieldContainer * copyThroughConnection (void) const — copy through a connection

💜 Public Member Functions inherited from SoFieldContainer 💜

  • void setToDefaults (void) — reset everything to defaults, a fresh start ✨
  • SbBool hasDefaultValues (void) const — are all the values default?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — do the fields match?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copy field values from another container
  • SbBool set (const char *const fielddata) — set from field data string
  • void get (SbString &fielddata) — get the field data as a string
  • virtual int getFields (SoFieldList &l) const — grab the fields into a list
  • virtual int getAllFields (SoFieldList &l) const — grab ALL the fields, no crumbs left
  • virtual SoField * getField (const SbName &name) const — get one field by name
  • virtual SoField * getEventIn (const SbName &name) const — get an event in by name
  • virtual SoField * getEventOut (const SbName &name) const — get an event out by name
  • SbBool getFieldName (const SoField *const field, SbName &name) const — name for a given field
  • SbBool enableNotify (const SbBool flag) — turn notifications on or off
  • SbBool isNotifyEnabled (void) const — are notifications enabled?
  • SbBool set (const char *fielddata, SoInput *in) — set from field data with an SoInput
  • void get (SbString &fielddata, SoOutput *out) — get the field data with an SoOutput
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — sanity-check a new field value
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — add a write reference
  • SbBool getIsBuiltIn (void) const — is it built in?
  • void setUserData (void *userdata) const — stash some user data
  • void * getUserData (void) const — get that user data back

🧚 Public Member Functions inherited from SoBase 🧚

  • void ref (void) const — bump the ref count
  • void unref (void) const — drop the ref count
  • void unrefNoDelete (void) const — drop the ref count, no delete
  • int32_t getRefCount (void) const — what's the ref count rn?
  • void touch (void) — touch her, wake her up
  • SbBool isOfType (SoType type) const — is she this type?
  • virtual SbName getName (void) const — her name
  • virtual void setName (const SbName &newname) — give her a new name
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove an auditor
  • const SoAuditorList & getAuditors (void) const — get the whole auditor list
  • SbBool shouldWrite (void) — should she be written out?
  • void assertAlive (void) const — assert that she's alive 💀

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void) — the class type id
  • static void * createInstance (void) — make an instance
  • static void initClass (void) — init the class

🌈 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)
  • 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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (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)
  • static SoType getClassTypeId (void)
  • 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

🍓 Public Attributes 🍓

  • SoMFVec3f keyValue — the multi-field of 3D vecs she interpolates over
  • SoEngineOutput value_changed — the output that fires when the value changes 🔥

🍓 Public Attributes inherited from SoVRMLInterpolator 🍓

  • SoMFFloat key — the keyframe floats
  • SoSFFloat set_fraction — the single float you feed in to pick your spot between keyframes

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const — the field data, protected girlie

🎀 Protected Member Functions inherited from SoVRMLInterpolator 🎀

  • int getKeyValueIndex (float &interp) — figures out which key value index you're on and hands back the interp factor

🎀 Protected Member Functions inherited from SoNodeEngine 🎀

  • SoNodeEngine (void) — constructor
  • virtual ~SoNodeEngine () — destructor
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance in
  • virtual void inputChanged (SoField *which) — react to an input changing
  • void writeOutputTypes (SoOutput *out) — write out the output types

🎀 Protected Member Functions inherited from SoNode 🎀

  • SoNode (void) — constructor
  • virtual ~SoNode () — destructor

🎀 Protected Member Functions inherited from SoFieldContainer 🎀

  • SoFieldContainer (void) — constructor
  • ~SoFieldContainer () — destructor

🎀 Protected Member Functions inherited from SoBase 🎀

  • SoBase (void) — constructor
  • virtual ~SoBase () — destructor
  • SbBool hasMultipleWriteRefs (void) const — got multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header
  • void writeFooter (SoOutput *out) const — write the footer
  • virtual const char * getFileFormatName (void) const — the file format name

💅 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
}

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode

uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

📖 DETAILED DESCRIPTION 📖

SoVRMLCoordinateInterpolator is the class that interpolates 3D coordinates. She's the glow-up between keyframes and bestie she is SLAYING at it 💅✨

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

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

So the vibe is: this node linearly interpolates among a list of MFVec3f values. 🦋

The number of coordinates in the keyValue field shall be an integer multiple of the number of keyframes in the key field. That integer multiple defines how many coordinates will be contained in the value_changed events.

Like, that's the RULE, no cap. 🔢

4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8), contains a more detailed discussion of interpolators. Go read it, it's giving ✨ required reading ✨ energy.

part 2 incoming, don't go anywhere bestie 🎀

💖 Member Function Documentation 💖

Okay bestie, this is where we get into the actual functions, and honestly? It's giving "look at me, I'm the type system." Let's go. ✨

🦋 SoType SoVRMLCoordinateInterpolator::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. No cap. It's literally how you safely ask "what even are you?" before you cast.

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 * SoVRMLCoordinateInterpolator::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 * SoVRMLCoordinateInterpolator::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.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that's a wrap on SoVRMLCoor...terpolator(3)! Footer tea: source/version is Coin, Version 2.5.0, and the page is SoVRMLCoor...terpolator(3). The footer didn't give a date, so no date to report, bestie — it's just timeless. 💖✨

📦 where this page comes from