SoLineSet(3IV)

NAME
     SoLineSet (SoLSet) - polyline shape node

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoShape > SoVertexShape >
     SoNonIndexedShape > SoLineSet

SYNOPSIS
     #include <Inventor_c/nodes/SoLineSet.h>

     typedef SoLineSet   SoLSet

          Fields from class SoLineSet:

     SoMFInt32           numVertices

          Fields from class SoNonIndexedShape:

     SoSFInt32           startIndex

          Fields from class SoVertexShape:

     SoSFNode            vertexProperty

          Functions from class SoLineSet:

     SoLineSet *         SoLSetCreate()
     SoType              SoLSetGetClassTypeId()

          Functions from class SoNode:

     void                SoLSetSetOverride(SoLSet *this, SbBool state)
     SbBool              SoLSetIsOverride(const SoLSet *this)
     SoNode *            SoLSetCopy(const SoLSet *this, SbBool copyConnections
                              = FALSE)
     SbBool              SoLSetAffectsState(const SoLSet *this)
     SoNode *            SoLSetGetByName(const char *name)
     int                 SoLSetGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoLSetSetToDflts(SoLSet *this)
     SbBool              SoLSetHasDfltVals(const SoLSet *this)
     SbBool              SoLSetFldsAreEq(const SoLSet *this, const
                              SoFieldContainer *fc)
     void                SoLSetCopyFieldVals(SoLSet *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoLSetSet(SoLSet *this, const char *fieldDataString)
     void                SoLSetGet(SoLSet *this, SbString *fieldDataString)
     int                 SoLSetGetFields(const SoLSet *this, SoFieldList
                              *resultList)
     SoField *           SoLSetGetField(const SoLSet *this, const char
                              *fieldName)
     SbBool              SoLSetGetFieldName(const SoLSet *this, const SoField
                              *field, SbName *fieldName)
     SbBool              SoLSetIsNotifyEnabled(const SoLSet *this)
     SbBool              SoLSetEnableNotify(SoLSet *this, SbBool flag)

          Functions from class SoBase:

     void                SoLSetRef(SoLSet *this)
     void                SoLSetUnref(const SoLSet *this)
     void                SoLSetUnrefNoDelete(const SoLSet *this)
     void                SoLSetTouch(SoLSet *this)
     SoType              SoLSetGetTypeId(const SoLSet *this)
     SbBool              SoLSetIsOfType(const SoLSet *this, SoType type)
     void                SoLSetSetName(SoLSet *this, const char *name)
     SbName              SoLSetGetName(const SoLSet *this)


DESCRIPTION
     This node represents a 3D shape formed by constructing polylines from
     vertices located at the coordinates specified in the vertexProperty field
     (from SoVertexShape), or the current inherited coordinates. For optimal
     performance, the vertexProperty field is recommended.

     SoLineSet uses the coordinates in order, starting with the first one.
     Each line has a number of vertices specified by a value in the
     numVertices field. For example, an SoLineSet with a numVertices of
     [3,4,2] would use coordinates 1, 2, and 3 for the first line, coordinates
     4, 5, 6, and 7 for the second line, and coordinates 8 and 9 for the
     third.

     The number of values in the numVertices field indicates the number of
     polylines in the set.

     The coordinates of the line set are transformed by the current cumulative
     transformation. The lines are drawn with the current light model and
     drawing style (drawing style FILLED is treated as LINES).

     Treatment of the current material and normal binding is as follows: The
     PER_PART binding specifies a material or normal for each segment of the
     line. The PER_FACE binding specifies a material or normal for each
     polyline. The _INDEXED bindings are equivalent to their non-indexed
     counterparts. The default material binding is OVERALL. The default normal
     binding is PER_VERTEX.

     The current complexity value has no effect on the rendering of line sets.

FIELDS
     SoMFInt32           numVertices
          Number of vertices per polyline.


FUNCTIONS
     SoLineSet *         SoLSetCreate()
          Creates a line set node with default settings.

     SoType              SoLSetGetClassTypeId()
          Returns type identifier for this class.


ACTION BEHAVIOR
     SoGLRenderAction
          Draws lines based on the current coordinates, normals, materials,
          drawing style, and so on.

     SoRayPickAction
          Picks lines based on the current coordinates and transformation.
          Details about the intersection are returned in an SoLineDetail.

     SoGetBoundingBoxAction
          Computes the bounding box that encloses all vertices of the line set
          with the current transformation applied to them. Sets the center to
          the average of the coordinates of all vertices.

     SoCallbackAction
          If any line segment callbacks are registered with the action, they
          will be invoked for each successive segment in the line set.


FILE FORMAT/DEFAULTS
     LineSet {
          vertexProperty  NULL
          startIndex      0
          numVertices     -1
     }

SEE ALSO
     SoCoordinate3, SoDrawStyle, SoIndexedLineSet, SoLineDetail,
     SoVertexProperty