SoIndexedLineSet(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

SoIndexedLineSet — bestie, this class is used to render and otherwise represent indexed lines. That's the whole vibe. (Also hi, you're on the SoIndexedLineSet(3) page, we're doing this together 🫶)

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoIndexedLineSet.h>

Inherits SoIndexedShape. Yeah she comes from a whole family, we'll get to that. 🌈

✨ Public Member Functions ✨

These are hers, like actually hers:

  • virtual SoType getTypeId (void) const — the type id, and it's virtual so she'll tell you who she really is 💅
  • SoIndexedLineSet (void) — the constructor. she's born. iconic. 🎀
  • virtual void GLRender (SoGLRenderAction *action) — does the GL rendering thing with the action
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — hands over the bounding box via the action
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts primitives, as one does

🌸 Public Member Functions inherited from SoVertexShape 🌸

Not hers originally, but she got them in the will 💜

  • virtual void notify (SoNotList *nl) — sends out the notification
  • virtual void write (SoWriteAction *action) — writes herself out

🦋 Public Member Functions inherited from SoShape 🦋

  • virtual SbBool affectsState (void) const — does she affect state? a yes/no situation
  • virtual void rayPick (SoRayPickAction *action) — ray picking time, bestie
  • virtual void callback (SoCallbackAction *action) — the callback action
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const — the bounding box cache, already cached, no redoing the work

🌈 Public Member Functions inherited from SoNode 🌈

Long list, don't panic, we're going through every single one:

  • void setOverride (const SbBool state) — sets the override state
  • SbBool isOverride (void) const — is it overriding? asking for you
  • void setNodeType (const NodeType type) — sets the node type
  • NodeType getNodeType (void) const — gets the node type
  • virtual SoNode * copy (SbBool copyconnections=0) const — makes a copy
  • virtual void doAction (SoAction *action) — does the action
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL renders below the path
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL renders in the path
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL renders off the path
  • virtual void getMatrix (SoGetMatrixAction *action) — grabs the matrix
  • virtual void handleEvent (SoHandleEventAction *action) — handles the event
  • virtual void pick (SoPickAction *action) — does the picking
  • virtual void search (SoSearchAction *action) — does the searching
  • virtual void audioRender (SoAudioRenderAction *action) — audio render, yes really 🔊
  • virtual void grabEventsSetup (void) — sets up the event grabbing
  • virtual void grabEventsCleanup (void) — cleans up the event grabbing
  • virtual void startNotify (void) — kicks off the notification
  • uint32_t getNodeId (void) const — the node id, a uint32_t no less
  • virtual SoChildList * getChildren (void) const — the children list
  • virtual void writeInstance (SoOutput *out) — writes the instance
  • virtual SoNode * addToCopyDict (void) const — adds herself to the copy dictionary
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies the contents over
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through the connection

🎀 Public Member Functions inherited from SoFieldContainer 🎀

  • void setToDefaults (void) — back to defaults, reset era
  • SbBool hasDefaultValues (void) const — still on defaults? yes/no
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — are the fields equal to that container's? 👀
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copies the field values over
  • SbBool set (const char *const fielddata) — sets from field data
  • void get (SbString &fielddata) — gets the field data out
  • virtual int getFields (SoFieldList &l) const — gets the fields into a list
  • virtual int getAllFields (SoFieldList &l) const — gets all the fields, every last one
  • virtual SoField * getField (const SbName &name) const — gets a field by name
  • virtual SoField * getEventIn (const SbName &name) const — gets an event in by name
  • virtual SoField * getEventOut (const SbName &name) const — gets an event out by name
  • SbBool getFieldName (const SoField *const field, SbName &name) const — gets the name of a given field
  • SbBool enableNotify (const SbBool flag) — turns notification on/off
  • SbBool isNotifyEnabled (void) const — is notification enabled? you know the drill
  • SbBool set (const char *fielddata, SoInput *in) — sets from field data, but with an SoInput
  • void get (SbString &fielddata, SoOutput *out) — gets the field data out, with an SoOutput
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — is this new value even valid for that field
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — adds the write reference
  • SbBool getIsBuiltIn (void) const — is it built in?
  • void setUserData (void *userdata) const — stashes your user data
  • void * getUserData (void) const — gets your user data back out

🧚 Public Member Functions inherited from SoBase 🧚

  • void ref (void) const — refs her, bumps the count
  • void unref (void) const — unrefs her
  • void unrefNoDelete (void) const — unrefs but, you know, doesn't delete
  • int32_t getRefCount (void) const — the ref count, as an int32_t
  • void touch (void) — touch her
  • SbBool isOfType (SoType type) const — is she that type?
  • virtual SbName getName (void) const — her name
  • virtual void setName (const SbName &newname) — gives her a new name
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor of that type
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor of that type
  • const SoAuditorList & getAuditors (void) const — the auditor list
  • SbBool shouldWrite (void) — should she be written?
  • void assertAlive (void) const — asserts she's alive, dramatic but fair 💀

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void) — the class type id, static edition
  • static void initClass (void) — inits the class

💜 Static Public Member Functions inherited from SoIndexedShape 💜

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

