SoVRMLGeometry(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 NAME 🎀

SoVRMLGeometry — bestie, this is the superclass for VRML shapes. That's the whole job description. She doesn't do the drawing herself, she's the blueprint the other shape classes are built on top of. Mother of shapes, basically. 👑

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLGeometry.h>

Inherits SoShape. — so she's got a whole ancestry situation going on, we love a lineage 💖

Inherited by SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLSphere, SoVRMLText, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape. — okay so literally the entire shape squad descended from her, the way that she's the moment and the legacy 🌈✨

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const — hers, declared right here in her own class 💅
  • virtual void search (SoSearchAction *action) — also hers, no borrowing needed 🔍
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn) — hers too, she does her own copying 🫶

🌸 Public Member Functions inherited from SoShape 🌸

  • virtual SbBool affectsState (void) const — handed down from SoShape 🧚
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — from SoShape 📦
  • virtual void GLRender (SoGLRenderAction *action) — from SoShape 🎨
  • virtual void rayPick (SoRayPickAction *action) — from SoShape 🎯
  • virtual void callback (SoCallbackAction *action) — from SoShape 📞
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0 — from SoShape (and yes bestie, that =0 means it's pure virtual, the subclasses have to bring their own) 💀
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — from SoShape 🔢
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const — from SoShape 🗂️

💜 Public Member Functions inherited from SoNode 💜

  • void setOverride (const SbBool state) — from SoNode 👑
  • SbBool isOverride (void) const — from SoNode 👑
  • void setNodeType (const NodeType type) — from SoNode 🏷️
  • NodeType getNodeType (void) const — from SoNode 🏷️
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — from SoNode 📋
  • virtual void doAction (SoAction *action) — from SoNode ⚡
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — from SoNode 🎨
  • virtual void GLRenderInPath (SoGLRenderAction *action) — from SoNode 🎨
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — from SoNode 🎨
  • virtual void getMatrix (SoGetMatrixAction *action) — from SoNode 📐
  • virtual void handleEvent (SoHandleEventAction *action) — from SoNode 🖱️
  • virtual void pick (SoPickAction *action) — from SoNode 🎯
  • virtual void write (SoWriteAction *action) — from SoNode ✍️
  • virtual void audioRender (SoAudioRenderAction *action) — from SoNode 🔊
  • virtual void grabEventsSetup (void) — from SoNode ✊
  • virtual void grabEventsCleanup (void) — from SoNode 🧹
  • virtual void startNotify (void) — from SoNode 🔔
  • uint32_t getNodeId (void) const — from SoNode 🆔
  • virtual void writeInstance (SoOutput *out) — from SoNode ✍️
  • virtual SoNode * addToCopyDict (void) const — from SoNode 📚
  • virtual SoFieldContainer * copyThroughConnection (void) const — from SoNode 🔗

🦋 Public Member Functions inherited from SoFieldContainer 🦋

  • void setToDefaults (void) — from SoFieldContainer 🧼
  • SbBool hasDefaultValues (void) const — from SoFieldContainer ✅
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — from SoFieldContainer 🟰
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — from SoFieldContainer 📋
  • SbBool set (const char *const fielddata) — from SoFieldContainer 📥
  • void get (SbString &fielddata) — from SoFieldContainer 📤
  • virtual int getFields (SoFieldList &l) const — from SoFieldContainer 📃
  • virtual int getAllFields (SoFieldList &l) const — from SoFieldContainer 📃
  • virtual SoField * getField (const SbName &name) const — from SoFieldContainer 🔎
  • virtual SoField * getEventIn (const SbName &name) const — from SoFieldContainer ⬅️
  • virtual SoField * getEventOut (const SbName &name) const — from SoFieldContainer ➡️
  • SbBool getFieldName (const SoField *const field, SbName &name) const — from SoFieldContainer 🏷️
  • SbBool enableNotify (const SbBool flag) — from SoFieldContainer 🔔
  • SbBool isNotifyEnabled (void) const — from SoFieldContainer 🔔
  • SbBool set (const char *fielddata, SoInput *input) — from SoFieldContainer 📥
  • void get (SbString &fielddata, SoOutput *out) — from SoFieldContainer 📤
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — from SoFieldContainer 🧪
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — from SoFieldContainer ✍️
  • SbBool getIsBuiltIn (void) const — from SoFieldContainer 🏠
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — from SoFieldContainer 🧮
  • void setUserData (void *userdata) const — from SoFieldContainer 🎒
  • void * getUserData (void) const — from SoFieldContainer 🎒

⭐ Public Member Functions inherited from SoBase ⭐

  • void ref (void) const — from SoBase 🔗
  • void unref (void) const — from SoBase ✂️
  • void unrefNoDelete (void) const — from SoBase ✂️
  • int32_t getRefCount (void) const — from SoBase 🔢
  • void touch (void) — from SoBase 👆
  • SbBool isOfType (SoType type) const — from SoBase 🧬
  • virtual SbName getName (void) const — from SoBase 🏷️
  • virtual void setName (const SbName &newname) — from SoBase ✏️
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — from SoBase 👀
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — from SoBase 👋
  • const SoAuditorList & getAuditors (void) const — from SoBase 📋
  • SbBool shouldWrite (void) — from SoBase ✍️
  • void assertAlive (void) const — from SoBase 💀

🫶 Static Public Member Functions 🫶

  • static SoType getClassTypeId (void) — her very own static, right here 💖
  • static void initClass (void) — hers, she runs her own setup ✨

🌈 Static Public Member Functions inherited from SoShape 🌈

  • static SoType getClassTypeId (void) — from SoShape 🧬
  • static void initClass (void) — from SoShape ✨
  • static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize) — from SoShape 📏
  • static float getDecimatedComplexity (SoState *state, float complexity) — from SoShape 📉
  • static const SoFieldData ** getFieldDataPtr (void) — wait no bestie, hold that thought, that one's a protected static, she's coming up later 👀

🌟 Static Public Member Functions inherited from SoNode 🌟

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — from SoNode 🧬
  • static SoType getClassTypeId (void) — from SoNode 🧬
  • static SoNode * getByName (const SbName &name) — from SoNode 🔎
  • static int getByName (const SbName &name, SoNodeList &l) — from SoNode 🔎
  • static void initClass (void) — from SoNode ✨
  • static void initClasses (void) — from SoNode ✨
  • static uint32_t getNextNodeId (void) — from SoNode 🆔
  • static int getActionMethodIndex (const SoType type) — from SoNode 🔢
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — from SoNode 📦
  • static void GLRenderS (SoAction *action, SoNode *node) — from SoNode 🎨
  • static void callbackS (SoAction *action, SoNode *node) — from SoNode 📞
  • static void getMatrixS (SoAction *action, SoNode *node) — from SoNode 📐
  • static void handleEventS (SoAction *action, SoNode *node) — from SoNode 🖱️
  • static void pickS (SoAction *action, SoNode *node) — from SoNode 🎯
  • static void rayPickS (SoAction *action, SoNode *node) — from SoNode 🎯
  • static void searchS (SoAction *action, SoNode *node) — from SoNode 🔍
  • static void writeS (SoAction *action, SoNode *node) — from SoNode ✍️
  • static void audioRenderS (SoAction *action, SoNode *node) — from SoNode 🔊
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — from SoNode 🔢

💫 Static Public Member Functions inherited from SoFieldContainer 💫

  • static void initClass (void) — from SoFieldContainer ✨
  • static SoType getClassTypeId (void) — from SoFieldContainer 🧬
  • static void cleanupClass (void) — from SoFieldContainer 🧹
  • static void initCopyDict (void) — from SoFieldContainer 📚
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — from SoFieldContainer 📋
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — from SoFieldContainer ✅
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — from SoFieldContainer 🔎
  • static void copyDone (void) — from SoFieldContainer 🏁

