SoCone(3)

📦 version 2.5.0, in fedora 43, fedora 44

hiii bestie 💖 okay so you just opened SoCone(3) from the Library Functions Manual and honestly? taste. this is the whole entire scoop on the SoCone class — the little guy whose whole job is rendering cone shapes 🍦✨ no skips, no "etc", we're doing every single line because you deserve the full tea.

✨ NAME ✨

SoCone — the SoCone class is for rendering cone shapes. that's it, that's the whole personality and we love her for it 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoCone.h>

Inherits SoShape — yes queen, she comes from a whole family tree, the lineage is giving royalty 👑

🎀 Public Types 🎀

the one enum that's hers and hers alone:

enum Part { SIDES = 0x01, BOTTOM = 0x02, ALL = (SIDES|BOTTOM) }

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

look at all those hex numbers, it's giving ✨aesthetic✨ hex dump, iykyk 💅

💅 Public Member Functions 💅

the main character's own moves:

  • virtual SoType getTypeId (void) const — tells you who she is, type-wise 🔍
  • SoCone (void) — the constructor, aka her grand entrance 🎬
  • void addPart (SoCone::Part part) — add a Part in 🫶
  • void removePart (SoCone::Part part) — take a Part out, bye girl 👋
  • SbBool hasPart (SoCone::Part part) const — does she have that Part? yes/no bestie 🤔
  • virtual void GLRender (SoGLRenderAction *action) — the actual render moment, her time to shine ✨
  • virtual void rayPick (SoRayPickAction *action) — ray picking, very targeted energy 🎯
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives fr fr 🔢

🌸 Public Member Functions inherited from SoShape

the family traits she picked up:

  • 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

okay this list is long and honestly lowkey iconic, the whole node girlie starter pack:

  • 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) — reset everything back to factory settings, a clean slate 🧼
  • 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

the absolute root of the whole tree, respect your elders 💜:

  • 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 ⭐

the ones you can call without even having an instance, no cap:

  • 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 🍓

the fields you actually poke at, the ones that make the cone a cone:

  • SoSFBitMask parts — which parts of the cone are turned on, very much a bitmask situation 🧩
  • SoSFFloat bottomRadius — how wide the bottom is, the cone's whole silhouette depends on this ✨
  • SoSFFloat height — how tall she stands, iconic vertical energy 📏

🙈 Protected Member Functions 🙈

for the class and her subclasses only, backstage access 🎭:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoCone () — the destructor, her graceful exit 🚪
  • 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) — the inherited pointer-grabber, same deal as everywhere else in Coin 💅

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — again, but from SoNode this time, no cap
  • static void setNextActionMethodIndex (int index) — sets the next action method index
  • static int getNextActionMethodIndex (void) — gets it back
  • static void incNextActionMethodIndex (void) — bumps it up by one
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types from a nodetype plus a bitmask

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — hands you the current write counter
  • static void staticDataLock (void) — locks the static data, bestie 🔒
  • static void staticDataUnlock (void) — and unlocks it again

Additional Inherited Members

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 = 0
  • static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

The SoCone class is for rendering cone shapes. That's it, that's the whole job, and she ate. 🍦

Insert a cone shape into the scenegraph. The cone gets rendered with the current material, texture and drawstyle settings — if there are any, that is. If there aren't, the default settings get used instead. Standard behaviour, no drama.

The SoCone node class is provided as a convenient abstraction so that you, the application programmer, can use "complex" shapes of this type without having to do the tessellation to polygons and all that other low-level programming yourself. She's doing the heavy lifting so you don't have to. Iconic, honestly. 🫶

A cone is visualized by the underlying rendering system by first tessellating the conceptual cone into a set of polygons. Now, to control the trade-off between an as-much-as-possible-correct visual appearance of the cone 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 get generated, and the more rounded the sides of the cone will look.) Set the SoComplexity::value field to whatever you believe would be a good trade-off between correctness and speed for your particular application. You got this.

FILE FORMAT/DEFAULTS:

Cone {
    bottomRadius 1
    height 2
    parts (SIDES | BOTTOM)
}

See also

  • SoCylinder, SoSphere, SoCube — the rest of the shape squad 💖

💖 Member Enumeration Documentation 💖

enum SoCone::Part

Enumerates the various parts of the cone, for setting inclusion or exclusion from the shape. Pick and choose, babe. ✨

🎀 Constructor & Destructor Documentation 🎀

SoCone::SoCone (void )

Constructor. Birth. 🦋

References bottomRadius, height, parts, and SoCone().

Referenced by getFieldData(), and SoCone().

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

Destructor. She's done, she's resting, she served her purpose. 💀

✨ Member Function Documentation ✨

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

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting. iykyk 🧚

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 whatever else: this method needs to be overridden in all subclasses. No skipping, bestie. 🙈 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. The macros are your friends.

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 * SoCone::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. Empty-handed, but honestly.

Reimplemented from SoShape.

References SoCone().

void SoCone::addPart (SoCone::Part part)

Add a part to the cone. More cone for you. 🍓

See also

  • removePart(), hasPart()

References hasPart(), parts, and SoDebugError::postWarning().

void SoCone::removePart (SoCone::Part part)

Remove a part from the cone. Less cone for you. 😭

See also

  • addPart(), hasPart()

References hasPart(), parts, and SoDebugError::postWarning().

SbBool SoCone::hasPart (SoCone::Part part) const

Returns TRUE if rendering of the given part is currently turned on. Vibe check: is it on? ⭐

See also

  • addPart(), removePart()

References parts.

Referenced by addPart(), and removePart().

void SoCone::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 just want to throw geometry primitives at OpenGL — override this method. Main character energy, honestly. 👑

Reimplemented from SoShape.

References bottomRadius, SoShape::getComplexityValue(), SoAction::getState(), parts, SoDebugError::postInfo(), and SoShape::shouldGLRender().

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

Calculates the picked point based on primitives generated by subclasses. She's pointing at things. 🔥

Reimplemented from SoShape.

References bottomRadius, SoAction::getState(), parts, and SoShape::shouldRayPick().

void SoCone::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.

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

void SoCone::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(). Don't do it, bestie, I'm begging. 🙈)

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. Pass it back, periodt. 💅

Implements SoShape.

References bottomRadius, SoShape::getComplexityValue(), SoAction::getState(), and parts.

void SoCone::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(). Again. Don't. 😭)

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. Heads up on that one.

Implements SoShape.

References bottomRadius, height, parts, SbBox3f::setBounds(), and SbVec3f::setValue().

🦋 Member Data Documentation 🦋

SoSFBitMask SoCone::parts

The parts to use for the cone shape. Defaults to SoCone::ALL. Everything, all at once. ✨

Referenced by addPart(), computeBBox(), generatePrimitives(), getPrimitiveCount(), GLRender(), hasPart(), rayPick(), removePart(), and SoCone().

SoSFFloat SoCone::bottomRadius

Radius of the cone's bottom disc. Default value is 1.0. Round bottom, cute bottom. 🌸

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

SoSFFloat SoCone::height

Height of cone. Default value is 2.0. Tall queen. 👑

Referenced by computeBBox(), and SoCone().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very diligent robot. 🤖

That's a wrap on SoCone, bestie! 💖 This page came to you from Coin, Version 2.5.0, and it's the SoCone(3) manual page. Go forth and render some absolutely iconic cones. 🎀 ✨ 🦋 Slay.
📦 where this page comes from