SoVRMLColorInterpolator(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

okay bestie, welcome to the SoVRMLColorInterpolator(3) page — straight out of the Library Functions Manual 💖

SoVRMLColorInterpolator — the class that interpolates color values. that's it, that's the whole job. it's giving "glow up but make it math" 🌈

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLColorInterpolator.h>

it inherits SoVRMLInterpolator. family tree goes hard, we love a lineage 👑

💅 Public Member Functions 💅

these are the ones this class brings to the party:

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

🎀 Public Member Functions inherited from SoNodeEngine 🎀

everything below came free with the family, no cap:

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 🌸

look at this list. it's long. it's giving main character energy, honestly:

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 🫶

the field-management girlies. obsessed with them fr fr:

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 💜

the literal root of everything. the ancestor. the blueprint. periodt:

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 girlies for this class specifically:

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)
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 👑

the actual data, the moment we've all been waiting for 💖

SoMFColor keyValue
SoEngineOutput value_changed

✨ Public Attributes inherited from SoVRMLInterpolator ✨

SoMFFloat key
SoSFFloat set_fraction

🧚 Protected Member Functions 🧚

members-only, iykyk. not for just anyone's eyes 🙈

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLColorInterpolator ()

🌸 Protected Member Functions inherited from SoVRMLInterpolator 🌸

int getKeyValueIndex (float &interp)

🌸 Protected Member Functions inherited from SoNodeEngine 🌸

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

all the extra lore that came along for the ride 🫶

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
bestie this is part 1 and it's already this long 😭 the rest is coming, do not touch that dial 💖

🎨 Detailed Description 🎨

Okay bestie, gather round, because the SoVRMLColorInterpolator class is used to interpolate color values. That's it, that's the whole job, and honestly? It ate. Colors in, colors sliding smoothly out, gradient excellence, no notes. 💅

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:

ColorInterpolator {
  eventIn      SFFloat set_fraction        # (-inf, inf)
  exposedField MFFloat key           []    # (-inf, inf)
  exposedField MFColor keyValue      []    # [0,1]
  eventOut     SFColor value_changed
}

So this node interpolates among a list of MFColor key values to produce an SFColor (RGB) value_changed event. The number of colours in the keyValue field shall be equal to the number of keyframes in the key field — they gotta match, it's giving matched set, it's giving soulmates. 🫶

The keyValue field and value_changed events are defined in RGB colour space. A linear interpolation using the value of set_fraction as input is performed in HSV space (see http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/bibliography.html#[FOLE] for description of RGB and HSV colour spaces).

⚠️ Heads up bestie, this one matters: the results are undefined when interpolating between two consecutive keys with complementary hues. Undefined. Not "kinda weird", not "a little off" — undefined. Don't do it. 🙈

4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8) contains a detailed discussion of interpolators, if you wanna go read the lore. 📚

🛠️ Constructor & Destructor Documentation 🛠️

✨ SoVRMLColorInterpolator::SoVRMLColorInterpolator (void ) ✨

Constructor. The birth of a legend, fr fr. 🌱

References keyValue, SoVRMLColorInterpolator(), and value_changed.

Referenced by getFieldData(), and SoVRMLColorInterpolator().

💀 SoVRMLColorInterpolator::~SoVRMLColorInterpolator () [protected], [virtual] 💀

Destructor. It's the end of an era, say goodbye with grace. 🥀

🧠 Member Function Documentation 🧠

👑 SoType SoVRMLColorInterpolator::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. Very "who are you really, underneath it all". 🔍

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. Macros doing the heavy lifting so you don't have to — iconic behaviour honestly. 💅

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 * SoVRMLColorInterpolator::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. Nothing there? NULL. Zero. Empty. A whole mood. 😭

Reimplemented from SoVRMLInterpolator.

References SoVRMLColorInterpolator().

🔒 const SoEngineOutputData * SoVRMLColorInterpolator::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. Not your business, bestie, respectfully. 🙈

Reimplemented from SoVRMLInterpolator.

📦 Member Data Documentation 📦

🌈 SoMFColor SoVRMLColorInterpolator::keyValue 🌈

The color values.

Referenced by SoVRMLColorInterpolator().

💖 SoEngineOutput SoVRMLColorInterpolator::value_changed 💖

The eventOut color.

Referenced by SoVRMLColorInterpolator().

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. Not a human author, just a robot doing its little thing with great efficiency. 🤖✨

And that's a wrap, bestie! 🎀 This page is Coin, Version 2.5.0, and it's the SoVRMLColorInterpolator(3) page — read it, love it, interpolate responsibly. The robots generated it, the Consortium blessed it, and now it lives in your terminal rent-free. Slay, hydrate, and go make some gradients. 💅🦋🌸

📦 where this page comes from