SoVRMLIndexedLineSet(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVRMLIndexedLineSet(3) 💖

okay so bestie, welcome to the manual page for SoVRMLIndexedLineSet(3) from the Library Functions Manual. This class? It's used to represent a generic 3D line shape. That's the whole vibe. ✨

🌸 NAME 🌸

SoVRMLIndexedLineSet — the class is used to represent a generic 3D line shape. periodt. 💅

🎀 SYNOPSIS 🎀

#include <Inventor/VRMLnodes/SoVRMLIndexedLineSet.h>

Inherits SoVRMLIndexedLine.

👑 Public Member Functions 👑

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

💜 Public Member Functions inherited from SoVRMLVertexLine

  • virtual void doAction (SoAction *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)
  • 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

🫶 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 SoVRMLIndexedLine

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

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

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

🛡️ Protected Member Functions 🛡️

  • virtual const SoFieldData * getFieldData (void) const
  • virtual void generatePrimitives (SoAction *action)
  • virtual void notify (SoNotList *list)

🧚 Protected Member Functions inherited from SoVRMLIndexedLine

  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • int getNumVerts (int startCoord)
  • void setupIndices (int numFaces)
  • const int32_t * getColorIndices (void)

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

okay bestie that's part 1, and there's more coming so don't go anywhere. part 2 is gonna be just as iconic, no cap. 💖✨

🫶 Protected Member Functions inherited from SoBase

okay so these are the behind-the-scenes lil helpers SoBase hands down to everybody, bestie:

  • SoBase (void) — the constructor, just doing constructor things ✨
  • virtual ~SoBase () — the destructor, virtual so it cleans up properly 💅
  • virtual void destroy (void) — nukes the instance, very "bye bitch" energy 💀
  • SbBool hasMultipleWriteRefs (void) const — checks whether this thing has more than one write reference 🫶
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes out the header, and tells it whether we're a group and whether we're an engine
  • void writeFooter (SoOutput *out) const — writes the footer, the little outro of your serialization 🎀
  • virtual const char * getFileFormatName (void) const — hands back the name of the file format, iconic

⭐ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer, lowkey the meta-est function here

⭐ Static Protected Member Functions inherited from SoVRMLIndexedLine

  • static const SoFieldData ** getFieldDataPtr (void)

⭐ Static Protected Member Functions inherited from SoVRMLVertexLine

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

⭐ Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index) — sets the next action method index 📇
  • static int getNextActionMethodIndex (void) — reads the next action method index back
  • static void incNextActionMethodIndex (void) — bumps it up by one, go off 👑
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for a node type with a bitmask, very specific of it

⭐ Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — the current write counter, no cap
  • static void staticDataLock (void) — locks the static data 🔒
  • static void staticDataUnlock (void) — and unlocks it, we love a matched pair 💖

🎀 Additional Inherited Members 🎀

the extended family, the cousins at the function, all present and accounted for:

Public Types inherited from SoShape

  • enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON, QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP } — literally every shape vibe in one enum 🌈

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 } — a whole timeline of node eras, it's giving history lesson 📜

Public Attributes inherited from SoVRMLIndexedLine

  • SoMFInt32 coordIndex
  • SoMFInt32 colorIndex

Public Attributes inherited from SoVRMLVertexLine

  • SoSFNode coord
  • SoSFNode color
  • SoSFBool colorPerVertex

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — just two flags, keeping it simple 🍓

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — every node gets its own unique id, main character energy fr fr

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in? enquiring minds want to know

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

so, SoVRMLIndexedLineSet is the class that represents a generic 3D line shape. that's it, that's the vibe. 💜

the detailed class documentation below is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It's copyright The Web3D Consortium, and used by permission of the Consortium. so credit where credit is due, bestie 🫡
IndexedLineSet {
  eventIn       MFInt32 set_colorIndex
  eventIn       MFInt32 set_coordIndex
  exposedField  SFNode  color             NULL
  exposedField  SFNode  coord             NULL
  field         MFInt32 colorIndex        []     # [-1, inf)
  field         SFBool  colorPerVertex    TRUE
  field         MFInt32 coordIndex        []     # [-1, inf)
}

The IndexedLineSet node represents a 3D geometry formed by constructing polylines from 3D vertices specified in the coord field. IndexedLineSet uses the indices in its coordIndex field to specify the polylines by connecting vertices from the coord field. An index of "- 1" indicates that the current polyline has ended and the next one begins. The last polyline may be (but does not have to be) followed by a "- 1". IndexedLineSet is specified in the local coordinate system and is affected by the transformations of its ancestors. 💫

The coord field specifies the 3D vertices of the line set and contains a Coordinate node. Lines are not lit, are not texture-mapped, and do not participate in collision detection. The width of lines is implementation dependent and each line segment is solid (i.e., not dashed). If the color field is not NULL, it shall contain a Color node. The colours are applied to the line(s) as follows:

  • If colorPerVertex is FALSE:
    • If the colorIndex field is not empty, one colour is used for each polyline of the IndexedLineSet. There shall be at least as many indices in the colorIndex field as there are polylines in the IndexedLineSet. If the greatest index in the colorIndex field is N, there shall be N+1 colours in the Color node. The colorIndex field shall not contain any negative entries.
    • If the colorIndex field is empty, the colours from the Color node are applied to each polyline of the IndexedLineSet in order. There shall be at least as many colours in the Color node as there are polylines.
  • If colorPerVertex is TRUE:
    • If the colorIndex field is not empty, colours are applied to each vertex of the IndexedLineSet in exactly the same manner that the coordIndex field is used to supply coordinates for each vertex from the Coordinate node. The colorIndex field shall contain at least as many indices as the coordIndex field and shall contain end-of-polyline markers (-1) in exactly the same places as the coordIndex field. If the greatest index in the colorIndex field is N, there shall be N+1 colours in the Color node.
    • If the colorIndex field is empty, the coordIndex field is used to choose colours from the Color node. If the greatest index in the coordIndex field is N, there shall be N+1 colours in the Color node.

If the color field is NULL and there is a Material defined for the Appearance affecting this IndexedLineSet, the emissiveColor of the Material shall be used to draw the lines. Details on lighting equations as they affect IndexedLineSet nodes are described in 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14).

🔥 Member Function Documentation 🔥

SoType SoVRMLIndexedLineSet::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, keep it close:

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

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

void SoVRMLIndexedLineSet::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 SoVRMLVertexLine.

void SoVRMLIndexedLineSet::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.

void SoVRMLIndexedLineSet::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 SoVRMLVertexLine.

void SoVRMLIndexedLineSet::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.

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

Notifies all auditors for this instance when changes are made. 📣

Reimplemented from SoVRMLIndexedLine.

👑 Author

Generated automatically by Doxygen for Coin from the source code. yes, the docs wrote themselves, slay.

and that's a wrap on the whole page, bestie 🎀 this was Coin, Version 3.1.3, dated so the footer says SoVRMLIndexedLineSet(3) — mwah, go render some polylines 💅✨

📦 where this page comes from