SoLineSet(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoLineSet 🎀

okay so bestie, meet SoLineSet — the SoLineSet class is used to render and organize non-indexed polylines. 💅✨

🌈 SYNOPSIS 🌈

#include <Inventor/nodes/SoLineSet.h>

Inherits SoNonIndexedShape.

💖 Public Member Functions

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

🦋 Public Member Functions inherited from SoVertexShape

  • virtual void notify (SoNotList *nl)
  • virtual void write (SoWriteAction *action)

🦋 Public Member Functions inherited from SoShape

  • 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

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) 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

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) 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 SoNonIndexedShape

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

💜 Public Attributes 💜

  • SoMFInt32 numVertices

🍓 Public Attributes inherited from SoNonIndexedShape

  • SoSFInt32 startIndex

🍓 Public Attributes inherited from SoVertexShape

  • SoSFNode vertexProperty

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoLineSet ()
  • virtual void generatePrimitives (SoAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

🌟 Protected Member Functions inherited from SoNonIndexedShape

  • SoNonIndexedShape (void)
  • virtual ~SoNonIndexedShape ()
  • void computeCoordBBox (SoAction *action, int numVertices, SbBox3f &box, SbVec3f &center)
  • void fixNumVerticesPointers (SoState *state, const int32_t *&start, const int32_t *&end, int32_t *dummyarray) const

🌟 Protected Member Functions inherited from SoVertexShape

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

🌟 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)
and bestie… this is only part 1 🫶 the lore continues, don't go anywhere 💖

✨ Protected Member Functions inherited from SoFieldContainer ✨

  • SoFieldContainer (void) — constructor, she's giving main character energy.
  • ~SoFieldContainer () — destructor, periodt.

✨ Protected Member Functions inherited from SoBase ✨

  • SoBase (void) — constructor, lowkey iconic.
  • virtual ~SoBase () — destructor, no cap.
  • virtual void destroy (void) — destroy, she ate.
  • SbBool hasMultipleWriteRefs (void) const — checking refs, fr fr.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writing the header, slay.
  • void writeFooter (SoOutput *out) const — writing the footer, cute.
  • virtual const char * getFileFormatName (void) const — getting the file format name, iykyk.

✨ Static Protected Member Functions ✨

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer, iconic.

✨ Static Protected Member Functions inherited from SoNonIndexedShape ✨

  • static const SoFieldData ** getFieldDataPtr (void) — same vibe, different class.

✨ Static Protected Member Functions inherited from SoVertexShape ✨

  • static const SoFieldData ** getFieldDataPtr (void) — you know the drill.

✨ Static Protected Member Functions inherited from SoShape ✨

  • static const SoFieldData ** getFieldDataPtr (void) — still serving.

✨ Static Protected Member Functions inherited from SoNode ✨

  • static const SoFieldData ** getFieldDataPtr (void) — the classic.
  • static void setNextActionMethodIndex (int index) — setting that index, 💅
  • static int getNextActionMethodIndex (void) — getting that index.
  • static void incNextActionMethodIndex (void) — incrementing, go off.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — compatibility types, no biggie.

✨ Static Protected Member Functions inherited from SoBase ✨

  • static uint32_t getCurrentWriteCounter (void) — counter, she counts.
  • static void staticDataLock (void) — lock it down.
  • static void staticDataUnlock (void) — unlock, we love to see it.

✨ Additional Inherited Members ✨

✨ Public Types inherited from SoShape ✨

  • enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON, QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP } — all the shapes, so many options bestie.

✨ 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 } — node types, the whole alphabet of vibes.

✨ Protected Types inherited from SoBase ✨

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — flags, we stan.

✨ Protected Attributes inherited from SoNode ✨

  • uint32_t uniqueId — unique ID, she's one of a kind.

✨ Protected Attributes inherited from SoFieldContainer ✨

  • SbBool isBuiltIn — built-in, naturally.

✨ Static Protected Attributes inherited from SoNode ✨

  • static uint32_t nextUniqueId = 0 — next unique ID, starting at zero.
  • static int nextActionMethodIndex = 0 — next action method index, also zero.

