SoCube(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SoCube — The SoCube class is for rendering cubes. That's the whole serve, bestie. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoCube.h>

Inherits SoShape.

💖 Public Member Functions 💖

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

🌸 Public Member Functions inherited from SoShape 🌸

virtual SbBool affectsState (void) const
virtual void notify (SoNotList *nl)
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 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)
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 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 👑

SoSFFloat width
SoSFFloat height
SoSFFloat depth

🛡️ Protected Member Functions 🛡️

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

🛡️ Protected Member Functions inherited from SoShape 🛡️

SoShape (void)
virtual ~SoShape ()
float getComplexityValue (SoAction *action)
virtual SbBool shouldGLRender (SoGLRenderAction *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 SoShape 🔒

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 SoShape 💖

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

💖 Public Types inherited from SoNode

Okay bestie, before we get into the cube itself, SoCube inherits some stuff from its parent classes. Here's the tea on SoNode's public types:

       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
           }

That's a whole lotta enum values, but they're all there, no cap.

🎀 Protected Types inherited from SoBase

And from SoBase, we get these protected types:

       enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Short and sweet.

🧸 Protected Attributes inherited from SoNode

From SoNode, there's a protected attribute:

uint32_t uniqueId

🍓 Protected Attributes inherited from SoFieldContainer

From SoFieldContainer, we get:

SbBool isBuiltIn

✨ Static Protected Attributes inherited from SoNode

And from SoNode, some static protected attributes:

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

🌸 Detailed Description

SoCube is literally the class that renders cubes for you. 🧊

Drop a cube shape into your scenegraph, and it gets rendered using whatever material, texture, and drawstyle settings are active at that moment. If there aren't any, the default settings step in. 💅

(Okay, technically, because you can set different width, height, and depth values, what you're really making is a box. But the class name said cube, so here we are. 🤷‍♀️)

The SoCube node is basically a shortcut for programmers who want to use these "complex" shapes without doing all the math and polygon-side bookkeeping themselves. You're welcome. ✨

FILE FORMAT/DEFAULTS:

       Cube {
           width 2
           height 2
           depth 2
       }

👀 See also

SoCylinder, SoSphere, SoCone

💅 Constructor & Destructor Documentation

SoCube::SoCube (void )

The constructor. Does constructor things. 🛠️

References depth, height, SoCube(), and width.

Referenced by getFieldData(), and SoCube().

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

The destructor. Cleanup time. 🧹

🔥 Member Function Documentation

SoType SoCube::getTypeId (void ) const [virtual]

This returns the type ID for any object derived from SoBase. It's what you use for run-time type checking and "downward" casting. 🔍

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

If you're extending Coin with new nodes, engines, nodekits, draggers, or whatever, you gotta override this method in every subclass. Usually you do that while setting up the full type system, using the macros from places like 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 deets on writing Coin extensions? Check the class docs for the toplevel superclasses of the various class groups. 👀

Reimplemented from SoShape.

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

Hands you a pointer to the class-wide field data storage for this instance. If there are no fields, you get NULL. 🫙

Reimplemented from SoShape.

References SoCube().

void SoCube::GLRender (SoGLRenderAction * action) [virtual]

This is the action method for SoGLRenderAction. 🎬

It gets called during rendering traversals. If your node messes with rendering state or wants to yeet geometry primitives at OpenGL, you override this. 💥

Reimplemented from SoShape.

References depth, SoAction::getState(), height, SoShape::shouldGLRender(), and width.

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

Figures out the picked point based on the primitives your subclasses generate. 🎯

Reimplemented from SoShape.

References SoAction::getState(), SoShape::shouldRayPick(), and width.

void SoCube::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for SoGetPrimitiveCountAction. 📊

It counts up the triangle, line segment, and point primitives for this node and adds them to the action's counters. 🔢

If your node changes how geometry nodes calculate their primitive count, you override this too to tweak the relevant state variables. 🎛️

Reimplemented from SoShape.

References SoGetPrimitiveCountAction::addNumTriangles(), and SoShape::shouldPrimitiveCount().

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

This method implements the action behavior for shape nodes when you're using SoCallbackAction. It gets called from SoShape::callback(). (And no, subclasses should not override SoNode::callback().) 🚫

Your subclass implementation should use the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), along with SoDetail instances, to send the shape's primitives back to whoever called. 📦

Implements SoShape.

References SoAction::getState(), and width.

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

SoShape subclasses implement this to tell the SoShape superclass the exact size and weighted center of the shape's bounding box. 📐

Calculate and return the bounding box and center in the local coordinate system. 🗺️

This method handles action behavior for shape nodes during SoGetBoundingBoxAction. It gets called from SoShape::getBoundingBox(). (Again, don't override SoNode::getBoundingBox() in subclasses.) 🙅‍♀️

The box parameter you get is guaranteed to be an empty box, and center is undefined when the function starts. 📦

Implements SoShape.

References SbBox3f::setBounds(), and SbVec3f::setValue().

👑 Member Data Documentation

SoSFFloat SoCube::width

The X axis dimension of the cube. Defaults to 2.0. ↔️

Referenced by generatePrimitives(), GLRender(), rayPick(), and SoCube().

SoSFFloat SoCube::height

The Y axis dimension of the cube. Defaults to 2.0. ↕️

Referenced by GLRender(), and SoCube().

SoSFFloat SoCube::depth

The Z axis dimension of the cube. Defaults to 2.0. ↖️↘️

Referenced by GLRender(), and SoCube().

🦋 Author

This page was auto-generated by Doxygen for Coin, straight from the source code. 🤖

And that's a wrap, bestie! This page was brought to you by Coin version 2.5.0, the SoCube(3) manual page, generated by Doxygen straight from the source code. Stay iconic! 💅✨

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms