SoSphere(3)

📦 version 2.5.0, in fedora 43, fedora 44

🦋 SoSphere(3) 🦋

okay so bestie, welcome to the Library Functions Manual, section 3, and today we're hyperfixating on SoSphere(3). she's tiny, she's round, she's iconic, and honestly? she's just here to do one job and she does it flawlessly. 💅

🌸 NAME 🌸

SoSphere — the SoSphere class is for rendering sphere shapes. that's the whole assignment. spheres. rendered. slay. 🔥

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoSphere.h>

Inherits SoShape.

so yeah, she's a SoShape girlie. everything below is the full family tree, no gatekeeping, no cap. 🌈

💖 Public Member Functions

virtual SoType getTypeId (void) const
SoSphere (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 radius

okay so radius is the moment. the main character attribute fr fr. 🍓

💅 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoSphere ()
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

and finally, the bonus content, because this family tree just keeps giving:

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 🫶

Bestie, before we even get to the sphere itself, here's the inherited enum tea from SoNode. No cap, these are the exact values:

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 🦋

Another little enum moment, this time 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 = 0
  • static int nextActionMethodIndex = 0

Detailed Description 💅

Okay so the SoSphere class is literally for rendering sphere shapes.

She renders a sphere with the size given by the SoSphere::radius field. The sphere is rendered with the current material, texture and drawstyle settings (if any, otherwise the default settings are used).

The SoSphere node class is provided as a convenient abstraction for the application programmer to use "complex" shapes of this type without having to do the tessellation to polygons and other low-level programming herself. Periodt.

A good trick for rendering ellipsoidal 3D shapes is to use an SoSphere prefixed with an SoScale transformation to "flatten" it along one or more of the principal axes. (Ie use for instance an SoScale node with SoScale::scaleFactor equal to [1, 1, 0.1] to flatten it along the Z direction.)

A sphere is visualized by the underlying rendering system by first tessellating the conceptual sphere into a set of polygons. To control the trade-off between an as much as possible correct visual appearance of the sphere versus fast rendering, use an SoComplexity node to influence the number of polygons generated from the tessellation process. (The higher the complexity value, the more polygons will be generated, the more rounded the sphere will look.) Set the SoComplexity::value field to what you believe would be a good trade-off between correctness and speed for your particular application.

FILE FORMAT/DEFAULTS 🎀

Sphere {
    radius 1
}

See also 🌈

SoCone, SoCylinder, SoCube

Constructor & Destructor Documentation 🛠️

SoSphere::SoSphere (void ) 💖

Constructor. References radius, and SoSphere(). Referenced by getFieldData(), and SoSphere().

SoSphere::~SoSphere () [protected], [virtual] 💀

Destructor. That's it, she's done.

Member Function Documentation 👑

SoType SoSphere::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.

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

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

References SoSphere().

void SoSphere::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 SoShape::getComplexityValue(), SoAction::getState(), radius, and SoShape::shouldGLRender().

void SoSphere::rayPick (SoRayPickAction * action) [virtual] 🎯

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

References radius, and SoShape::shouldRayPick().

void SoSphere::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(), SoShape::getComplexityValue(), and SoShape::shouldPrimitiveCount().

void SoSphere::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 SoShape::getComplexityValue(), and radius.

void SoSphere::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 radius, SbBox3f::setBounds(), and SbVec3f::setValue().

Member Data Documentation 🧚

SoSFFloat SoSphere::radius 🎀

Radius of sphere. Default value is 1.0.

Referenced by computeBBox(), generatePrimitives(), GLRender(), rayPick(), and SoSphere().

Author 📝

Generated automatically by Doxygen for Coin from the source code.

This page was served fresh by Coin, version 2.5.0, for SoSphere(3) — mwah 💋

📦 where this page comes from