SoVRMLPosi...terpolator(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoVRMLPositionInterpolator ✨

okay bestie, welcome to the glow-up zone 💖 this is the SoVRMLPositionInterpolator page, straight outta Library Functions Manual, section 3. she interpolates 3D points and she does it flawlessly. no cap.

🌸 NAME 🌸

SoVRMLPositionInterpolator — the class that interpolates 3D points. that's it, that's the whole job, and she ate 💅

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLPositionInterpolator.h>

she Inherits SoVRMLInterpolator — so all that ancestral lore comes with her, and we're about to list every single bit of it because we don't skip, we don't gatekeep, periodt 🫶

💖 Public Member Functions 💖

her own:

  • virtual SoType getTypeId (void) const — tells you her type id
  • virtual const SoEngineOutputData * getOutputData (void) const — hands you the engine output data
  • SoVRMLPositionInterpolator (void) — the constructor, hi queen 👑

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)

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=0) 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 SoChildList * getChildren (void) const
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection (void) const

inherited from SoFieldContainer

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

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 SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🎀 Static Public Member Functions 🎀

hers:

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

inherited from SoVRMLInterpolator

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

inherited from SoNodeEngine

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

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)

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)

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
  • SoEngineOutput value_changed

inherited from SoVRMLInterpolator

  • SoMFFloat key
  • SoSFFloat set_fraction

💜 Protected Member Functions 💜

hers:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLPositionInterpolator () — the destructor, bye bestie 😭

inherited from SoVRMLInterpolator

  • int getKeyValueIndex (float &interp)

inherited from SoNodeEngine

  • SoNodeEngine (void)
  • virtual ~SoNodeEngine ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void inputChanged (SoField *which)
  • void writeOutputTypes (SoOutput *out)

inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

inherited from SoFieldContainer

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

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 🌈

hers:

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

inherited from SoVRMLInterpolator

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

inherited from SoNodeEngine

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

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)

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 👑

The SoVRMLPositionInterpolator class is used to interpolate 3D points. that's the whole vibe 💫

💖 the detailed class documentation here 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. giving credit where credit is due, always 🫶
PositionInterpolator {
  eventIn      SFFloat set_fraction        # (-,)
  exposedField MFFloat key           []    # (-,)
  exposedField MFVec3f keyValue      []    # (-,)
  eventOut     SFVec3f value_changed
}

okay so listen — the PositionInterpolator node linearly interpolates among a list of 3D vectors. and here's the rule, do not skip it: the keyValue field shall contain exactly as many values as in the key field. exactly. no more, no less. matching sets only, it's giving soulmate energy 🔥

section 4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8) has a more detailed discussion of interpolators, if you want the full deep dive 🦋

💖 Constructor & Destructor Documentation 💖

✨ SoVRMLPositionInterpolator::SoVRMLPositionInterpolator (void ) ✨

okay so this is the Constructor. bestie builds the thing, no arguments, no drama. 🎀

It references keyValue, SoVRMLPositionInterpolator(), and value_changed — and heads up, it's also referenced by getFieldData() and SoVRMLPositionInterpolator(). it's giving self-referential icon behaviour, we love to see it. 👑

✨ SoVRMLPositionInterpolator::~SoVRMLPositionInterpolator () ✨

the Destructor, and ngl she's lowkey ✨fancy✨ — she's tagged [protected] and [virtual]. so she's not out here for just anyone to call, and she knows how to be overridden properly. periodt. 💅

🔥 Member Function Documentation 🔥

✨ SoType SoVRMLPositionInterpolator::getTypeId (void ) const ✨ [virtual]

this one hands you back the type identification of an object that derives from a class inheriting SoBase. what's it for? run-time type checking, and "downward" casting. iykyk. 🦋

Usage example, verbatim, do not touch:

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

so for all you application programmers out there wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else — listen up bestie: this method needs to be overridden in all subclasses. that's not optional, that's the vibe check. 🌸

Usually you do this as part of setting up the full type system for your extension classes, which is normally 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. the macros are literally doing the heavy lifting for you, slay. 💜

Want more info on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. main character homework. 📚

Reimplemented from SoVRMLInterpolator.

✨ const SoFieldData * SoVRMLPositionInterpolator::getFieldData (void ) const ✨ [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's it, that's the whole vibe. 🫶

Reimplemented from SoVRMLInterpolator.

References SoVRMLPositionInterpolator().

✨ const SoEngineOutputData * SoVRMLPositionInterpolator::getOutputData (void ) const ✨ [virtual]

okay so real talk — this API member is considered internal to the library, because it is not likely to be of interest to the application programmer. so like, if that's you, you can respectfully look away. 🙈

Reimplemented from SoVRMLInterpolator.

🎀 Member Data Documentation 🎀

✨ SoMFVec3f SoVRMLPositionInterpolator::keyValue ✨

The keyValue vector. that's the whole description, no notes. ✨

Referenced by SoVRMLPositionInterpolator().

✨ SoEngineOutput SoVRMLPositionInterpolator::value_changed ✨

The eventOut which is sent every single time the interpolator has calculated a new value. it's the little "hey bestie, new number dropped" notification of the Coin world. 🔔

Referenced by SoVRMLPositionInterpolator().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. not a human writing this, just a robot doing its thing and honestly? it ate. 💅

and that's a wrap on this page, bestie 🫶 this was Coin, Version 2.5.0, and the page is SoVRMLPosi...terpolator(3). go forth and interpolate those positions, you absolute icon. 🌈⭐💖

📦 where this page comes from