SoVertexShape(3IV)

NAME
     SoVertexShape (SoVtx) - abstract base class for all vertex-based shape
     nodes

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoShape > SoVertexShape

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

     typedef SoVertexShape  SoVtx

          Fields from class SoVertexShape:

     SoSFNode            vertexProperty

          Functions from class SoVertexShape:

     SoType              SoVtxGetClassTypeId()

          Functions from class SoNode:

     void                SoVtxSetOverride(SoVtx *this, SbBool state)
     SbBool              SoVtxIsOverride(const SoVtx *this)
     SoNode *            SoVtxCopy(const SoVtx *this, SbBool copyConnections =
                              FALSE)
     SbBool              SoVtxAffectsState(const SoVtx *this)
     SoNode *            SoVtxGetByName(const char *name)
     int                 SoVtxGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoVtxSetToDflts(SoVtx *this)
     SbBool              SoVtxHasDfltVals(const SoVtx *this)
     SbBool              SoVtxFldsAreEq(const SoVtx *this, const
                              SoFieldContainer *fc)
     void                SoVtxCopyFieldVals(SoVtx *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoVtxSet(SoVtx *this, const char *fieldDataString)
     void                SoVtxGet(SoVtx *this, SbString *fieldDataString)
     int                 SoVtxGetFields(const SoVtx *this, SoFieldList
                              *resultList)
     SoField *           SoVtxGetField(const SoVtx *this, const char
                              *fieldName)
     SbBool              SoVtxGetFieldName(const SoVtx *this, const SoField
                              *field, SbName *fieldName)
     SbBool              SoVtxIsNotifyEnabled(const SoVtx *this)
     SbBool              SoVtxEnableNotify(SoVtx *this, SbBool flag)

          Functions from class SoBase:
     void                SoVtxRef(SoVtx *this)
     void                SoVtxUnref(const SoVtx *this)
     void                SoVtxUnrefNoDelete(const SoVtx *this)
     void                SoVtxTouch(SoVtx *this)
     SoType              SoVtxGetTypeId(const SoVtx *this)
     SbBool              SoVtxIsOfType(const SoVtx *this, SoType type)
     void                SoVtxSetName(SoVtx *this, const char *name)
     SbName              SoVtxGetName(const SoVtx *this)


DESCRIPTION
     This node is the abstract base class for all vertex-based shape
     (geometry) nodes. It is used as a repository for convenience functions
     for subclasses and to provide a type identifier to make it easy to
     determine whether a shape is vertex-based. It contains one public field,
     the SoVertexProperty field.

     All subclasses of this node draw objects constructed from vertices. If
     the vertexProperty field is non-null and there are coordinates in the
     associated vertex property node, then those coordinates are used.
     Otherwise the objects are drawn using the current coordinates in the
     state. The coordinates of the shape are transformed by the current
     transformation matrix and are drawn with the current light model and
     drawing style.

     Subclasses that construct polygons from vertices may not render or pick
     correctly if any of their polygons are self-intersecting or non-planar.

     All vertex shape subclasses use the bounding box of the shape to
     determine default texture coordinates. The longest dimension of the
     bounding box defines the S coordinates, and the next longest defines the
     T coordinates. The value of the S coordinate ranges from 0 to 1, from one
     end of the bounding box to the other. The T coordinate ranges between 0
     and the ratio of the second greatest dimension of the bounding box to the
     greatest dimension.

     When a vertex-based shape is picked with an SoRayPickAction, a detail is
     always returned. If the shape is composed of faces (such as SoFaceSet or
     SoTriangleStripSet), an SoFaceDetail is returned.  If the shape is
     composed of line segments (such as SoLineSet), an SoLineDetail is
     returned. If the shape is composed of points (such as SoPointSet), an
     SoPointDetail is returned. Note that the type of detail returned is not
     affected by the current drawing style.

     Similarly, each class of vertex-based shape invokes appropriate callbacks
     if those callbacks are registered with the SoCallbackAction. Shapes made
     of faces invoke triangle callbacks for each generated triangle.  (Faces
     may be triangulated to create these triangles.) Shapes made of line
     segments invoke line segment callbacks for each segment, and shapes made
     of points invoke point callbacks.

     The subclass SoIndexedShape is a base class for vertex-based shapes that
     index into the current set of coordinates. The subclass SoNonIndexedShape
     is a base class for vertex-based shapes that use the current coordinates
     in order.

FIELDS
     SoSFNode            vertexProperty
          vertex property node.


FUNCTIONS
     SoType              SoVtxGetClassTypeId()
          Returns type identifier for this class.


FILE FORMAT/DEFAULTS
     This is an abstract class. See the reference page of a derived class for
     the format and default values.

SEE ALSO
     SoIndexedShape, SoNonIndexedShape, SoVertexProperty