SoVRMLCone(3)

✨ NAME ✨

SoVRMLCone — bestie, it's the class that represents a Cone object. That's it, that's the gig. 💖

This is SoVRMLCone(3) from the Library Functions Manual, and it's a big one, so we're doing it in two parts — this is part 1, so don't go anywhere. 🎀

---

🌸 SYNOPSIS 🌸

#include <Inherited/VRMLnodes/SoVRMLCone.h>

wait no. Let me not do that. It's literally:

#include <Inventor/VRMLnodes/SoVRMLCone.h>

Inherits SoVRMLGeometry. So like, it's in the family, it's got ancestors, it's giving lineage. 👑

---

💅 Public Member Functions

• virtual SoType getTypeId (void) const — tells you what type this thing actually is at runtime, iconic behavior
• SoVRMLCone (void) — the constructor, aka the birth of your cone ✨
• virtual void GLRender (SoGLRenderAction *action) — makes it show up on screen, main character energy fr
• virtual void rayPick (SoRayPickAction *action) — lets you poke it with a ray and see what happens
• virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives, very "math girl" of it

---

🫶 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

this list is long bestie, drink some water first 💧

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

the whole ancestry is showing up to the group chat huh 😭

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

these ones you can call without even making an object, no cap:

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

okay these are the actual vibes of your cone, the fields you get to set:

• SoSFFloat bottomRadius — how wide the bottom of the cone is, basically its hip measurement 🍓
• SoSFFloat height — how tall it stands, tall queen behavior
• SoSFBool side — whether the side surface even exists
• SoSFBool bottom — whether the bottom cap even exists

---

🔒 Protected Member Functions

for the family only, not for the general public, iykyk:

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

brace yourself 💀

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)

yes there are two generateVertex overloads and two computeObjectSpaceRay overloads. that's not a typo bestie, that's ✨overloading✨

---

🔒 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)

---

that's the whole SYNOPSIS bestie, we ate that 💅 but hold on — the DESCRIPTION, the files, the SEE ALSO, all of it is still coming in part 2. don't close the tab 🦋

✨ Static Protected Member Functions inherited from SoNode ✨

okay so these are the lil' helpers your class gets handed down from SoNode, no effort required on your part bestie:

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

and these are the ones coming all the way from SoBase, the great-grandma of the whole family tree:

• static uint32_t getCurrentWriteCounter (void)
• static void staticDataLock (void)
• static void staticDataUnlock (void)

---

👑 Additional Inherited Members 👑

the rest of the inheritance drip. it's giving "everything my ancestors left me" energy 💅

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 }

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 SoVRMLCone class is used to represent a Cone object. yes. a cone. the humble lil pointy friend 🍦

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:

Cone {
  field     SFFloat   bottomRadius 1        # (0, inf)
  field     SFFloat   height       2        # (0, inf)
  field     SFBool    side         TRUE
  field     SFBool    bottom       TRUE
}

The Cone node specifies a cone which is centred in the local coordinate system and whose central axis is aligned with the local Y-axis. The bottomRadius field specifies the radius of the cone's base, and the height field specifies the height of the cone from the centre of the base to the apex. By default, the cone has a radius of 1.0 at the bottom and a height of 2.0, with its apex at y = height/2 and its bottom at y = -height/2. Both bottomRadius and height shall be greater than zero. Figure 6.3 illustrates the Cone node.

Figure 6.3

The side field specifies whether sides of the cone are created and the bottom field specifies whether the bottom cap of the cone is created. A value of TRUE specifies that this part of the cone exists, while a value of FALSE specifies that this part does not exist (not rendered or eligible for collision or sensor intersection tests). When a texture is applied to the sides of the cone, the texture wraps counterclockwise (from above) starting at the back of the cone. The texture has a vertical seam at the back in the X=0 plane, from the apex (0, height/2, 0) to the point (0, -height/2, - bottomRadius). For the bottom cap, a circle is cut out of the texture square centred at (0, -height/2, 0) with dimensions (2 × bottomRadius) by (2 × bottomRadius). The bottom cap texture appears right side up when the top of the cone is rotated towards the -Z-axis. SoVRMLTextureTransform affects the texture coordinates of the Cone.

The Cone geometry requires outside faces only. When viewed from the inside the results are undefined.

⚠️ undefined behaviour alert!! if you're peeking at this cone from the inside, all bets are off, bestie. no promises, no guarantees, we simply do not know 💀

---

🎀 Constructor & Destructor Documentation 🎀

SoVRMLCone::SoVRMLCone (void )

Constructor. the birth of a cone, iconic honestly 🫶

References bottom, bottomRadius, height, side, and SoVRMLCone().

Referenced by getFieldData(), and SoVRMLCone().

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

Destructor. rip lil cone, you served 🌈

---

💖 Member Function Documentation 💖

SoType SoVRMLCone::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 SoVRMLGeometry.

const SoFieldData * SoVRMLCone::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 SoVRMLCone().

void SoVRMLCone::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 bottom, bottomRadius, SoShape::getComplexityValue(), SoAction::getState(), SoVRMLGeometry::shouldGLRender(), and side.

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

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

References bottom, bottomRadius, SoShape::shouldRayPick(), and side.

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

void SoVRMLCone::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 bottom, bottomRadius, SoShape::getComplexityValue(), and side.

void SoVRMLCone::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 bottom, bottomRadius, height, SbBox3f::setBounds(), SbVec3f::setValue(), and side.

---

🍓 Member Data Documentation 🍓

SoSFFloat SoVRMLCone::bottomRadius

The cone bottom radius. Default value is 1.0.

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

SoSFFloat SoVRMLCone::height

The cone height. Default value is 2.0.

Referenced by computeBBox(), and SoVRMLCone().

SoSFBool SoVRMLCone::side

Enable/disable the cone side wall. Default value is TRUE.

Referenced by computeBBox(), generatePrimitives(), getPrimitiveCount(), GLRender(), rayPick(), and SoVRMLCone().

SoSFBool SoVRMLCone::bottom

Enable/disable the cone bottom. Default value is TRUE.

Referenced by computeBBox(), generatePrimitives(), getPrimitiveCount(), GLRender(), rayPick(), and SoVRMLCone().

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

---

and that's a wrap on SoVRMLCone(3) bestie!! 🎉 this whole thing came from Coin, Version 2.5.0, dated SoVRMLCone(3) — generated automatically by Doxygen, no human hands typed this prose (well… until now 🙈). go forth and cone, you absolute icon 👑✨