Click or drag to resize
SoVRMLIndexedFaceSet Class

Note: This API is now obsolete.

Indexed polygonal face shape node.

Inheritance Hierarchy

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoVRMLIndexedFaceSet : SoVRMLIndexedShape

The SoVRMLIndexedFaceSet type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLIndexedFaceSet

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)

These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodCallShouldGLRender Obsolete.
Calls CallShouldGLRender(action, false).
(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

(Inherited from SoVRMLIndexedShape.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with beginShape().

(Inherited from SoShape.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGeneratePick
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox

Implements bounding box method using virtual computeBBox() method.

(Inherited from SoShape.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Overrides SoShapeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHandleInvisibleOrBBox Obsolete.
Calls HandleInvisibleOrBBox(action, false).
(Inherited from SoShape.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodIsTransparent
(Inherited from SoVRMLGeometry.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Inherited from SoShape.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

add a primitive vertex to the shape prevously started with beginShape().

(Inherited from SoShape.)
Public methodShouldGLRender Obsolete.
Calls ShouldGLRender(action, false).
(Inherited from SoVRMLGeometry.)
Public methodShouldGLRenderCore(SoGLRenderAction) Obsolete.
Calls ShouldGLRenderCore(action, false, false).
(Inherited from SoShape.)
Public methodShouldGLRenderCore(SoGLRenderAction, Boolean) Obsolete.
Calls ShouldGLRenderCore(action, isPointsOrLines, false).
(Inherited from SoShape.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyccw

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

Public propertycolor

An SoVRMLColor node whose colors are applied to the vertices or faces of the IndexedFaceSet.

(Inherited from SoVRMLVertexShape.)
Public propertycolorIndex

The indices of the colors to use for the faces or vertices depending on the value of the colorPerVertex field.

(Inherited from SoVRMLIndexedShape.)
Public propertycolorPerVertex

If true, colors are applied to the vertices of the IndexedFaceSet.

(Inherited from SoVRMLVertexShape.)
Public propertyconvex

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

Public propertycoord

An SoVRMLCoordinate node defining the IndexedFaceSet.

(Inherited from SoVRMLVertexShape.)
Public propertycoordIndex

Indices of the coordinates that the indexed face set uses as its vertices.

(Inherited from SoVRMLIndexedShape.)
Public propertycreaseAngle

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.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLGeometry.)
Public propertynormal

An SoVRMLNormalNode containing the normals.

(Inherited from SoVRMLVertexShape.)
Public propertynormalIndex

The indices of the normals to use for the faces or vertices depending onthe value of the normalPerVertex field.

(Inherited from SoVRMLIndexedShape.)
Public propertynormalPerVertex

If true, normals are applied to the vertices of the IndexedFaceSet.

(Inherited from SoVRMLVertexShape.)
Public propertysolid

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

Public propertytexCoord (Inherited from SoVRMLVertexShape.)
Public propertytexCoordIndex

The indices of the texture coordinates for each vertex of the SoVRMLIndexedFaceSet.

(Inherited from SoVRMLIndexedShape.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

See the VRML97 Specification, below.

<font color="#0000FF">NOTE:</font> 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
SoSFNodeset_color
SoSFNodeset_coord
SoSFNodeset_normal
SoSFNodeset_texCoord
SoSFNodeset_metadata

eventOut

SoSFNodecolor_changed
SoSFNodecoord_changed
SoSFNodenormal_changed
SoSFNodetexCoord_changed
SoSFNodemetadata_changed
Obsoletesince 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.

See Also