SoCube(3)

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

💖 SoCube(3) — Coin 💖

okay so hi bestie 🫶 you've landed on the SoCube page from the Coin manual — yes, the SoCube(3) one, third section and everything. if you're here it's probably because you want a literal cube in your scene graph, and honestly? valid. no cap.

✨ NAME ✨

SoCube — the SoCube class is for rendering cubes. that's the whole assignment. a cube. iconic behavior. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoCube.h>

and it inherits from SoShape, so it's a shape through and through, main character energy, born for this. ✨

💅 Public Member Functions

🎀 SoCube's own little flexes

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

that's the whole homegrown set right there — a type id, a constructor, a render, a ray pick, and a primitive count. short list, big impact. 😌

🌈 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

🦋 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 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)
SbUniqueId 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

look at that list. it's giving "everything a node could possibly need to do". 😭

💜 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

🍓 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
quick spotlight on isOfType bestie: it returns TRUE if the type of this object is either of the same type or inherited from type. so yeah, it's the "are we fam?" check. 🫶

👑 Static Public Member Functions

💫 SoCube's own

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

✨ 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)
initClass() sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's the "get everybody registered" moment. 📋

🌟 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 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)
that initClass() up there? same deal — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖

🎀 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)
initClass() — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
getClassTypeId() — this static method returns the SoType object associated with objects of this class. the little name tag for the whole class. 🏷️

🦋 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)
initClass() — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
getClassTypeId() — this static method returns the SoType object associated with objects of this class.

💎 Public Attributes

SoSFFloat width
SoSFFloat height
SoSFFloat depth

the three numbers that make a cube a cube and not, like, a sad flat square. width, height, depth, slay. 🌈

🧚 Protected Member Functions

🫧 SoCube's own

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

💜 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 SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *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)
two generateVertex overloads, bestie. s, t… and then s, t, r. they really said "why not both". 🙈

💅 inherited from SoNode

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🌸 inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~SoFieldContainer ()
and that's where part 1 wraps — part 2 has the rest, don't go anywhere 💖

💖 Protected Member Functions inherited from SoBase

  • SoBase(void) — the base constructor, just doing its little base-class thing.
  • virtual ~SoBase() — virtual destructor, so everything cleans up properly when it's time to go.
  • virtual void destroy(void) — the destroy hook.
  • SbBool hasMultipleWriteRefs(void) const — checks whether there's more than one write reference, fr fr.
  • SbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out.
  • void writeFooter(SoOutput *out) const — and this one writes the footer. cute.
  • virtual const char * getFileFormatName(void) const — returns the file format name.
  • virtual SoNotRec createNotRec(void) — makes a notification record.

✨ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr(void) — grabs the pointer to the field data.

🌸 Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr(void) — same energy, inherited from SoShape.

🦋 Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr(void) — and again, this time from SoNode.
  • static void setNextActionMethodIndex(int index) — sets the next action method index.
  • static int getNextActionMethodIndex(void) — gets the next action method index.
  • static void incNextActionMethodIndex(void) — bumps the next action method index up by one.
  • static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types for a node type with a bitmask.

🎀 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter(void) — returns the current write counter.
  • static void staticDataLock(void) — locks the static data.
  • static void staticDataUnlock(void) — 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, COIN_4_0 = 0x20000 }

🍓 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

The SoCube class is for rendering cubes. periodt.

Drop a cube shape into your scene graph and you're set. The cube gets rendered with whatever the current material, texture and draw style settings are — and if there aren't any, bestie, it just uses the defaults. easy.

(Strictly speaking, since you can have different width, height and depth values for your "cube", instances of this class are actually representing boxes. not me exposing the truth 🙈)

The SoCube node class is there as a convenient abstraction so you, the application programmer, can use "complex" shapes of this type without having to do all the calculation and book-keeping of the polygon sides and other low level programming yourself. we love not doing math 💅

FILE FORMAT/DEFAULTS:

Cube {
    width 2
    height 2
    depth 2
}

👀 See also

SoCylinder, SoSphere, SoCone

🎀 Constructor & Destructor Documentation

💜 SoCube::SoCube(void )

Constructor. it's giving new cube.

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

Destructor.

🌸 Member Function Documentation

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

This static method returns the SoType object associated with objects of this class.

⭐ SoType SoCube::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.

Reimplemented from SoShape.

⭐ const SoFieldData ** SoCube::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.

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

⭐ const SoFieldData * SoCube::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 SoShape.

⭐ void SoCube::initClass(void ) [static]

(no description, she's just out here initializing the class 🤷)

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

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way, or that want to throw geometry primitives at OpenGL, override this method.

Reimplemented from SoShape.

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

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

⭐ void SoCube::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 calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoShape.

⭐ void SoCube::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 use 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.

⭐ void SoCube::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.

🦋 Member Data Documentation

🌟 SoSFFloat SoCube::width

X-axis dimension of cube, defaults to 2.0.

🌟 SoSFFloat SoCube::height

Y-axis dimension of cube, defaults to 2.0.

🌟 SoSFFloat SoCube::depth

Z-axis dimension of cube, defaults to 2.0.

💅 Author

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, we ate 🫶✨ this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives at SoCube(3). iconic. go build some cubes 💖🎀🦋

📦 where this page comes from