SoVRMLIndexedLine(3)

📦 version 3.1.3, in fedora 43, fedora 44

💅 SoVRMLIndexedLine — manual page, bestie 💅

okay so this is SoVRMLIndexedLine(3), straight outta the Library Functions Manual, and it's a whole mood. she's abstract, she's a superclass, she's the blueprint for lines built out of indices. let's get into it 🦋

🌸 NAME 🌸

SoVRMLIndexedLine — the SoVRMLIndexedLine class is an abstract superclass for lines specified with indices. periodt. she doesn't do the whole thing herself, she's the vibe the other classes inherit 💖

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLIndexedLine.h>

Inherits SoVRMLVertexLine.

Inherited by SoVRMLIndexedLineSet.

no cap, that's the whole family tree up top 🌈

👑 Public Member Functions

virtual SoType getTypeId (void) const

that's literally her only own public member function. she's minimal, she's iconic, she lets the ancestors carry the weight 💅

🧚 Public Member Functions inherited from SoVRMLVertexLine

virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

🌸 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 rayPick (SoRayPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *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 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 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

look at that list. she's got range 😭✨

💜 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
ngl there's a lot of set and get going on here. it's giving "fields for days" 🍓

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

yes bestie, initClass shows up in like every single ancestor. it's a family tradition 💀

🎀 Static Public Member Functions inherited from SoVRMLVertexLine

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)

all those ...S versions?? it's giving "static dispatch, but make it fashion" 💅✨

🎀 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

SoMFInt32 coordIndex
SoMFInt32 colorIndex

okay these two are hers and only hers, and yes they're both SoMFInt32 (multi-field int32, if you know you know 🔥). coordIndex and colorIndex, iconic duo, no notes.

🦋 Public Attributes inherited from SoVRMLVertexLine

SoSFNode coord
SoSFNode color
SoSFBool colorPerVertex

🌸 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
int getNumVerts (int startCoord)
void setupIndices (int numFaces)
const int32_t * getColorIndices (void)
virtual void notify (SoNotList *list)

aww look at her, she's got her own lil protected helper squad 🥺 getNumVerts, setupIndices, getColorIndices — the backstage crew that makes the indexed-line magic happen.

🌸 Protected Member Functions inherited from SoVRMLVertexLine

SoVRMLVertexLine (void)
virtual ~SoVRMLVertexLine ()
virtual SbBool shouldGLRender (SoGLRenderAction *action)

🌸 Protected Member Functions inherited from SoVRMLGeometry

SoVRMLGeometry (void)
virtual ~SoVRMLGeometry ()
void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
virtual SoChildList * getChildren (void) const

🌸 Protected Member Functions inherited from SoShape

SoShape (void)
virtual ~SoShape ()
float getComplexityValue (SoAction *action)
virtual void generatePrimitives (SoAction *action)=0
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)
heads up bestie — that virtual void generatePrimitives (SoAction *action)=0 is pure virtual (see the =0?). she does not play. you don't get to instantiate her until you fill that in. 💀

also note there are two generateVertex overloads — one with s, t and one with s, t, r. two flavours, pick your girl 🍓

🌸 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 the page just… keeps going, bestie — hold that thought 💖

💅 Protected Member Functions inherited from SoBase

okay so bestie, SoBase is the ancestor of literally everything, and it's handing down these lil protected babies to SoVRMLIndexedLine:

  • SoBase(void) — the plain constructor, no drama, no arguments.
  • virtual ~SoBase() — the virtual destructor. say goodbye properly 💀
  • virtual void destroy(void) — nukes the instance, virtual-style.
  • SbBool hasMultipleWriteRefs(void) const — checks if this thing's got more than one write reference.
  • SbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out, and yes it wants to know if you're a group and if you're an engine.
  • void writeFooter(SoOutput *out) const — writes the footer. the outro. the periodt 🎀
  • virtual const char * getFileFormatName(void) const — hands you the file format name as a C string.

✨ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr(void) — the static hook for field data. iconic.

🌸 Static Protected Member Functions inherited from SoVRMLVertexLine

  • static const SoFieldData ** getFieldDataPtr(void) — same energy, one ancestor up.

🦋 Static Protected Member Functions inherited from SoVRMLGeometry

  • static const SoFieldData ** getFieldDataPtr(void) — you already know what this does, bestie.

🌈 Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr(void) — again! the family tradition 💖

⭐ Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr(void) — yep, still the same one.
  • static void setNextActionMethodIndex(int index) — sets the next action method index.
  • static int getNextActionMethodIndex(void) — reads the next action method index back out.
  • static void incNextActionMethodIndex(void) — bumps that index up by one.
  • static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for a node type with a uint32_t bitmask.

🫶 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter(void) — gives you the current write counter as a uint32_t.
  • static void staticDataLock(void) — locks the static data. 🔒
  • static void staticDataUnlock(void) — unlocks it again. 🔓

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

💫 Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

👑 Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the node's very own unique id, main character energy fr.

🍓 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — whether this container is built in. yes or no, no in-between.

🧚 Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — starts at 1, not 0, and that's just how it is.
  • static int nextActionMethodIndex = 0 — starts at 0.

💖 Detailed Description

The SoVRMLIndexedLine class is an abstract superclass for lines specified with indices.

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

like, translation: this one's for the library's own inner circle, not really for you, bestie. no shade, it's just built different. 💅

🔥 Member Function Documentation

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

Reimplemented in SoVRMLIndexedLineSet.

🦋 const SoFieldData * SoVRMLIndexedLine::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 SoVRMLVertexLine.

Reimplemented in SoVRMLIndexedLineSet.

🌸 void SoVRMLIndexedLine::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.

💫 void SoVRMLIndexedLine::notify(SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoVRMLVertexLine.

Reimplemented in SoVRMLIndexedLineSet.

👑 Author

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie — every last inherited member, every enum value, every NULL, all of it. this one came out of Coin Version 3.1.3, and it's the SoVRMLIndexedLine(3) page, so like… go forth and index those lines. slay 💖✨🎀

📦 where this page comes from