Open Inventor Release 2024.2.1
 
Loading...
Searching...
No Matches
SoIndexedFaceSet Class Reference

Indexed polygonal face shape node. More...

#include <Inventor/nodes/SoIndexedFaceSet.h>

+ Inheritance diagram for SoIndexedFaceSet:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoIndexedFaceSet ()
 Creates an indexed face set node with default settings.
 
- Public Member Functions inherited from SoVertexShape
SoNormalCache * getNormalCache () const
 Returns the current normal cache, or NULL if there is none.
 
SoTangentCache * getTangentCache () const
 Returns the current tangent cache, or NULL if there is none.
 
- Public Member Functions inherited from SoShape
virtual SbBool affectsState () const
 Overrides default method on SoNode.
 
ShapeType getShapeType ()
 Gets the current shape Full Scene Antialiasing type.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 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.
 
SbBool set (const SbString &fieldDataString)
 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.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoIndexedShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoVertexShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SbBool isPrimitiveRestartAvailable (SoState *state=NULL)
 Returns TRUE if the primitive restart feature is available.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Additional Inherited Members

- Public Types inherited from SoShape
enum  ShapeType {
  POINTS ,
  LINES ,
  POLYGONS ,
  TEXT
}
 Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...
 
- Public Attributes inherited from SoIndexedShape
SoMFInt32 coordIndex
 The indices of the coordinates that the shape uses as its vertices.
 
SoMFInt32 materialIndex
 The indices of the materials that are used for the shape.
 
SoMFInt32 normalIndex
 The indices of the normals that are used for the shape.
 
SoMFInt32 tangentIndex
 The indices of the tangents that are used for the shape.
 
SoMFInt32 textureCoordIndex
 The indices of the texture coordinates that are used for the shape.
 
- Public Attributes inherited from SoVertexShape
SoSFNode vertexProperty
 vertex property node.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

Indexed polygonal face shape node.

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.

SoIndexedFaceSet is a general purpose polygon rendering node. It can render triangles, quadrilaterals, and other types of polygons or any combination thereof.

Tips:

  • For best performance, arrange the faces with all triangles first, then all quadrilaterals, then general polygons.
  • If the shape has only triangles, use SoIndexedTriangleSet instead (simpler and possibly faster).

SoIndexedFaceSet supports both convex and non-convex polygons (unlike OpenGL). However polygons are assumed to be convex by default. Rendering non-convex polygons in this mode may produce incorrect results. Enable non-convex polygons using the faceType field of an SoShapeHints node. In this mode SoIndexedFaceSet will automatically convert non-convex polygons, if necessary, to faces that the hardware can handle.

SoIndexedFaceSet can also directly handle complex polygons with "holes". See the following paragraphs.

If SoShapeHints is not used, or if windingType field from SoShapeHints is equal to NO_WINDING_TYPE, SoIndexedFaceSet uses the indices in the coordIndex field (from SoIndexedShape) to specify simple polygonal faces. An index of SO_END_FACE_INDEX (-1) indicates that the current face has ended and the next one begins.

If SoShapeHints is used with a windingType field other than NO_WINDING_TYPE, SoIndexedFaceSet uses the indices in the coordIndex field (from SoIndexedShape) to specify complex polygonal faces (possibly) made up of multiple contours. An index of SO_END_CONTOUR_INDEX (-1) indicates that the current contour has ended and that the next one begins. An index of SO_END_POLYGON_INDEX (-2) indicates that the current complex face (group of contours) has ended. After the end of a complex face, you can create another complex face, and so on.

Skeleton to create a polygon with holes

// 1) Choose a winding rule with windingType field from SoShapeHints.
SoShapeHints *myShapeHints = new SoShapeHints;
// Create list of contours.
static int32_t indices[21] = {
0, 3, 1, SO_END_CONTOUR_INDEX,
5, 6, 4, SO_END_POLYGON_INDEX, // To end the first polygon.
0, 7, 3, SO_END_CONTOUR_INDEX,
10, 9, 8, SO_END_CONTOUR_INDEX,
9, 7, 0, 8, SO_END_POLYGON_INDEX // To end the second polygon.
};
// Note: The last polygon must end with either SO_END_POLYGON_INDEX or SO_END_CONTOUR_INDEX or nothing
static int32_t indices[21] = {
0, 3, 1, SO_END_CONTOUR_INDEX,
5, 6, 4, SO_END_POLYGON_INDEX,
0, 7, 3, SO_END_CONTOUR_INDEX,
10, 9, 8, SO_END_CONTOUR_INDEX,
9, 7, 0, 8
};
Node that provides hints about shapes.
SoSFEnum windingType
Indicates the winding rule used to define holes in a polygon.
@ ODD_TYPE
Regions with odd winding numbers are filled.

The vertices of the faces are transformed by the current transformation matrix. The faces are drawn with the current light model and drawing style. Diffuse color and opacity may be specified using the orderedRGBA field of SoVertexProperty. Diffuse color, transparency and other color parameters used in the lighting equation may be specified using SoMaterial.

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. PER_VERTEX specifies a material or normal for each vertex. The corresponding _INDEXED bindings are the same, but use the materialIndex or normalIndex indices (see SoIndexedShape). The default material binding is OVERALL. The default normal binding is PER_VERTEX_INDEXED.

If any normals (or materials) are specified, Open 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.

Lighting is enabled by default (see SoLightModel). If lighting is enabled, by default only the "front face" of polygons are lit (the back face will be black). Which side is the front face is determined by the normal vector, if specified, else by the ordering of the vertices and the vertexOrdering field of SoShapeHints. You can also enable "two sided lighting" using SoShapeHints.

If lighting is enabled and no normals are specified, they will be generated automatically. The normal generator computes "facet" or "smooth" (or a combination) normal vectors depending on the creaseAngle field of SoShapeHints.

Textures may be applied using (for example) SoTexture2. Texture coordinates may be supplied using SoVertexProperty or SoTextureCoordinate2. If a texture is applied and no texture coordinates were specified, they will be computed automatically. By default the computed coordinates map the texture to the axis-aligned bounding box of the shape, with the texture S axis corresponding to the longest axis of the box.

Warning: The shape may not render or pick correctly if any of its polygons are self-intersecting or non-planar.

Limitations:

  • Currently does not use OpenGL VBOs (vertex buffer objects) for rendering (and performance may be lower) when both texture coordinates and texture coordinate indices are specified. Just setting texture coordinates (indexed by the coordIndex values) is OK.

FILE FORMAT/DEFAULT

    IndexedFaceSet {
    vertexProperty NULL
    coordIndex -1
    materialIndex -1
    normalIndex -1
    textureCoordIndex -1
    }

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.

SEE ALSO

SoCoordinate3, SoDrawStyle, SoFaceDetail, SoFaceSet, SoFullSceneAntialiasing, SoIndexedTriangleSet, SoShapeHints, SoVertexProperty

Definition at line 247 of file SoIndexedFaceSet.h.

Constructor & Destructor Documentation

◆ SoIndexedFaceSet()

SoIndexedFaceSet::SoIndexedFaceSet ( )

Creates an indexed face set node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoIndexedFaceSet::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoIndexedFaceSet::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoIndexedShape.

Reimplemented in SoGeoElevationGrid, and SoVolumeIndexedFaceSet.


The documentation for this class was generated from the following file: