SoVRMLBox(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoVRMLBox 🎀 — straight outta the Library Functions Manual, section 3

okay bestie, sit DOWN, because we're about to talk about the box. not just any box. the VRML box. the 3D one. this is the glow-up doc and honestly? it ate. 💅

✨ NAME ✨

  • SoVRMLBox — this class is the one you call when you wanna represent a 3D box. that's it, that's the job, and she does it flawlessly. 🧊

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLBox.h>

Inherits SoVRMLGeometry 💖 (so like… she got the family genes, iykyk)

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • SoVRMLBox (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

💜 Public Member Functions inherited from SoVRMLGeometry 💜

  • virtual void search (SoSearchAction *action)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🩷 Public Member Functions inherited from SoShape 🩷

  • virtual SbBool affectsState (void) const
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void callback (SoCallbackAction *action)
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const

🦄 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 void doAction (SoAction *action)
  • 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 write (SoWriteAction *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=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 SoVRMLGeometry 🫶

  • static SoType getClassTypeId (void)
  • static void initClass (void)

🍓 Static Public Member Functions inherited from SoShape 🍓

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
  • static float getDecimatedComplexity (SoState *state, float complexity)

👑 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 🌟

  • SoSFVec3f size — yeah, she's got a size field. we love a queen with dimensions. 💅

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLBox ()
  • virtual void generatePrimitives (SoAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

🧚 Protected Member Functions inherited from SoVRMLGeometry 🧚

  • SoVRMLGeometry (void)
  • virtual ~SoVRMLGeometry ()
  • void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)
  • virtual SoChildList * getChildren (void) const
  • virtual void notify (SoNotList *list)

💀 Protected Member Functions inherited from SoShape 💀

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *action)
  • void beginSolidShape (SoGLRenderAction *action)
  • void endSolidShape (SoGLRenderAction *action)
  • void GLRenderBoundingBox (SoGLRenderAction *action)
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action)
  • SbBool shouldRayPick (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v)
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
  • void shapeVertex (const SoPrimitiveVertex *const v)
  • void endShape (void)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
  • 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)
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)

🌸 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 SoVRMLGeometry 🫧

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoShape ✨

  • static const SoFieldData ** getFieldDataPtr (void)
bestie this page is long long, so it's coming at you in 2 parts, and this was part 1. don't go anywhere — more is on the way, and it's only gonna get better. 🫶

✨ Static Protected Member Functions inherited from SoNode ✨

okay bestie, before we get into the main character energy of SoVRMLBox, lemme introduce you to the static protected squad you inherit from SoNode. these are the behind-the-scenes helpers that keep the type system and action methods in check. no cap.

  • static const SoFieldData ** getFieldDataPtr (void) — grabs a pointer to the field data pointer thingy. iykyk.
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index.
  • static int getNextActionMethodIndex (void) — returns the current next action method index.
  • static void incNextActionMethodIndex (void) — bumps up the next action method index by one.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for a given nodetype and bitmask.

that's the SoNode static protected lineup, periodt. 💅

✨ Static Protected Member Functions inherited from SoBase ✨

and from SoBase, you also get these static protected cuties:

  • static uint32_t getCurrentWriteCounter (void) — returns the current write counter as a uint32_t.
  • static void staticDataLock (void) — locks the static data. 🔒
  • static void staticDataUnlock (void) — unlocks the static data. 🔓

slay. now let's get into the additional inherited members.

✨ Additional Inherited Members ✨

bestie, you're not just getting SoVRMLBox's own stuff — you're inheriting a whole wardrobe of types and attributes from its ancestors. let's do a vibe check on each.

Public Types inherited from SoShape

  • enum TriangleShape — the many shapes a triangle can take. iconic.
enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON, QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP }

Public Types inherited from SoNode

  • enum NodeType — all the node types with their hex values. the whole squad is here.
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 } — flags that tell you if a base is an engine or a group.

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — a unique ID for each node. you're one of a kind, bestie. 💖

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — a boolean that says if this field container is built-in.

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0 — the next unique ID to hand out, starting at 0.
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

