SoVRMLInterpolator(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLInterpolator(3) 💖

okay so bestie, welcome to the manual page for SoVRMLInterpolator — she's the internal abstract class, the blueprint queen, the mother of interpolators. Let's get into it. 🫶

✨ NAME ✨

SoVRMLInterpolator — the SoVRMLInterpolator class is an internal abstract class. That's it. That's her whole deal. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLInterpolator.h>

Inherits SoNodeEngine.

Inherited by SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, and SoVRMLScalarInterpolator. (yes bestie, the whole interpolator friend group 🎀)

🌈 Public Member Functions 🌈

  • virtual SoType getTypeId(void) const
  • virtual const SoEngineOutputData * getOutputData(void) const

💜 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=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

💖 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=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

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

⭐ Static Public Member Functions ⭐

  • 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 🎀

  • SoMFFloat key
  • SoSFFloat set_fraction

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData(void) const
  • int getKeyValueIndex(float &interp)

🍓 Protected Member Functions inherited from SoNodeEngine 🍓

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

🌸 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 🦋

The SoVRMLInterpolator class is an internal abstract class. (she's giving "I don't do much myself but everyone depends on me" and honestly? iconic. 👑)

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. 🚫 like fr fr, she is NOT a real node, do not try to instantiate her, she will not be your main character.

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

(go read it, bestie, it's the source material 💅)

to be continued… part 2 is coming, don't you dare close the tab 🎀

💖 Member Function Documentation 💖

okay so this is where we get into the member functions, and honestly? They're giving main character energy. Let's go. 💅

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

This one returns the type identification of an object derived from a class inheriting SoBase. It's used for run-time type checking and "downward" casting. So basically it's the vibe check that tells you what you're working with. 🦋

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. So yeah, if you're extending, you gotta override it. No skipping. 💖

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. That's the lore, bestie. 📚

Implements SoBase.

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

🌸 const SoFieldData * SoVRMLInterpolator::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. So it's like, "hey, here's the field data, or NULL if there's nothing." Simple. ✨

Reimplemented from SoFieldContainer.

Reimplemented in SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, 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. So it's giving backstage, not for the general public. 🙈

Implements SoNodeEngine.

Reimplemented in SoVRMLColorInterpolator, SoVRMLCoordinateInterpolator, SoVRMLNormalInterpolator, SoVRMLOrientationInterpolator, SoVRMLPositionInterpolator, 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. Again, internal tea only. ☕

References key, and set_fraction. So it's pulling from those two fields. 🔥

🌈 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. So like, they can stay the same or go up, but never go down. Periodt. 💅

The field is inherited from it's declaration in the abstract SoVRMLInterpolator class into a range of different VRML interpolator nodes. So it's a whole family thing. 👑

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. iykyk. 🦋

Referenced by getKeyValueIndex().

🌸 SoSFFloat SoVRMLInterpolator::set_fraction 🌸

The set_fraction field gets an input signal that triggers a calculation of the next value_changed eventOut value. So it's the trigger for the next big reveal. ✨

The field is inherited from it's declaration in the abstract SoVRMLInterpolator class into a range of different VRML interpolator nodes. Same inheritance vibe as key. 💖

Referenced by getKeyValueIndex().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. So Doxygen did the thing, and Coin is the source. 🤖✨

And that's the whole page, bestie! This was Coin, Version 2.5.0, and the man page is SoVRMLInterpolator(3). The date? It's giving timeless, but you know it's from the Doxygen generation. Stay iconic. 💅💖

📦 where this page comes from