SoVRMLShape(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoVRMLShape(3) 💖

Coin manual page, bestie. This is the one and only SoVRMLShape — the class that holds geometry and geometry appearance nodes. It inherits SoNode, and it's giving main character energy in your VRML scenes. ✨

✨ NAME ✨

SoVRMLShape — The SoVRMLShape class holds geometry and geometry appearance nodes.

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLShape.h>

Inherits SoNode.

🌸 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, COIN_4_0 = 0x20000 }

💅 Public Member Functions 💅

Here's the squad of virtuals this class brings to the function, no cap:

  • 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)
  • SbUniqueId 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 — Returns TRUE if this object's type is either the same as type or inherits from type.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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
  • virtual SoNotRec createNotRec (void)

🔒 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 🧬

  • SbUniqueId uniqueId

🧬 Protected Attributes inherited from SoFieldContainer 🧬

  • SbBool isBuiltIn

🧬 Static Protected Attributes inherited from SoNode 🧬

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

📖 Detailed Description 📖

Okay so SoVRMLShape is literally the class that holds geometry and geometry appearance nodes. No cap.

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:

Shape {
  exposedField SFNode appearance NULL
  exposedField SFNode geometry   NULL
}

The Shape node has two fields, appearance and geometry, which are used 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. See 4.6.3, Shapes and geometry (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.3), and SoVRMLAppearance, for more information.

4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14), contains details of the VRML lighting model and the interaction between Appearance nodes and geometry nodes. If the geometry field is NULL, the object is not drawn. Periodt.

✨ Member Enumeration Documentation ✨

🌈 enum SoVRMLShape::CacheEnabled

Okay so this one is literally just a lil menu of caching strategies, bestie. That's it, that's the whole job. 💅

Enumerators

  • OFF — Never cache. Like, zero caching, none, we don't do that here. 🙈
  • ON — Always cache. Ride or die, cache everything. 🔥
  • AUTO — Use heuristics to try to figure out the optimal caching policy. She's guessing, but she's guessing smart. 👑

💖 Member Function Documentation 💖

⭐ SoType SoVRMLShape::getClassTypeId(void) [static]

This static method returns the SoType object associated with objects of this class. Static queen behavior, honestly. 👑

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. iykyk — it's the "wait, what are you actually" check. 💀

Reimplemented from SoBase.

🎀 const SoFieldData ** SoVRMLShape::getFieldDataPtr(void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like... not for you, bestie, it's giving backstage pass energy. 🚫

Returns the SoFieldData class which holds information about fields in this node.

🌸 const SoFieldData * SoVRMLShape::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. (And yes, NULL, not vibes. 🌚)

Reimplemented from SoFieldContainer.

✨ void SoVRMLShape::initClass(void) [static]

(No notes attached to this one, she just does her thing. Slay. 💅)

👑 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, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as 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. Not me being paranoid but also correct. 😌

Reimplemented from SoNode.

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

This function performs the typical operation of a node for any action. The all-rounder, the main character, the "I got this" of methods. 🌟

Reimplemented from SoNode.

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

Action method for SoCallbackAction.

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. Sneaky lil info grab, we love her. 🕵️‍♀️

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 want to throw geometry primitives at OpenGL override this method. Throwing geometry at OpenGL, as one does. 🎨

Reimplemented from SoNode.

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

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for 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 calculate their bounding box also override 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. Basically: is the ray hitting you or not, be honest. 📍

Nodes influencing relevant state variables for how picking is done also override 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. All-or-nothing, no partial credit, periodt. 💅

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. Putting it all down on paper, iconic pen game. ✍️

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. Math girlies rise. 🔢

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

Reimplemented from SoNode.

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

Returns list of children for this node. The whole fam. 👨‍👩‍👧‍👦

Reimplemented from SoNode.

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

Notifies all auditors for this instance when changes are made. Gossip network but make it architecture. 📣

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 scene graph references if copyconnections is FALSE.

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

For copying nodes from application code, you should not invoke this function directly — call the SoNode::copy() function instead, bestie, I'm begging. 🙏
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 its 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.)
  SoNode::copyContents(from, copyconnections);

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

Reimplemented from SoNode.

🎀 Member Data Documentation 🎀

💅 SoSFNode SoVRMLShape::appearance

Can store an SoVRMLAppearance node, or NULL. Dress her up or leave her bare, your call. 👗

💜 SoSFNode SoVRMLShape::geometry

Can store any SoVRMLGeometry subclass, or NULL. The actual shape of the situation, literally. 📐

🌟 SoSFEnum SoVRMLShape::renderCaching

Render caching strategy. Default value is AUTO. She's not committing, she's reading the room. ✨

🌈 SoSFEnum SoVRMLShape::boundingBoxCaching

Bounding box caching strategy. Default value is AUTO. Same energy, different department. 📦

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (No human wrote this, she generated herself, main character origin story. 😌)

And that's a wrap on this page, bestie 💖 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, filed under SoVRMLShape(3). Go forth and cache responsibly. 🫶✨

📦 where this page comes from