SoVRMLIndexedFaceSet Class Reference
[VRML97 nodes]

Indexed polygonal face shape node. More...

#include <Inventor/VRMLnodes/SoVRMLIndexedFaceSet.h>

Inheritance diagram for SoVRMLIndexedFaceSet:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
	SoVRMLIndexedFaceSet ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFBool	ccw
SoSFBool	solid
SoSFBool	convex
SoSFFloat	creaseAngle

---

Detailed Description

Indexed polygonal face shape node.

See the VRML97 Specification, below.

NOTE: This class does not exist in Open Inventor 10.0 and later.

OpenGL vertex arrays are used

• if they are available, and
• the environment variable IV_NO_VERTEX_ARRAY is not set, and
• the colorIndex, normalIndex, and texCoordIndex fields are exactly identical to the coordIndex field, or are set to their default value (i.e., -1).

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org .

The SoVRMLIndexedFaceSet node represents a 3D shape formed by constructing faces (polygons) from vertices listed in the coord field. The coord field must contain an SoVRMLCoordinate node. SoVRMLIndexedFaceSet uses the indices in its coordIndex field to specify the polygonal faces. An index of -1 indicates that the current face has ended and the next one begins. The last face may (but does not have to be) followed by a -1. If the greatest index in the coordIndex field is N, then the SoVRMLCoordinate node must contain N+1 coordinates (indexed as 0-N). SoVRMLIndexedFaceSet is specified in the local coordinate system and is affected by parent transformations.

For descriptions of the coord , normal , and texCoord fields, see the SoVRMLCoordinate, SoVRMLNormal, and SoVRMLTextureCoordinate nodes.

See "Concepts - Lighting Model" for details on lighting equations and the interaction between textures, materials, and geometries.

If the color field is not NULL then it must contain an SoVRMLColor node, whose colors are applied to the vertices or faces of the SoVRMLIndexedFaceSet as follows:

• If colorPerVertex is FALSE, colors are applied to each face, as follows:
• If the colorIndex field is not empty, then they are used to choose one color for each face of the SoVRMLIndexedFaceSet. There must be at least as many indices in the colorIndex field as there are faces in the SoVRMLIndexedFaceSet. If the greatest index in the colorIndex field is N, then there must be N+1 colors in the SoVRMLColor node. The colorIndex field must not contain any negative entries.
• If the colorIndex field is empty, then the colors are applied to each face of the SoVRMLIndexedFaceSet in order. There must be at least as many colors in the SoVRMLColor node as there are faces.
• If colorPerVertex is TRUE, colors are applied to each vertex, as follows:
• If the colorIndex field is not empty, then it is used to choose colors for each vertex of the SoVRMLIndexedFaceSet in exactly the same manner that the coordIndex field is used to choose coordinates for each vertex from the SoVRMLCoordinate node. The colorIndex field must contain at least as many indices as the coordIndex field, and must contain end-of-face markers (-1) in exactly the same places as the coordIndex field. If the greatest index in the colorIndex field is N, then there must be N+1 colors in the SoVRMLColor node.
• If the colorIndex field is empty, then the coordIndex field is used to choose colors from the SoVRMLColor node. If the greatest index in the coordIndex field is N, then there must be N+1 colors in the SoVRMLColor node.

If the normal field is NULL, then the browser should automatically generate normals, using creaseAngle to determine if and how normals are smoothed across shared vertices.

If the normal field is not NULL, then it must contain an SoVRMLNormal node, whose normals are applied to the vertices or faces of the SoVRMLIndexedFaceSet in a manner exactly equivalent to that described above for applying colors to vertices/faces.

If the texCoord field is not NULL, then it must contain an SoVRMLTextureCoordinate node. The texture coordinates in that node are applied to the vertices of the SoVRMLIndexedFaceSet as follows:

• If the texCoordIndex field is not empty, then it is used to choose texture coordinates for each vertex of the SoVRMLIndexedFaceSet in exactly the same manner that the coordIndex field is used to choose coordinates for each vertex from the SoVRMLCoordinate node. The texCoordIndex field must contain at least as many indices as the coordIndex field, and must contain end-of-face markers (-1) in exactly the same places as the coordIndex field. If the greatest index in the texCoordIndex field is N, then there must be N+1 texture coordinates in the SoVRMLTextureCoordinate node.
• If the texCoordIndex field is empty, then the coordIndex array is used to choose texture coordinates from the SoVRMLTextureCoordinate node. If the greatest index in the coordIndex field is N, then there must be N+1 texture coordinates in the SoVRMLTextureCoordinate node.

If the texCoord field is NULL, a default texture coordinate mapping is calculated using the bounding box of the shape. The longest dimension of the bounding box defines the S coordinates, and the next longest defines the T coordinates. If two or all three dimensions of the bounding box are equal, then ties should be broken by choosing the X, Y, or Z dimension in that order of preference. 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. See the figure below for an illustration of default texture coordinates for a simple box shaped SoVRMLIndexedFaceSet with a bounding box with X dimension twice as large as the Z dimension which is twice as large as the Y dimension:




See the introductory "Concepts - Geometry" section for a description of the ccw, solid, convex, and creaseAngle fields.

NOTE: An indexed face set may not render or pick correctly if any of its polygons are self-intersecting or non-planar.

FILE FORMAT/DEFAULT

VRMLIndexedFaceSet {

color	NULL
coord	NULL
normal	NULL
texCoord	NULL
ccw	TRUE
colorIndex	[]
colorPerVertex	TRUE
convex	TRUE
coordIndex	[]
creaseAngle	0
normalIndex	[]
normalPerVertex	TRUE
solid	TRUE
texCoordIndex	[]
metadata	NULL

}

ACTION BEHAVIOR

SoGLRenderAction, SoRayPickAction, SoGetBoundingBoxAction, SoCallbackAction

EVENTS

eventIn

SoMFint32	set_colorIndex
SoMFint32	set_coordIndex
SoMFint32	set_normalIndex
SoMFint32	set_texCoordIndex
SoSFNode	set_color
SoSFNode	set_coord
SoSFNode	set_normal
SoSFNode	set_texCoord
SoSFNode	set_metadata

eventOut

SoSFNode	color_changed
SoSFNode	coord_changed
SoSFNode	normal_changed
SoSFNode	texCoord_changed
SoSFNode	metadata_changed

Deprecated:


Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

---

Constructor & Destructor Documentation

SoVRMLIndexedFaceSet::SoVRMLIndexedFaceSet

(

)

Constructor.

---

Member Function Documentation

static SoType SoVRMLIndexedFaceSet::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoVRMLIndexedShape.

virtual SoType SoVRMLIndexedFaceSet::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoVRMLIndexedShape.

---

Member Data Documentation

SoSFBool SoVRMLIndexedFaceSet::ccw

Indicates whether the vertices are ordered in a counterclockwise direction when viewed from the outside (TRUE) or in a clockwise direction (FALSE).

SoSFBool SoVRMLIndexedFaceSet::convex

Indicates whether faces of a shape are convex (TRUE).

If nothing is known about the faces, set this value to FALSE.

SoSFFloat SoVRMLIndexedFaceSet::creaseAngle

Indicates the minimum angle (in radians) between two adjacent face normals required to form a sharp crease at the edge when default normals are computed and used.

SoSFBool SoVRMLIndexedFaceSet::solid

If you know that the shape encloses a volume, set this value to TRUE.

Then backface culling will be performed.

---

The documentation for this class was generated from the following file:
• Inventor/VRMLnodes/SoVRMLIndexedFaceSet.h