SoInterpolate(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoInterpolate(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're about to get into SoInterpolate, from the Coin library's Library Functions Manual section 3. this is the whole page, nothing skipped, and yes i'm gonna make it cute. 🎀

✨ NAME ✨

SoInterpolate — the SoInterpolate class is the base class for all interpolator engines. it's giving founder, it's giving ancestor, it's giving everyone else inherits from me. 👑

✨ SYNOPSIS ✨

#include <Inventor/engines/SoInterpolate.h>

Inherits SoEngine.

Inherited by SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

🌸 Public Member Functions 🌸

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

🦋 Public Member Functions inherited from SoEngine 🦋

  • 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)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const
  • SbBool shouldCopy (void) const
  • virtual void writeInstance (SoOutput *out)

🌈 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
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • 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)
  • virtual void startNotify (void)
  • 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 void initClasses (void)

🦋 Static Public Member Functions inherited from SoEngine 🦋

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

🌈 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 🍓

  • SoSFFloat alpha
  • SoEngineOutput output

🧚 Protected Member Functions 🧚

  • SoInterpolate ()
  • virtual ~SoInterpolate ()

🦋 Protected Member Functions inherited from SoEngine 🦋

  • SoEngine (void)
  • virtual ~SoEngine ()
  • 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 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 ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🦋 Static Protected Member Functions inherited from SoEngine 🦋

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

💜 Static Protected Member Functions inherited from SoBase 💜

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🎀 Additional Inherited Members 🎀

  • Protected Types inherited from SoBase: enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
  • Protected Attributes inherited from SoFieldContainer: SbBool isBuiltIn

💅 Detailed Description 💅

the SoInterpolate class is the base class for all interpolator engines. no cap.

interpolators are used to linearly interpolate between two values. it's literally the "in between" girlie of the engine world. ✨

in Coin, we've chosen to implement all interpolators in separate files. so heads up bestie — if you want to be OIV compatible when programming, you should include the SoInterpolate.h, and not the interpolator file(s) you need. okay? okay. 🫶

🛠️ Constructor & Destructor Documentation 🛠️

SoInterpolate::SoInterpolate (void ) [protected]

default constructor. the humble beginning. 🙈

References alpha, and SoType::badType().

Referenced by getFieldData().

SoInterpolate::~SoInterpolate () [protected], [virtual]

destructor. it's giving closure, it's giving goodbye. 😭

References SoDebugError::postInfo().

🔥 Member Function Documentation 🔥

SoType SoInterpolate::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. yes, downward. slay.

usage example, and please keep it exactly like this:

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. that's not a vibe suggestion, that's the assignment. 📝 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.

Implements SoBase.

Reimplemented in SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

const SoFieldData * SoInterpolate::getFieldData (void ) const [virtual]

returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. the audacity of NULL honestly 💀

Reimplemented from SoFieldContainer.

Reimplemented in SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

References SoInterpolate().

const SoEngineOutputData * SoInterpolate::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 like… bestie, look away. 🙈 not for you.

Implements SoEngine.

Reimplemented in SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, and SoInterpolateVec4f.

void SoInterpolate::initClasses (void ) [static]

this method is provided only for API compatibility, and does nothing in Coin. literally nothing. zero. the void. she's decorative. 💅

🍓 Member Data Documentation 🍓

SoSFFloat SoInterpolate::alpha

the value which says how much we've should interpolate from first value to second value. a value equal to 0 will give an output equal to the first value, alpha equal to 1 gives the second value, any value in between gives a "weighted" interpolation between the two values. it's a slider, bestie. it's the vibe dial. 🎚️

Referenced by SoInterpolate().

SoEngineOutput SoInterpolate::output

interpolated values from the input fields. the type of the output will of course be the same as the type of the input fields of each non-abstract subclass inheriting SoInterpolate. consistency queen 👑

🌸 Author 🌸

generated automatically by Doxygen for Coin from the source code. so technically not a human author, more like a very organized robot. iconic behavior honestly. 🤖✨

reminder bestie: every single member, every inherited function, every NULL, every 0x01 — it's all still here. the vibe changed, the facts did not. periodt. 💖

and that's the whole page, fr fr. this one came from Coin, Version 2.5.0 🪙 and it's the SoInterpolate(3) manual page — go interpolate something, you main character. 🦋🌈💅

📦 where this page comes from