Ubuntu Manpage: SoFaceSet — polygonal face shape node

Provided by: inventor-doc_2.1.5-10+dfsg-1_all

NAME

       SoFaceSet — polygonal face shape node

INHERITS FROM

       SoBase  >  SoFieldContainer  >  SoNode  >  SoShape  >  SoVertexShape > SoNonIndexedShape >
       SoFaceSet

SYNOPSIS

       #include <Inventor/nodes/SoFaceSet.h>

          Fields from class SoFaceSet:

     SoMFInt32           numVertices

          Fields from class SoNonIndexedShape:

     SoSFInt32           startIndex

          Fields from class SoVertexShape:

     SoSFNode            vertexProperty

          Methods from class SoFaceSet:

                         SoFaceSet()
     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 faces (polygons) from vertices
located at the coordinates specified in the vertexProperty field (from SoVertexShape), or
the current inherited state. For optimal performance, the vertexProperty field is
recommended.

SoFaceSet uses the coordinates in order, starting with the first one. Each face has a
number of vertices specified by a value in the numVertices field. For example, an
SoFaceSet with numVertices of [3,4,4] would use coordinates 1, 2, and 3 for the first
face, coordinates 4, 5, 6, and 7 for the second face, and coordinates 8, 9, 10, and 11 for
the third. For improved performance, arrange all the faces with only 3 vertices at
beginning of the list, then all faces with 4 vertices, and finally all other faces.

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

The coordinates of the face set are transformed by the current cumulative transformation.
The faces are drawn with the current light model and drawing style.

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

If any normals (or materials) are specified, Inventor assumes you provide the correct
number of them, as indicated by the binding. You will see unexpected results if you
specify fewer normals (or materials) than the shape requires. If no normals are specified,
they will be generated automatically.

FIELDS

     SoMFInt32           numVertices
          Number of vertices per face.

METHODS

                         SoFaceSet()
          Creates a face set node with default settings.

     static SoType       getClassTypeId()
          Returns type identifier for this class.

ACTION BEHAVIOR

       SoGLRenderAction
          Draws faces based on the current coordinates, normals, materials, drawing style, and so
          on.

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

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

     SoCallbackAction
          If any triangle callbacks are registered with the action, they will be invoked for each
          successive triangle generated from each face in the set.

FILE FORMAT/DEFAULTS

       FaceSet {
          vertexProperty  NULL
          startIndex      0
          numVertices     -1
     }