SOVRMLNORMALINTERPOLATOR(3coin2)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

Bestie, meet SoVRMLNormalInterpolator(3) — the manual for the SoVRMLNormalInterpolator class. And what is it giving? It interpolates normals. That's the whole NAME section, periodt. 💅

🦋 SYNOPSIS 🦋

To summon this class, you include this exact header, no cap:

#include <Inventor/VRMLnodes/SoVRMLNormalInterpolator.h>

Inherits SoVRMLInterpolator. 👑

💖 Public Member Functions 💖

These are the functions that live right here in SoVRMLNormalInterpolator, main character energy only:

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

💖 Public Member Functions inherited from SoNodeEngine 💖

Inherited from SoNodeEngine, because we love a family tree:

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

Inherited from SoNode — the blueprint that just keeps giving:

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

Inherited from SoFieldContainer — here's the list:

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

Inherited from SoBase, the foundation, the blueprint, the vibe:

  • 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, public, and ready to slay:

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

⭐ Static Public Member Functions inherited from SoVRMLInterpolator ⭐

Inherited from SoVRMLInterpolator:

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

⭐ Static Public Member Functions inherited from SoNodeEngine ⭐

Inherited from SoNodeEngine:

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

⭐ Static Public Member Functions inherited from SoNode ⭐

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 ⭐

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 ⭐

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 🎀

Public attributes, because we're all about transparency:

  • SoMFVec3f keyValue
  • SoEngineOutput value_changed

🎀 Public Attributes inherited from SoVRMLInterpolator 🎀

Inherited from SoVRMLInterpolator:

  • SoMFFloat key
  • SoSFFloat set_fraction

🛡️ Protected Member Functions 🛡️

Protected, so keep it cute and keep it safe:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLNormalInterpolator ()

🛡️ Protected Member Functions inherited from SoVRMLInterpolator 🛡️

Inherited from SoVRMLInterpolator:

  • int getKeyValueIndex (float &interp)

🛡️ Protected Member Functions inherited from SoNodeEngine 🛡️

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 🛡️

Inherited from SoNode:

  • SoNode (void)
  • virtual ~SoNode ()

🛡️ Protected Member Functions inherited from SoFieldContainer 🛡️

Inherited from SoFieldContainer:

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

🛡️ Protected Member Functions inherited from SoBase 🛡️

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 protected, the secret menu:

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

🔒 Static Protected Member Functions inherited from SoVRMLInterpolator 🔒

Inherited from SoVRMLInterpolator:

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

🔒 Static Protected Member Functions inherited from SoNodeEngine 🔒

Inherited from SoNodeEngine:

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

🔒 Static Protected Member Functions inherited from SoNode 🔒

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 🔒

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 💖

okay bestie, so the SoVRMLNormalInterpolator class is literally the thing that interpolates normals. that's its whole job. iconic of it honestly.

the full class lore here is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). it's copyright The Web3D Consortium, and it's used with the Consortium's permission:

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

so, the tea: the NormalInterpolator node interpolates among a list of normal vector sets, and those sets are specified by the keyValue field. the output vector, value_changed, shall be a set of normalized vectors. values in the keyValue field shall be of unit length. the number of normals in the keyValue field shall be an integer multiple of the number of keyframes in the key field. that integer multiple is what defines how many normals are going to be contained in the value_changed events.

normal interpolation shall be performed on the surface of the unit sphere. like, think about it: the output values for a linear interpolation from a point P on the unit sphere to a point Q also on the unit sphere shall lie along the shortest arc (on the unit sphere) connecting points P and Q. also, equally spaced input fractions shall result in arcs of equal length.

⚠️ bestie, listen: the results are undefined if P and Q are diagonally opposite. so don't do that. no cap.

if you want the full deep dive on interpolators, there's a more detailed discussion provided in 4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8).

🎀 Constructor & Destructor Documentation 🎀

SoVRMLNormalInterpolator::SoVRMLNormalInterpolator (void )

the constructor. it exists, it builds the thing. 💅

References keyValue, SoVRMLNormalInterpolator(), and value_changed.

Referenced by getFieldData(), and SoVRMLNormalInterpolator().

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

the destructor. it says goodbye. 😭

✨ Member Function Documentation ✨

SoType SoVRMLNormalInterpolator::getTypeId (void ) const [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is the whole point of it: run-time type checking and "downward" casting. iykyk.

usage example, fr fr:

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 if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. typically you do that as part of setting up the full type system for extension classes, and that's 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 info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups. 👑

Reimplemented from SoVRMLInterpolator.

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

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

Reimplemented from SoVRMLInterpolator.

References SoVRMLNormalInterpolator().

const SoEngineOutputData * SoVRMLNormalInterpolator::getOutputData (void ) const [virtual]

ngl, this API member is considered internal to the library, since it's not likely to be of interest to the application programmer. so like… it's giving backstage pass energy. 🫶

Reimplemented from SoVRMLInterpolator.

🌈 Member Data Documentation 🌈

SoMFVec3f SoVRMLNormalInterpolator::keyValue

the keyValue vector. that's the data.

Referenced by SoVRMLNormalInterpolator().

SoEngineOutput SoVRMLNormalInterpolator::value_changed

the eventOut which is sent every single time the interpolator has calculated a new value. main character energy honestly, it never misses. 💫

Referenced by SoVRMLNormalInterpolator().

🌸 Author 🌸

generated automatically by Doxygen for Coin from the source code. it didn't write itself bestie, the robots did it.

and that's a wrap on this one!! 🎀 this page is from Coin, Version 2.5.0, and the manual page is SoVRMLNormalInterpolator(3). go forth and interpolate those normals responsibly, love u, bye 💖✨🦋

📦 where this page comes from