SoCylinder(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoCylinder(3) — Library Functions Manual 🎀

okay so bestie, we're reading the manual for SoCylinder(3) from the Library Functions Manual. this is part 1, so buckle up, there's more coming. 💅

✨ NAME ✨

SoCylinder — bestie, this class is literally for rendering cylinder shapes. that's the whole vibe. no cap. 🛢️✨

🌈 SYNOPSIS 🌈

okay so here's the synopsis, and it's long. like, it inherited a whole family tree. but we're keeping every single detail because that's the rule. 💖

#include <Inventor/nodes/SoCylinder.h>

Inherits SoShape.

Public Types
    enum Part { SIDES = 0x1, TOP = 0x2, BOTTOM = 0x4, ALL = SIDES|TOP|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,
        COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Public Member Functions
    virtual SoType getTypeId (void) const
    SoCylinder (void)
    void addPart (SoCylinder::Part part)
    void removePart (SoCylinder::Part part)
    SbBool hasPart (SoCylinder::Part part) const
    virtual void rayPick (SoRayPickAction *action)
    virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
    virtual void GLRender (SoGLRenderAction *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=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)
    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=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

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

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

Public Attributes
    SoSFFloat radius
    SoSFFloat height
    SoSFBitMask parts

Protected Member Functions
    virtual const SoFieldData * getFieldData (void) const
    virtual ~SoCylinder ()
    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)
    virtual ~SoFieldContainer ()

and that's the synopsis, bestie. it's giving inheritance energy fr fr. next up: part 2, where we get into the rest. don't go anywhere ✨

🫶 Protected Member Functions inherited from SoBase 🫶

okay bestie, these are the protected member functions you get handed down from SoBase — no cap, they're part of the family tree 💖

SoBase (void) — the constructor, doing constructor things.
virtual ~SoBase () — the destructor, virtual because it's fancy like that.
virtual void destroy (void) — the destroy method, also virtual.
SbBool hasMultipleWriteRefs (void) const — checks if there are multiple write refs, const because it's not changing anything.
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header, takes out, isgroup, isengine.
void writeFooter (SoOutput *out) const — writes the footer, takes out.
virtual const char * getFileFormatName (void) const — gives you the file format name as a const char *.

✨ Static Protected Member Functions ✨

static const SoFieldData ** getFieldDataPtr (void) — static pointer getter for 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) — the SoNode version.
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) — increments the next action method index.
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types with nodetype and bitmask.

💜 Static Protected Member Functions inherited from SoBase 💜

static uint32_t getCurrentWriteCounter (void) — gets the current write counter.
static void staticDataLock (void) — locks the static data.
static void staticDataUnlock (void) — unlocks the static data.

🎀 Additional Inherited Members 🎀

🌈 Protected Types inherited from SoBase 🌈

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags enum, with IS_ENGINE = 0x01 and IS_GROUP = 0x02.

🍓 Protected Attributes inherited from SoNode 🍓

uint32_t uniqueId — the unique ID.

🧚 Protected Attributes inherited from SoFieldContainer 🧚

SbBool isBuiltIn — whether it's built in.

👑 Static Protected Attributes inherited from SoNode 👑

static uint32_t nextUniqueId = 1 — the next unique ID starts at 1.
static int nextActionMethodIndex = 0 — the next action method index starts at 0.

💖 Detailed Description 💖

The SoCylinder class is for rendering cylinder shapes. Slay.

Insert a cylinder shape into the scenegraph. The cylinder is rendered with the current material, texture and drawstyle settings (if any, otherwise the default settings are used).

The SoCylinder 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 cylinder is visualized by the underlying rendering system by first tessellating the conceptual cylinder into a set of polygons. To control the trade-off between an as much as possible correct visual appearance of the cylinder 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 sides of the cylinder 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.

A nice trick for rendering a disc is to render an SoCylinder with SoCylinder::height set to zero:

#Inventor V2.1 ascii

ShapeHints { # to get two-sided lighting on the disc
   vertexOrdering COUNTERCLOCKWISE
   shapeType UNKNOWN_SHAPE_TYPE
}

Cylinder {
   height 0
   parts TOP
}

FILE FORMAT/DEFAULTS:

Cylinder {
    radius 1
    height 2
    parts (SIDES | TOP | BOTTOM)
}

See also: SoCone, SoSphere, SoCube.

🔥 Member Enumeration Documentation 🔥

🌟 enum `SoCylinder::Part` 🌟

The parts of a cylinder shape.

💅 Constructor & Destructor Documentation 💅

SoCylinder::SoCylinder (void ) — Constructor.
SoCylinder::~SoCylinder () [protected], [virtual] — Destructor.

✨ Member Function Documentation ✨

SoType SoCylinder::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
  }
}

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 * SoCylinder::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.