that's the whole inheritance tea. now let's spill the main details.

✨ Detailed Description ✨

so what is SoVRMLBox? it's the class used for representing a 3D box. yes, literally a box. but not just any box — it's a VRML97 box. 📦

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. so you know it's legit.

here's the VRML97 definition:

Box {
  field    SFVec3f size  2 2 2        # (0, inf)
}

the Box node specifies a rectangular parallelepiped box centred at (0, 0, 0) in the local coordinate system and aligned with the local coordinate axes. by default, the box measures 2 units in each dimension, from -1 to +1. the size field specifies the extents of the box along the X-, Y-, and Z-axes respectively and each component value shall be greater than zero. Figure 6.2 illustrates the Box node. (we don't have the figure, but imagine a box. you got it. ✨)

textures are applied individually to each face of the box. on the front (+Z), back (-Z), right (+X), and left (-X) faces of the box, when viewed from the outside with the +Y-axis up, the texture is mapped onto each face with the same orientation as if the image were displayed normally in 2D. on the top face of the box (+Y), when viewed from above and looking down the Y-axis toward the origin with the -Z-axis as the view up direction, the texture is mapped onto the face with the same orientation as if the image were displayed normally in 2D. on the bottom face of the box (-Y), when viewed from below looking up the Y-axis toward the origin with the +Z-axis as the view up direction, the texture is mapped onto the face with the same orientation as if the image were displayed normally in 2D. SoVRMLTextureTransform affects the texture coordinates of the Box. the Box node's geometry requires outside faces only. when viewed from the inside the results are undefined. 👀 so don't go inside, bestie. it's not a vibe.

✨ Constructor & Destructor Documentation ✨

SoVRMLBox::SoVRMLBox (void )

constructor. it builds the box. references size, and SoVRMLBox(). referenced by getFieldData(), and SoVRMLBox(). so meta, right? 🔄

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

destructor. it's protected and virtual. it cleans up the box. bye bye box. 😭

✨ Member Function Documentation ✨

SoType SoVRMLBox::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. so you can safely cast like a boss. 💅

usage example:

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

for application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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.

for more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

reimplemented from SoVRMLGeometry.

const SoFieldData * SoVRMLBox::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. reimplemented from SoVRMLGeometry. references SoVRMLBox().

void SoVRMLBox::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. reimplemented from SoShape. references SoAction::getState(), SoVRMLGeometry::shouldGLRender(), and size.

void SoVRMLBox::rayPick (SoRayPickAction * action) [virtual]

calculates picked point based on primitives generated by subclasses. reimplemented from SoShape. references SoShape::shouldRayPick(), and size.

void SoVRMLBox::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 SoShape. references SoGetPrimitiveCountAction::addNumTriangles(), and SoShape::shouldPrimitiveCount().

void SoVRMLBox::generatePrimitives (SoAction * action) [protected], [virtual]

the method implements action behavior for shape nodes for SoCallbackAction. it is invoked from SoShape::callback(). (subclasses should not override SoNode::callback().) the subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller. implements SoShape. references size.

void SoVRMLBox::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected], [virtual]

implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box. the bounding box and center point should be calculated and returned in the local coordinate system. the method implements action behavior for shape nodes for SoGetBoundingBoxAction. it is invoked from SoShape::getBoundingBox(). (subclasses should not override SoNode::getBoundingBox().) the box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. implements SoShape. references SbBox3f::setBounds(), SbVec3f::setValue(), and size.

✨ Member Data Documentation ✨

  • SoSFVec3f SoVRMLBox::size — box size vector. default value is (2,2,2). referenced by computeBBox(), generatePrimitives(), GLRender(), rayPick(), and SoVRMLBox(). this is the main character field, bestie. it controls how big your box is. 📏

✨ Author ✨

generated automatically by Doxygen for Coin from the source code. so you know it's official. 🤖

and that's the tea, bestie! this page was brought to you by Coin, version 2.5.0. the man page is SoVRMLBox(3). now go forth and box it up. 🎀✨💖

📦 where this page comes from