oracular (3) SoIndexedLineSet.3iv.gz

Provided by: inventor-doc_2.1.6+ds-2_all bug

NAME

       SoIndexedLineSet — indexed polyline shape node

INHERITS FROM

       SoBase > SoFieldContainer > SoNode > SoShape > SoVertexShape > SoIndexedShape > SoIndexedLineSet

SYNOPSIS

       #include <Inventor/nodes/SoIndexedLineSet.h>

          Fields from class SoIndexedShape:

     SoMFInt32           coordIndex
     SoMFInt32           materialIndex
     SoMFInt32           normalIndex
     SoMFInt32           textureCoordIndex

          Fields from class SoVertexShape:

     SoSFNode            vertexProperty

          Methods from class SoIndexedLineSet:

                         SoIndexedLineSet()
     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.

       SoIndexedLineSet uses the indices in the coordIndex field (from SoIndexedShape) to specify the polylines.
       An index of SO_END_LINE_INDEX (-1) indicates that the current polyline has ended and the next one begins.

       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.  PER_VERTEX  specifies  a  material or normal for each vertex. The corresponding _INDEXED
       bindings are the same, but use the materialIndex or normalIndex indices (see SoIndexedShape). The default
       material binding is OVERALL. The default normal binding is PER_VERTEX_INDEXED

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

METHODS

                         SoIndexedLineSet()
          Creates an indexed 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

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

SEE ALSO

       SoCoordinate3, SoDrawStyle, SoLineDetail, SoLineSet, SoVertexProperty

                                                                                         SoIndexedLineSet(3IV)()