🌸 Static Public Member Functions inherited from SoBase 🌸

  • static void initClass (void) — from SoBase ✨
  • static SoType getClassTypeId (void) — from SoBase 🧬
  • static void addName (SoBase *const base, const char *const name) — from SoBase 🏷️
  • static void removeName (SoBase *const base, const char *const name) — from SoBase 🏷️
  • static void incrementCurrentWriteCounter (void) — from SoBase ➕
  • static void decrementCurrentWriteCounter (void) — from SoBase ➖
  • static SoBase * getNamedBase (const SbName &name, SoType type) — from SoBase 🔎
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — from SoBase 🔎
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — from SoBase 📖
  • static void setInstancePrefix (const SbString &c) — from SoBase 🔤
  • static void setTraceRefs (SbBool trace) — from SoBase 🐛
  • static SbBool getTraceRefs (void) — from SoBase 🐛
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — from SoBase 🔗
  • static SbBool readRoute (SoInput *input) — from SoBase 📖

🙈 Protected Member Functions 🙈

these are the ones only her and her subclasses get to touch, like the group chat nobody else is in 💅

  • virtual const SoFieldData * getFieldData (void) const — hers 📃
  • SoVRMLGeometry (void) — her constructor, she's right here 🍼
  • virtual ~SoVRMLGeometry () — and her destructor 🪦
  • void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid) — hers 🛠️
  • virtual SbBool shouldGLRender (SoGLRenderAction *action) — hers 🎨
  • virtual SoChildList * getChildren (void) const — hers 👶
  • virtual void notify (SoNotList *list) — hers 🔔

🧚 Protected Member Functions inherited from SoShape 🧚

  • SoShape (void) — from SoShape 🍼
  • virtual ~SoShape () — from SoShape 🪦
  • float getComplexityValue (SoAction *action) — from SoShape 📉
  • virtual void generatePrimitives (SoAction *action)=0 — from SoShape (another pure virtual, =0 and all, subclasses you know what to do) 💀
  • void beginSolidShape (SoGLRenderAction *action) — from SoShape 🧱
  • void endSolidShape (SoGLRenderAction *action) — from SoShape 🧱
  • void GLRenderBoundingBox (SoGLRenderAction *action) — from SoShape 📦
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action) — from SoShape 🔢
  • SbBool shouldRayPick (SoRayPickAction *const action) — from SoShape 🎯
  • void computeObjectSpaceRay (SoRayPickAction *const action) — from SoShape 🎯
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix) — from SoShape 🎯
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp) — from SoShape 🔺
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) — from SoShape 📏
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp) — from SoShape 📍
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) — from SoShape 📞
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) — from SoShape 📞
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v) — from SoShape 📞
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL) — from SoShape ▶️
  • void shapeVertex (const SoPrimitiveVertex *const v) — from SoShape 🔹
  • void endShape (void) — from SoShape ⏹️
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal) — from SoShape 🔹
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal) — from SoShape (yep, there's an extra const float r on this one, not a typo, two whole overloads) 🔹
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex) — from SoShape 🧮
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex) — from SoShape 🧮

🎀 Protected Member Functions inherited from SoNode 🎀

  • SoNode (void) — from SoNode 🍼
  • virtual ~SoNode () — from SoNode 🪦
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — from SoNode 📖

💜 Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void) — from SoFieldContainer 🍼
  • virtual ~SoFieldContainer () — from SoFieldContainer 🪦

🍓 Protected Member Functions inherited from SoBase 🍓

  • SoBase (void) — from SoBase 🍼
  • virtual ~SoBase () — from SoBase 🪦
  • virtual void destroy (void) — from SoBase 💥
  • SbBool hasMultipleWriteRefs (void) const — from SoBase 🔗
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — from SoBase ✍️
  • void writeFooter (SoOutput *out) const — from SoBase ✍️
  • virtual const char * getFileFormatName (void) const — from SoBase 📄

