SoVRMLShape(3)

📦 version 3.1.3, in fedora 43, fedora 44

💅 SoVRMLShape(3) — Library Functions Manual 💅

okay bestie, gather round, because today we're reading the manual page for SoVRMLShape, and it's a whole vibe. no cap. 🦋

✨ NAME ✨

SoVRMLShape — the class that holds your geometry and geometry appearance nodes. that's it, that's the whole job, and it does it iconically. 💖

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLShape.h>

Inherits SoNode. so it's part of the family tree, iykyk. 🌈

🎀 Public Types 🎀

enum CacheEnabled { OFF, ON, AUTO }

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 }

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const
  • virtual SbBool affectsState (void) const
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual SoChildList * getChildren (void) const
  • virtual void notify (SoNotList *list)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

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=FALSE) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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

  • 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 void setNumRenderCaches (int num)
  • static int getNumRenderCaches (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 🌟

  • SoSFNode appearance
  • SoSFNode geometry
  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData (void) const

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 💖

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 👑

so, the SoVRMLShape class holds geometry and geometry appearance nodes. (yes, it's the same sentence as NAME. it's giving consistent, and we respect that. 💅)

okay but here's the tea: this 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. so like, credit where credit is due, bestie. 🫶

Shape {
  exposedField SFNode appearance NULL
  exposedField SFNode geometry   NULL
}

so the Shape node has two fields, appearance and geometry, and they're what you use to create rendered objects in the world. ✨

  • the appearance field contains an SoVRMLAppearance node that specifies the visual attributes (e.g., material and texture) to be applied to the geometry.
  • the geometry field contains a geometry node.

the specified geometry node is rendered with the specified appearance nodes applied. so like, geometry + glow-up = rendered object. slay. 💖

if you want even more info (and honestly, who doesn't), see section 4.6.3, Shapes and geometry (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.3), and SoVRMLAppearance.

section 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14), contains details of the VRML lighting model and the interaction between Appearance nodes and geometry nodes.

⚠️ heads up bestie: if the geometry field is NULL, the object is not drawn. no geometry, no moment, no render. periodt. 💀

🌈 Member Enumeration Documentation 🌈

✨ enum SoVRMLShape::CacheEnabled ✨

Used to enumerate cache strategies. (so basically, it's the vibe check for how your stuff gets cached.)

Enumerator

  • OFF — never cache. like, absolutely not, we don't do that here. 🙈
  • ON — always cache. highkey committed. 🔥
  • AUTO — use heuristics to try to figure out the optimal caching policy. it's giving main character energy, it just knows. 👑

to be continued, bestie… 💜

💖 Member Function Documentation 💖

🌟 SoType SoVRMLShape::getTypeId(void) const [virtual] 🌟

Okay bestie, this one hands you the type identification of any object derived from a class that inherits SoBase. What's it for? run-time type checking and "downward" casting, obviously. 👑

Usage example, keep it close:

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 wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else? This method needs to be overridden in all subclasses. No skips. 🫶 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.

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 💅

Implements SoBase.

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. Simple as that. ✨

Reimplemented from SoFieldContainer.

🦋 SbBool SoVRMLShape::affectsState(void) const [virtual] 🦋

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, because it pushes and pops the state before and after traversal of its children. And all SoShape nodes will also return FALSE, since just pushing out geometry data to the rendering engine won't affect the actual rendering state. 💁‍♀️

The default method returns TRUE, on a "better safe than sorry" philosophy. Respect honestly.

Reimplemented from SoNode.

🌈 void SoVRMLShape::doAction(SoAction *action) [virtual] 🌈

This function performs the typical operation of a node for any action. That's it, that's the vibe.

Reimplemented from SoNode.

💜 void SoVRMLShape::callback(SoCallbackAction *action) [virtual] 💜

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. 🕵️‍♀️

Reimplemented from SoNode.

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

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. Go off. 🔥

Reimplemented from SoNode.

⭐ void SoVRMLShape::getBoundingBox(SoGetBoundingBoxAction *action) [virtual] ⭐

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for the node and modifies the values of the action to encompass the bounding box for this node, and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

🌸 void SoVRMLShape::rayPick(SoRayPickAction *action) [virtual] 🌸

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoNode.

🔍 void SoVRMLShape::search(SoSearchAction *action) [virtual] 🔍

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. Sorry bestie, no partial credit. 😭

See also : SoSearchAction

Reimplemented from SoNode.

✍️ void SoVRMLShape::write(SoWriteAction *action) [virtual] ✍️

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary. Periodt. 💅

Reimplemented from SoNode.

🧮 void SoVRMLShape::getPrimitiveCount(SoGetPrimitiveCountAction *action) [virtual] 🧮

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

👶 SoChildList * SoVRMLShape::getChildren(void) const [virtual] 👶

Returns the list of children for this node. Found family fr fr. 🫶

Reimplemented from SoNode.

📢 void SoVRMLShape::notify(SoNotList *l) [virtual] 📢

Notifies all auditors for this instance when changes are made. It's giving group chat announcement energy.

Reimplemented from SoNode.

📋 void SoVRMLShape::copyContents(const SoFieldContainer *from, SbBool copyconnections) [virtual] 📋

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

Heads up bestie: for copying nodes from application code, you should not invoke this function directly — rather call the SoNode::copy() function:
SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc etc)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

Reimplemented from SoNode.

💾 Member Data Documentation 💾

  • SoSFNode SoVRMLShape::appearance — Can store an SoVRMLAppearance node, or NULL. The lewk, basically. 💅
  • SoSFNode SoVRMLShape::geometry — Can store any SoVRMLGeometry subclass, or NULL. The actual shape of things. 🔷
  • SoSFEnum SoVRMLShape::renderCaching — Render caching strategy. Default value is AUTO. ✨
  • SoSFEnum SoVRMLShape::boundingBoxCaching — Bounding box caching strategy. Default value is AUTO. 📦

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. Not a human writing a diary entry, just a robot being thorough. 🤖💖

And that's a wrap on SoVRMLShape(3) from Coin Version 3.1.3, bestie — go forth and shape the world, literally. 🌈👑💅

📦 where this page comes from