SoNormal(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

SoNormal — okay so, the SoNormal class is a node for providing normals to the state. That's the whole assignment bestie, and it ate. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoNormal.h>

Inherits SoNode.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoNormal (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

💜 Public Member Functions inherited from SoNode 💜

These are the ones she got from her mom SoNode, no cap:

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const
  • virtual SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💚 Public Member Functions inherited from SoBase 💚

The origin story, fr fr:

  • 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 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 vector
This is the main character right here, okay. The one field. The whole personality. 🌈

🛡️ Protected Member Functions 🛡️

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

🔐 Protected Member Functions inherited from SoNode 🔐

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

🔏 Protected Member Functions inherited from SoFieldContainer 🔏

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

🗝️ Protected Member Functions inherited from SoBase 🗝️

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • 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 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, 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

🌷 Protected Attributes inherited from SoFieldContainer 🌷

  • SbBool isBuiltIn

🎀 Static Protected Attributes inherited from SoNode 🎀

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

📖 Detailed Description 📖

Okay bestie, listen. The SoNormal class is a node for providing normals to the state. That's the vibe. ✨

Coin will automatically calculate normals for you if no SoNormal nodes are present in the scene graph — yes, she does it herself, she's that girl. But explicitly setting normals is useful for at least two purposes:

  1. a potential increase in performance
  2. you can calculate and use "incorrect" normals to do various special effects
Not me telling you that "wrong" normals are a whole aesthetic. They are. That's the point. 🔥

FILE FORMAT/DEFAULTS:

Normal {
    vector [  ]
}

👀 See also 👀

  • SoNormalBinding

🎀 Constructor & Destructor Documentation 🎀

✨ SoNormal::SoNormal (void ) ✨

Constructor. She's born. 💖

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

Destructor. She's gone. 🥲

✨ Member Function Documentation ✨

Okay bestie, this is the part where we meet the actual methods — the little moves SoNormal pulls when the scene graph comes knocking. Strap in. 🎀

🦋 SoType SoNormal::getTypeId (void) const [virtual]

Hands you back the type identification of any object derived from a class that inherits SoBase. It's the whole reason run-time type checking and "downward" casting even work, no cap.

Usage example, copy it, love it, use it:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now listen — if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else you dream up: you have to override this method in all subclasses. Periodt. This is usually done as part of setting up the full type system for your extension classes, and that's typically accomplished with the pre-defined macros available through, for instance:

  • Inventor/nodes/SoSubNode.h — which gives you SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes
  • Inventor/engines/SoSubEngine.h — for engine classes
  • and so on, you get the vibe 💅

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. They explain it way better than I could in a group chat.

Implements SoBase.

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole function. 🫶

Reimplemented from SoFieldContainer.

💖 void SoNormal::doAction (SoAction * action) [virtual]

This one performs the typical operation of a node for any action. The all-rounder. The main character of action methods. 👑

Reimplemented from SoNode.

🌈 void SoNormal::GLRender (SoGLRenderAction * action) [virtual]

The action method for SoGLRenderAction, bestie — it gets called during rendering traversals.

Any node that influences the rendering state in any way, or who just wants to throw geometry primitives at OpenGL, overrides this method. That's the assignment. ✨

Reimplemented from SoNode.

🍓 void SoNormal::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so that you, the application programmer, can use SoCallbackAction to extract information about the scene graph. Very demure, very useful. 💅

Reimplemented from SoNode.

🌸 void SoNormal::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

It does the common processing for SoPickAction action instances. Lowkey essential, highkey underrated. 🎀

Reimplemented from SoNode.

⭐ void SoNormal::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Math girlies rise. 🔥

Heads up: nodes that influence how geometry nodes calculate their primitive count also override this method, so they can change the relevant state variables.

Reimplemented from SoNode.

🎀 Member Data Documentation 🎀

💜 SoMFVec3f SoNormal::vector

Sets a pool of normal vectors in the traversal state. That's the whole vibe — it's the data behind all the fancy footwork above. 👑

👑 Author

Generated automatically by Doxygen for Coin from the source code.

And that's a wrap on SoNormal(3) — this page came straight out of the Coin source, version 3.1.3, and it's the SoNormal(3) manual page doing its little bow. Go forth and normalise responsibly, bestie. 💖✨🦋

📦 where this page comes from