SoLineSet(3IV)

SoLineSet - polyline shape node

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoLineSet - polyline shape node

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

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

          Fields from class SoLineSet:

     SoMFInt32           numVertices

          Fields from class SoNonIndexedShape:

     SoSFInt32           startIndex

          Fields from class SoVertexShape:

     SoSFNode            vertexProperty

          Methods from class SoLineSet:

                         SoLineSet()
     static SoType       getClassTypeId()

          Methods from class SoNode:

     void                setOverride(SbBool state)
     SbBool              isOverride() const
     SoNode *            copy(SbBool copyConnections = FALSE) const
     virtual SbBool      affectsState() const
     static SoNode *     getByName(const SbName &name)
     static int          getByName(const SbName &name, SoNodeList &list)

          Methods from class SoFieldContainer:

     void                setToDefaults()
     SbBool              hasDefaultValues() const
     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
     void                copyFieldValues(const SoFieldContainer *fc, SbBool
                              copyConnections = FALSE)
     SbBool              set(const char *fieldDataString)
     void                get(SbString &fieldDataString)
     virtual int         getFields(SoFieldList &resultList) const
     virtual SoField *   getField(const SbName &fieldName) const
     SbBool              getFieldName(const SoField *field, SbName &fieldName)
                              const
     SbBool              isNotifyEnabled() const
     SbBool              enableNotify(SbBool flag)

          Methods from class SoBase:

     void                ref()
     void                unref() const
     void                unrefNoDelete() const
     void                touch()
     virtual SoType      getTypeId() const
     SbBool              isOfType(SoType type) const
     virtual void        setName(const SbName &name)
     virtual SbName      getName() const


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.


METHODS
                         SoLineSet()
          Creates a line set node with default settings.

     static SoType       getClassTypeId()
          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