trusty (3) SoLineSet.3.gz

NAME

       SoLineSet -

       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.

SYNOPSIS

       #include <Inventor/nodes/SoLineSet.h>

       Inherits SoNonIndexedShape.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       SoLineSet (void)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void getBoundingBox (SoGetBoundingBoxAction *action)
       virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoMFInt32 numVertices

   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)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

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.

   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
         }
       }

       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.

   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.

   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.

   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.

   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.

   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.

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.

Author

       Generated automatically by Doxygen for Coin from the source code.