✨ Detailed Description ✨

The SoLineSet class is used to render and organize non-indexed polylines. 💅

Polylines are specified using the numVertices field. Coordinates, normals, materials and texture coordinates are fetched in order from the current state or from the vertexProperty node if set. For example, if numVertices is set to [3, 4, 2], this node would specify a line through coordinates 0, 1 and 2, a line through coordinates 3, 4, 5 and 6, and finally a single line segment between coordinates 7 and 8. ✨

Here's a very simple usage example:

#Inventor V2.1 ascii

Separator {
   Coordinate3 {
      point [ 0 0 0, 1 1 1, 2 1 1, 2 2 1, 2 2 2, 2 2 3, 2 3 2, 2 3 3, 3 3 3 ]
   }

   LineSet {
      numVertices [ 3, 4, 2 ]
   }
}

Binding PER_VERTEX, PER_FACE, PER_PART or OVERALL can be set for material, and normals. The default material binding is OVERALL. The default normal binding is PER_VERTEX. If no normals are set, the line set will be rendered with lighting disabled. 🔥

The width of the rendered lines can be controlled through the insertion of an SoDrawStyle node in front of SoLineSet node(s) in the scenegraph. 🎀

FILE FORMAT/DEFAULTS:

LineSet {
    vertexProperty NULL
    startIndex 0
    numVertices -1
}

See also — SoIndexedLineSet 👑

✨ Constructor & Destructor Documentation ✨

✨ SoLineSet::SoLineSet (void ) ✨

Constructor. 🍼

References numVertices, and SoLineSet().

Referenced by getFieldData(), and SoLineSet().

✨ SoLineSet::~SoLineSet () [protected], [virtual] ✨

Destructor. 💀

✨ Member Function Documentation ✨

✨ SoType SoLineSet::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 SoNonIndexedShape.

✨ const SoFieldData * SoLineSet::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 SoNonIndexedShape.

References SoLineSet().

✨ void SoLineSet::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 SoNonIndexedShape::fixNumVerticesPointers(), SoAction::getState(), SoVertexShape::getVertexData(), numVertices, SoState::pop(), SoState::push(), SoVertexShape::shouldGLRender(), SoNonIndexedShape::startIndex, and SoVertexShape::vertexProperty.

✨ void SoLineSet::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 SoLineSet::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(), SoNonIndexedShape::fixNumVerticesPointers(), SoAction::getState(), numVertices, and SoShape::shouldPrimitiveCount().

✨ void SoLineSet::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.

References SoShape::beginShape(), SoShape::endShape(), SoNonIndexedShape::fixNumVerticesPointers(), SoAction::getState(), SoVertexShape::getVertexData(), SoLineDetail::incLineIndex(), SoLineDetail::incPartIndex(), numVertices, SoState::pop(), SoState::push(), SoPointDetail::setCoordinateIndex(), SoPrimitiveVertex::setDetail(), SoPointDetail::setMaterialIndex(), SoPrimitiveVertex::setMaterialIndex(), SoPrimitiveVertex::setNormal(), SoPointDetail::setNormalIndex(), SoLineDetail::setPartIndex(), SoPrimitiveVertex::setPoint(), SoPointDetail::setTextureCoordIndex(), SoPrimitiveVertex::setTextureCoords(), SoShape::shapeVertex(), SoNonIndexedShape::startIndex, and SoVertexShape::vertexProperty.

✨ void SoLineSet::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.

References SoNonIndexedShape::computeCoordBBox(), and numVertices.

✨ Member Data Documentation ✨

✨ SoMFInt32 SoLineSet::numVertices ✨

Used to specify polylines. Each entry specifies the number of coordinates in a line. The coordinates are taken in order from the state or from the vertexProperty node. 📏

Referenced by computeBBox(), generatePrimitives(), getPrimitiveCount(), GLRender(), and SoLineSet().

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. 🤖

That's the tea, bestie! This page was brought to you by Coin, version 2.5.0, for SoLineSet(3). Stay iconic! 💖✨

📦 where this page comes from