🌟 Static Protected Member Functions 🌟

  • static const SoFieldData ** getFieldDataPtr (void) — her own static protected one, here she is, told you she'd show up 💅

🧁 Static Protected Member Functions inherited from SoShape 🧁

  • static const SoFieldData ** getFieldDataPtr (void) — from SoShape 📃

🦄 Static Protected Member Functions inherited from SoNode 🦄

  • static const SoFieldData ** getFieldDataPtr (void) — from SoNode 📃
  • static void setNextActionMethodIndex (int index) — from SoNode 🔢
  • static int getNextActionMethodIndex (void) — from SoNode 🔢
  • static void incNextActionMethodIndex (void) — from SoNode ➕
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — from SoNode 🧬

and bestie, that's only the top half of this page 💅 the rest is literally still loading, keep scrolling 🌈

Static Protected Member Functions inherited from SoBase 💫

  • static uint32_t getCurrentWriteCounter (void) — hands you the current write counter, no cap.
  • static void staticDataLock (void) — locks the static data, bestie. gatekeeping the globals fr.
  • static void staticDataUnlock (void) — and this one unlocks it again. balance ✨

Additional Inherited Members 🎀

Public Types inherited from SoShape

enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
    QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP }

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 so SoVRMLGeometry is the superclass for all the VRML shapes. It's giving founding mother of the whole VRML geometry fam. 💅 Every VRML shape you know and love traces back to her.

Constructor & Destructor Documentation 🧚

SoVRMLGeometry::SoVRMLGeometry (void ) [protected]

Constructor. yeah that's it, she just exists. iconic of her. ✨

SoVRMLGeometry::~SoVRMLGeometry () [protected], [virtual]

Destructor. the farewell arc 😭 virtual, so she cleans up right for the whole bloodline.

Member Function Documentation 🦋

SoType SoVRMLGeometry::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. iykyk — it's literally how Coin figures out what you are at runtime.

Usage example, keep it exact bestie:

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

Now for all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method needs to be overridden in all subclasses. that's not a suggestion, that's the assignment. 💀 It's 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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 🫶

Reimplemented from SoShape.

Reimplemented in SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedFaceSet, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLPointSet, SoVRMLSphere, SoVRMLText, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape. look at the whole squad showing up. 👑

const SoFieldData * SoVRMLGeometry::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. no fields, no pointer, we move on. ✨

Reimplemented from SoShape.

Reimplemented in SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedFaceSet, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLPointSet, SoVRMLSphere, SoVRMLText, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

void SoVRMLGeometry::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. it's giving ✨strict✨, one wrong detail and the whole vibe check fails.

See also: SoSearchAction

Reimplemented from SoNode.

void SoVRMLGeometry::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. the deepest of copies, no half measures. 💅

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.

For copying nodes from application code, you should not invoke this function directly, but 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. skip the parent call and things get weird, and not in a cute way. 💀

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.

void SoVRMLGeometry::setupShapeHints (SoState * state, const SbBool ccw, const SbBool solid) [protected]

Convenience method that updates the shape hints element. lil helper doing the most behind the scenes. 🎀

SbBool SoVRMLGeometry::shouldGLRender (SoGLRenderAction * action) [protected], [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. aka: not for you bestie, it's giving staff-only door. 🙈

Reimplemented from SoShape.

Reimplemented in SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

SoChildList * SoVRMLGeometry::getChildren (void ) const [protected], [virtual]

Returns list of children for this node. the family tree, literally. 🌸

Reimplemented from SoNode.

Reimplemented in SoVRMLText.

void SoVRMLGeometry::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made. gossip girl behavior and honestly? we respect it. 📣

Reimplemented from SoShape.

Reimplemented in SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLText, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

Author 🌈

Generated automatically by Doxygen for Coin from the source code. not me being auto-generated and still having main character energy 💅

okay that's the whole page bestie, we ate and left no crumbs ✨ this was Coin, Version 3.1.3, and the page is dated SoVRMLGeometry(3) — ily, go make something pretty 🫶💖

📦 where this page comes from