SoIndexedLineSet(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoIndexedLineSet(3) 💖

okay bestie, welcome to the SoIndexedLineSet(3) page from the Library Functions Manual. This is part 1, and it's giving indexed lines but make it classy. Let's go.

🌸 NAME 🌸

The SoIndexedLineSet class is used to render and otherwise represent indexed lines.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoIndexedLineSet.h>

Inherits SoIndexedShape.

💅 Public Member Functions 💅

first up, the homegirl's own methods:

  • virtual SoType getTypeId (void) const
  • SoIndexedLineSet (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Public Member Functions inherited from SoVertexShape

and she gets this one from SoVertexShape:

  • virtual void write (SoWriteAction *action)

Public Member Functions inherited from SoShape

from SoShape, we got:

  • virtual SbBool affectsState (void) const
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void callback (SoCallbackAction *action)
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const

Public Member Functions inherited from SoNode

the SoNode inheritance is long, no cap:

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

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

and from SoBase, the OG:

  • 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 ones, for the class itself:

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoIndexedShape

from SoIndexedShape static:

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoVertexShape

from SoVertexShape static:

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoShape

from SoShape static:

  • 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

from SoNode static, and there's a lot:

  • 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

from SoFieldContainer static:

  • 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

from SoBase static:

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

🔒 Protected Member Functions 🔒

protected section, iykyk:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoIndexedLineSet ()
  • virtual void notify (SoNotList *list)

Protected Member Functions inherited from SoIndexedShape

from SoIndexedShape protected:

  • SoIndexedShape (void)
  • virtual ~SoIndexedShape ()
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • int getNumVerts (const int startCoord)
  • void setupIndices (const int numParts, const int numFaces, const SbBool needNormals, const SbBool needTexCoords)
  • const int32_t * getNormalIndices (void)
  • const int32_t * getColorIndices (void)
  • const int32_t * getTexCoordIndices (void)
  • SbBool getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const int32_t *&cindices, const int32_t *&nindices, const int32_t *&tindices, const int32_t *&mindices, int &numcindices, const SbBool needNormals, SbBool &normalCacheUsed)

Protected Member Functions inherited from SoVertexShape

and from SoVertexShape protected:

  • SoVertexShape (void)
  • virtual ~SoVertexShape ()
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)
  • void setNormalCache (SoState *const state, const int num, const SbVec3f *normals)
  • SoNormalCache * getNormalCache (void) const
  • SoNormalCache * generateAndReadLockNormalCache (SoState *const state)
  • void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
  • void readLockNormalCache (void)
  • void readUnlockNormalCache (void)

part 2 is gonna eat, fr fr 💅

💖 Protected Member Functions inherited from SoShape

the whole SoShape inheritance bag, bestie — every single one:

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

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

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

  • static const SoFieldData ** getFieldDataPtr(void)
  • static SbBool areTexCoordsIndexed(SoAction *action)

🌟 Static Protected Member Functions inherited from SoVertexShape

  • 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

👑 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 Attributes inherited from SoIndexedShape

  • SoMFInt32 coordIndex
  • SoMFInt32 materialIndex
  • SoMFInt32 normalIndex
  • SoMFInt32 textureCoordIndex

🍓 Public Attributes inherited from SoVertexShape

  • SoSFNode vertexProperty

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

✨ Detailed Description ✨

okay so SoIndexedLineSet is the class that renders — and otherwise represents — indexed lines. it's giving "lines but make it indexed." 💅

it's literally the indexed counterpart of SoLineSet. Lines can be specified using indices for coordinates, normals, materials and texture coordinates. that's the whole vibe.

if no normals are supplied on the stack (or in the vertexProperty field), the lines will be rendered with lighting disabled. so like, no shading glow-up, just flat. noted. ✨

for more info about line sets, see the documentation in SoLineSet. for more about indexed shapes, see the docs in SoIndexedShape and SoIndexedFaceSet. bestie network fr fr 🫶

FILE FORMAT/DEFAULTS:

IndexedLineSet {
    vertexProperty NULL
    coordIndex 0
    materialIndex -1
    normalIndex -1
    textureCoordIndex -1
}

🛠️ Constructor & Destructor Documentation 🛠️

🌷 SoIndexedLineSet::SoIndexedLineSet(void)

Constructor. she's born. ✨

🌷 SoIndexedLineSet::~SoIndexedLineSet() [protected], [virtual]

Destructor. she's gone. 😭 (protected + virtual, no cap)

📚 Member Function Documentation 📚

💖 SoType SoIndexedLineSet::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. iykyk 🔥

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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. so many macros, so little time 💀

for more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. go read the lore 📖

Reimplemented from SoIndexedShape.

💖 const SoFieldData * SoIndexedLineSet::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. (yes, NULL. she returns nothing, iconically.) 🙈

Reimplemented from SoIndexedShape.

💖 void SoIndexedLineSet::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 want to throw geometry primitives at OpenGL, override this method. throwing primitives at OpenGL is a whole mood fr fr.

Reimplemented from SoShape.

💖 void SoIndexedLineSet::getBoundingBox(SoGetBoundingBoxAction * action) [virtual]

action method for the SoGetBoundingBoxAction.

calculates bounding box and center coordinates for the node, and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. main character energy, shifting the whole scene toward herself 💅

nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoShape.

💖 void SoIndexedLineSet::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. counting her little primitives like a proud mom 🥹

nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoShape.

💖 void SoIndexedLineSet::notify(SoNotList * l) [protected], [virtual]

notifies all auditors for this instance when changes are made. she's telling everyone. gossip network activated 📣

Reimplemented from SoVertexShape.

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (the robots wrote it, we just vibed it up 💅🤖)

and that's the whole page bestie!! 🎀 this was Coin Version 3.1.3, dated the day this manpage was generated — so if you're reading it later, check your version, the vibes may have evolved. slay, stay indexed, and go render some lines ✨🦋💖

📦 where this page comes from