SOVRMLNORMALINTERPOLATOR(3coin3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVRMLNormalInterpolator (3) — Library Functions Manual 💖

okay bestie, buckle UP, because we're about to get into the Coin3D lore. This page lives in the Library Functions Manual, and it's giving "niche but iconic." ✨

🌸 NAME 🌸

SoVRMLNormalInterpolator — the class that interpolates normals. yes, normals. like surface normals. not people. slay. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLNormalInterpolator.h>

Inherits SoVRMLInterpolator. it's a whole family tree, iykyk 🫶

👑 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you the type id, and it's virtual so it knows exactly who it is. main character energy fr.
  • virtual const SoEngineOutputData * getOutputData (void) const — the receipts for every output this engine has.
  • SoVRMLNormalInterpolator (void) — the constructor. the birth. the origin story. 🌱

🌈 Public Member Functions inherited from SoNodeEngine

  • void evaluateWrapper (void) — wraps the evaluate call so the engine can do its thing.
  • virtual int getOutputs (SoEngineOutputList &l) const — dumps all the outputs into a list for you.
  • SoEngineOutput * getOutput (const SbName &outputname) const — grab one output by name.
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const — reverse lookup: output ➡️ name.
  • SbBool isNotifying (void) const — are we notifying rn or nah?
  • virtual void notify (SoNotList *nl) — sends out the notification, no cap.
  • virtual void writeInstance (SoOutput *out) — writes this instance out to the output stream.

🌟 Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — flips the override flag.
  • SbBool isOverride (void) const — checks the override flag.
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — gets the node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — makes a copy. connections optional, default is FALSE.
  • virtual SbBool affectsState (void) const — does this node mess with the state? lowkey important.
  • virtual void doAction (SoAction *action) — the generic "do the action" entry point.
  • virtual void GLRender (SoGLRenderAction *action) — renders it in GL.
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render, below-path flavor.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render, in-path flavor.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render, off-path flavor.
  • virtual void callback (SoCallbackAction *action) — runs a callback action.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — computes the matrix.
  • virtual void handleEvent (SoHandleEventAction *action) — handles events.
  • virtual void pick (SoPickAction *action) — picking, but the basic kind.
  • virtual void rayPick (SoRayPickAction *action) — ray picking, the fancy kind.
  • virtual void search (SoSearchAction *action) — search action, go find stuff.
  • virtual void write (SoWriteAction *action) — writes the node out.
  • virtual void audioRender (SoAudioRenderAction *action) — yes it also does audio rendering. versatile 💅
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives.
  • virtual void grabEventsSetup (void) — sets up event grabbing.
  • virtual void grabEventsCleanup (void) — cleans up event grabbing.
  • virtual void startNotify (void) — kicks off notification.
  • uint32_t getNodeId (void) const — returns the node's id.
  • virtual SoChildList * getChildren (void) const — returns the child list.
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dictionary.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies the contents over from another container.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through a connection.

🎀 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — resets everything to defaults.
  • SbBool hasDefaultValues (void) const — are all the values still default? checking bestie.
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compares fields with another container.
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values over, connections optional, default FALSE.
  • SbBool set (const char *const fielddata) — sets from a field data string.
  • void get (SbString &fielddata) — gets the field data as a string.
  • virtual int getFields (SoFieldList &l) const — fills the list with fields.
  • virtual int getAllFields (SoFieldList &l) const — fills the list with ALL the fields.
  • virtual SoField * getField (const SbName &name) const — grabs a field by name.
  • virtual SoField * getEventIn (const SbName &name) const — grabs an event-in by name.
  • virtual SoField * getEventOut (const SbName &name) const — grabs an event-out by name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — reverse lookup: field ➡️ name.
  • SbBool enableNotify (const SbBool flag) — turns notification on or off.
  • SbBool isNotifyEnabled (void) const — is notification enabled?
  • SbBool set (const char *fielddata, SoInput *input) — sets from field data with an SoInput.
  • void get (SbString &fielddata, SoOutput *out) — gets field data using an SoOutput.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates a new field value. the vibe check 🫣
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference, isfromfield defaults to FALSE.
  • SbBool getIsBuiltIn (void) const — is this thing built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports memory sizes, split into managed and unmanaged.
  • void setUserData (void *userdata) const — attaches your own user data.
  • void * getUserData (void) const — gets your user data back out.

💜 Public Member Functions inherited from SoBase

  • void ref (void) const — bumps the ref count.
  • void unref (void) const — drops the ref count.
  • void unrefNoDelete (void) const — unrefs without deleting. spicy 🌶️
  • int32_t getRefCount (void) const — tells you the current ref count.
  • void touch (void) — touches it, triggers notification.
  • SbBool isOfType (SoType type) const — type check.
  • virtual SbName getName (void) const — gets the name.
  • virtual void setName (const SbName &newname) — sets the name.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor of a given type.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes that auditor.
  • const SoAuditorList & getAuditors (void) const — returns the whole auditor list.
  • SbBool shouldWrite (void) — should this be written out?
  • void assertAlive (void) const — asserts it's still alive. not me being dramatic about it 💀

✨ Static Public Member Functions

  • static SoType getClassTypeId (void) — the class type id, static style.
  • static void * createInstance (void) — makes an instance for you.
  • static void initClass (void) — initializes the class.

🌸 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

💖 Public Attributes

  • SoMFVec3f keyValue — the multi-field of key values. the actual normal data lives here.
  • SoEngineOutput value_changed — the engine output that fires when the value changes. periodt.

🎀 Public Attributes inherited from SoVRMLInterpolator

  • SoMFFloat key — the key floats.
  • SoSFFloat set_fraction — the single float that sets the fraction you're interpolating at.

🙈 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — internal field data accessor.
  • virtual ~SoVRMLNormalInterpolator () — the destructor. the end of an era 😭

🌈 Protected Member Functions inherited from SoVRMLInterpolator

  • int getKeyValueIndex (float &interp) — figures out the key/value index and hands back the interpolation factor.

💅 Protected Member Functions inherited from SoNodeEngine

  • SoNodeEngine (void) — protected constructor.
  • virtual ~SoNodeEngine (void) — protected destructor.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance in.
  • virtual void inputChanged (SoField *which) — called when an input changes.
  • void writeOutputTypes (SoOutput *out) — writes the output types out.

🌟 Protected Member Functions inherited from SoNode

  • SoNode (void) — protected constructor.
  • virtual ~SoNode () — protected destructor.

🦋 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — protected constructor.
  • virtual ~SoFieldContainer () — protected destructor.

💜 Protected Member Functions inherited from SoBase

  • SoBase (void) — protected constructor.
  • virtual ~SoBase () — protected destructor.
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write refs.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header.
  • void writeFooter (SoOutput *out) const — writes the footer.
  • virtual const char * getFileFormatName (void) const — returns the file format name.

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

👑 Public Types inherited from SoNode

the enum, in all its glory:

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,
    COIN_3_0 = 0x8000,
    INVENTOR_6_0 = 0x10000
}