🍓 Static Public Member Functions inherited from SoVertexShape 🍓

  • 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) — screen size, from a state and a bounding box into a rectsize
  • static float getDecimatedComplexity (SoState *state, float complexity) — the decimated complexity, as a float

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

🫶 Protected Member Functions 🫶

The members-only section, no randoms allowed:

  • virtual const SoFieldData * getFieldData (void) const — the field data, protected edition
  • virtual ~SoIndexedLineSet () — the destructor. rest in peace queen 😭

🌈 Protected Member Functions inherited from SoIndexedShape 🌈

  • SoIndexedShape (void) — the constructor
  • virtual ~SoIndexedShape () — the destructor
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center) — computes the bounding box into box and center
  • int getNumVerts (const int startCoord) — how many verts, starting from startCoord
  • void setupIndices (const int numParts, const int numFaces, const SbBool needNormals, const SbBool needTexCoords) — sets up the indices for the given parts, faces, and whether normals/tex coords are needed
  • const int32_t * getNormalIndices (void) — the normal indices
  • const int32_t * getColorIndices (void) — the color indices
  • const int32_t * getTexCoordIndices (void) — the texture coordinate indices
  • 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) — the big one, grabs all the vertex data in one go

🦋 Protected Member Functions inherited from SoVertexShape 🦋

  • SoVertexShape (void)
  • virtual ~SoVertexShape ()
  • virtual SbBool shouldGLRender (SoGLRenderAction *action) — should this even GL render? yes/no
  • void setNormalCache (SoState *const state, const int num, const SbVec3f *normals) — sets the normal cache
  • SoNormalCache * getNormalCache (void) const — gets the normal cache
  • SoNormalCache * generateAndReadLockNormalCache (SoState *const state) — generates it and read-locks it, multitasking queen
  • void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals) — the SoVertexShape flavour of getting vertex data
  • void readLockNormalCache (void) — read-locks the normal cache
  • void readUnlockNormalCache (void) — read-unlocks the normal cache

⭐ Protected Member Functions inherited from SoShape ⭐

Okay this one's a whole album, stay with me:

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *action) — the complexity value, as a float
  • void beginSolidShape (SoGLRenderAction *action) — begins the solid shape
  • void endSolidShape (SoGLRenderAction *action) — ends the solid shape
  • void GLRenderBoundingBox (SoGLRenderAction *action) — GL renders the bounding box
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action) — should we count primitives?
  • SbBool shouldRayPick (SoRayPickAction *const action) — should we ray pick?
  • void computeObjectSpaceRay (SoRayPickAction *const action) — computes the object space ray
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix) — same but you hand it a matrix
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp) — makes the triangle detail from three vertices
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) — makes the line segment detail from two vertices
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp) — makes the point detail from one vertex
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) — fires the triangle callbacks
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) — fires the line segment callbacks
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v) — fires the point callbacks
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL) — begins the shape with that triangle shape type and a detail that defaults to NULL
  • void shapeVertex (const SoPrimitiveVertex *const v) — feeds in a shape vertex
  • void endShape (void) — ends the shape
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal) — generates a vertex with s, t and a 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) — the same but with r too, she's extra 💅
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex) — starts the vertex array
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex) — finishes the vertex array

okay bestie that's part 1, and there is so much more where that came from, do not go anywhere 🫶

✨ Protected Member Functions inherited from SoNode ✨

Okay so these are the protected ones you inherit from SoNode, bestie — don't sleep on them:

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

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

💖 Detailed Description 💖

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

The indexed counterpart of SoLineSet. Lines can be specified using indices for coordinates, normals, materials and texture coordinates.

If no normals are supplied on the stack (or in the vertexProperty field), the lines will be rendered with lighting disabled.

For more information about line sets, see documentation in SoLineSet. For more information about indexed shapes, see documentation in SoIndexedShape and SoIndexedFaceSet.

FILE FORMAT/DEFAULTS:

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

🛠️ Constructor & Destructor Documentation 🛠️

SoIndexedLineSet::SoIndexedLineSet (void )

Constructor.

References SoIndexedLineSet().

Referenced by getFieldData(), and SoIndexedLineSet().

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

Destructor.

📚 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.

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

Reimplemented from SoIndexedShape.

References SoIndexedLineSet().

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 wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoShape.

References SoIndexedShape::coordIndex, SoShape::finishVertexArray(), SoGLRenderAction::getCacheContext(), SoNode::getNodeId(), SoNode::getNodeType(), SoAction::getState(), SoIndexedShape::getVertexData(), SoState::pop(), SoState::push(), SoVertexShape::shouldGLRender(), SoShape::startVertexArray(), SoVertexShape::vertexProperty, and SoNode::VRML1.

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

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for 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.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

References SoNode::getBoundingBox(), and SoAction::getState().

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.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

References SoGetPrimitiveCountAction::addNumLines(), SoGetPrimitiveCountAction::canApproximateCount(), SoIndexedShape::coordIndex, and SoShape::shouldPrimitiveCount().

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code.

Coin, Version 2.5.0, page SoIndexedLineSet(3) — and that's the whole vibe, bestie. Stay indexed, stay iconic. 💅💖✨

📦 where this page comes from