SoVRMLNormal(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoVRMLNormal — Library Functions Manual 💅

okay bestie, so this is the manual page for SoVRMLNormal(3) — it lives in the Library Functions Manual and it's literally all about binding normals to geometry. no cap. 🦋

✨ NAME ✨

SoVRMLNormal — the class that's used to bind normals to geometry. that's it, that's the name. 💖

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLNormal.h>

It inherits from SoNode. (yes, SoNode is the parent, periodt. 👑)

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • SoVRMLNormal (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 🫶

  • 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 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=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 💜

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

  • SoMFVec3f vector

🌸 Protected Member Functions 🌸

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

🌿 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)
  • ~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
}

🦋 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 💅

The SoVRMLNormal class is used to bind normals to geometry. (yes bestie, that's the whole vibe.)

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:

Normal {
  exposedField MFVec3f vector  []   # (-,)
}

This node defines a set of 3D surface normal vectors to be used in the vector field of some geometry nodes (e.g., SoVRMLIndexedFaceSet and SoVRMLElevationGrid). This node contains one multiple-valued field that contains the normal vectors. Normals shall be of unit length. (unit length only, no exceptions, fr fr. 💅)

🌸 Constructor & Destructor Documentation 🌸

💖 SoVRMLNormal::SoVRMLNormal (void ) 💖

Constructor.

References SoVRMLNormal(), and vector.

Referenced by getFieldData(), and SoVRMLNormal().

💖 SoVRMLNormal::~SoVRMLNormal () [protected], [virtual] 💖

Destructor.

💖 MEMBER FUNCTION DOCUMENTATION 💖

✨ SoType SoVRMLNormal::getTypeId (void ) const [virtual] ✨

Okay bestie, this one hands you the type ID of any object that descends from SoBase. It's the whole reason run-time type checking and "downward" casting work — like, it's how you peek at a node and go "oh wait, I know exactly what you are" 👑

Usage example, and yes this is verbatim, no cap:

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
  }
}

Now listen — if you're an application programmer who wants to extend the library with new nodes, engines, nodekits, draggers or whatever else, this method has to be overridden in all subclasses. It's not optional, it's giving mandatory 💅. You typically do it as part of setting up the full type system for your extension classes, and the usual move is to use the pre-defined macros, which you'll find 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.

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🫶

Implements SoBase.

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

Hands you back a pointer to the class-wide field data storage object for this instance. And if there are no fields present at all? It returns NULL. That's it, that's the whole vibe.

Reimplemented from SoFieldContainer.

References SoVRMLNormal().

🦋 void SoVRMLNormal::doAction (SoAction * action) [virtual] 🦋

This is the function that does the typical operation of a node for any action. The little multitasker of the node world ✨.

Reimplemented from SoNode.

References SoAction::getState().

Referenced by callback(), getPrimitiveCount(), GLRender(), and pick().

🎀 void SoVRMLNormal::GLRender (SoGLRenderAction * action) [virtual] 🎀

Action method for the SoGLRenderAction.

This one gets called during rendering traversals. Any node that influences the rendering state in any way, or that just wants to throw geometry primitives at OpenGL, overrides this method. Main character energy, honestly 🔥.

Reimplemented from SoNode.

References doAction(), SoAction::getState(), SoBase::staticDataLock(), SoBase::staticDataUnlock(), and vector.

🌈 void SoVRMLNormal::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 the SoCallbackAction for extracting information about the scene graph. Lowkey handy 💜.

Reimplemented from SoNode.

References doAction().

⭐ void SoVRMLNormal::pick (SoPickAction * action) [virtual] ⭐

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Shared chores, cute.

Reimplemented from SoNode.

References doAction().

🍓 void SoVRMLNormal::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 🧮💅.

Nodes that influence how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoNode.

References doAction().

💜 MEMBER DATA DOCUMENTATION 💜

🧚 SoMFVec3f SoVRMLNormal::vector 🧚

The normal vectors. Empty by default — she starts with nothing and you gotta fill her up 🌸.

Referenced by SoVRMLElevationGrid::generatePrimitives(), SoVRMLVertexShape::getVertexData(), SoVRMLElevationGrid::GLRender(), GLRender(), and SoVRMLNormal().

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. Not me writing a love letter, just a robot doing robot things 🤖💖.

And that's a wrap bestie!! This page is from Coin Version 2.5.0 and it's the SoVRMLNormal(3) manual page — go forth and cast things safely, mwah 💅✨🦋
📦 where this page comes from