🦋 Protected Types inherited from SoBase

enum BaseFlags {
    IS_ENGINE = 0x01,
    IS_GROUP = 0x02
}

💜 Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the node's very own unique id.

🌈 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in or not.

⭐ Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — the next unique id to hand out, starts at 1.
  • static int nextActionMethodIndex = 0 — the next action method index, starts at 0.

okay and that's part 1, bestie — there's more where this came from 🫶

💖 DETAILED DESCRIPTION 💖

okay so bestie, listen — the SoVRMLNormalInterpolator class is literally here to interpolate normals. that's its whole thing. its moment. its era. ✨

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. give them their flowers 💐

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

The NormalInterpolator node interpolates among a list of normal vector sets 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 defines how many normals will be contained in the value_changed events. Normal interpolation shall be performed on the surface of the unit sphere. That is, 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. The results are undefined if P and Q are diagonally opposite. A more detailed discussion of interpolators is provided in 4.6.8, Interpolator nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.8).

fr fr if P and Q are diagonally opposite it's giving chaos, results are undefined, do not do it bestie 😭

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

🦋 SoVRMLNormalInterpolator::SoVRMLNormalInterpolator (void )

Constructor. that's it, that's the job 💅

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

Destructor. it's protected, it's virtual, it's saying goodbye with main character energy 🫶

✨ MEMBER FUNCTION DOCUMENTATION ✨

💜 SoType SoVRMLNormalInterpolator::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.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoVRMLInterpolator.

the way that you literally have to override this in every single subclass... it's giving commitment, it's giving type system setup, periodt 👑

🌈 const SoFieldData * SoVRMLNormalInterpolator::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.

Reimplemented from SoVRMLInterpolator.

⭐ const SoEngineOutputData * SoVRMLNormalInterpolator::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.

Reimplemented from SoVRMLInterpolator.

lowkey not for you bestie, it's internal, the library handles it 🙈

🍓 MEMBER DATA DOCUMENTATION 🍓

💖 SoMFVec3f SoVRMLNormalInterpolator::keyValue

The keyValue vector.

🧚 SoEngineOutput SoVRMLNormalInterpolator::value_changed

The eventOut which is sent every time the interpolator has calculated a new value.

not me getting emotional over an eventOut that fires every time a new value drops 🥹 it's literally doing so much for us

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. yes bestie, a robot wrote this and it ATE 💅

and that's the whole page babes 🫶 this was SoVRMLNormalInterpolator(3) from Coin, Version 3.1.3, dated the day it was generated — slay, iconic, no cap. go interpolate some normals, you've got this 💖✨🎀

📦 where this page comes from