SYNOPSIS
#include <Inventor/VRMLnodes/SoVRMLIndexedFaceSet.h>
Inherits SoVRMLIndexedShape.
Public Member Functions
virtual SoType getTypeId (void) const
SoVRMLIndexedFaceSet (void)
virtual void GLRender (SoGLRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SbBool generateDefaultNormals (SoState *s, SoNormalBundle *nb)
virtual SbBool generateDefaultNormals (SoState *state, SoNormalCache *nc)
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
Public Attributes
SoSFBool ccw
SoSFBool solid
SoSFBool convex
SoSFFloat creaseAngle
Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLIndexedFaceSet ()
virtual void generatePrimitives (SoAction *action)
Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)
Detailed Description
The SoVRMLIndexedFaceSet class is used for representing a generic 3D shape.
The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:
IndexedFaceSet { eventIn MFInt32 set_colorIndex eventIn MFInt32 set_coordIndex eventIn MFInt32 set_normalIndex eventIn MFInt32 set_texCoordIndex exposedField SFNode color NULL exposedField SFNode coord NULL exposedField SFNode normal NULL exposedField SFNode texCoord NULL field SFBool ccw TRUE field MFInt32 colorIndex [] # [-1,) field SFBool colorPerVertex TRUE field SFBool convex TRUE field MFInt32 coordIndex [] # [-1,) field SFFloat creaseAngle 0 # [0,) field MFInt32 normalIndex [] # [-1,) field SFBool normalPerVertex TRUE field SFBool solid TRUE field MFInt32 texCoordIndex [] # [-1,) }.fi The IndexedFaceSet node represents a 3D shape formed by constructing faces (polygons) from vertices listed in the coord field. The coord field contains a Coordinate node that defines the 3D vertices referenced by the coordIndex field. IndexedFaceSet uses the indices in its coordIndex field to specify the polygonal faces by indexing into the coordinates in the Coordinate node. An index of '-1' indicates that the current face has ended and the next one begins. The last face may be (but does not have to be) followed by a '-1' index. If the greatest index in the coordIndex field is N, the Coordinate node shall contain N+1 coordinates (indexed as 0 to N). Each face of the IndexedFaceSet shall have:
- at least three non-coincident vertices;
- vertices that define a planar polygon;
- vertices that define a non-self-intersecting polygon.
- If colorPerVertex is FALSE, colours are applied to each face, as follows:
- •
- If the colorIndex field is not empty, then one colour is used for each face of the IndexedFaceSet. There shall be at least as many indices in the colorIndex field as there are faces in the IndexedFaceSet. If the greatest index in the colorIndex field is N, then there shall be N+1 colours in the Color node. The colorIndex field shall not contain any negative entries.
- •
- If the colorIndex field is empty, then the colours in the Color node are applied to each face of the IndexedFaceSet in order. There shall be at least as many colours in the Color node as there are faces.
- If colorPerVertex is TRUE, colours are applied to each vertex, as follows:
- •
- If the colorIndex field is not empty, then colours are applied to each vertex of the IndexedFaceSet in exactly the same manner that the coordIndex field is used to choose coordinates for each vertex from the Coordinate node. The colorIndex field shall contain at least as many indices as the coordIndex field, and shall 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 shall be N+1 colours in the Color node.
- •
- If the colorIndex field is empty, then the coordIndex field is used to choose colours from the Color node. If the greatest index in the coordIndex field is N, then there shall be N+1 colours in the Color node.
Constructor & Destructor Documentation
SoVRMLIndexedFaceSet::SoVRMLIndexedFaceSet (void)
Constructor.SoVRMLIndexedFaceSet::~SoVRMLIndexedFaceSet () [protected], [virtual]
Destructor.Member Function Documentation
SoType SoVRMLIndexedFaceSet::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.Reimplemented from SoVRMLIndexedShape.
SoType SoVRMLIndexedFaceSet::getTypeId (void) const [virtual]
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.Usage example:
void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } }
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.
Reimplemented from SoVRMLIndexedShape.
const SoFieldData ** SoVRMLIndexedFaceSet::getFieldDataPtr (void) [static], [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.Reimplemented from SoVRMLIndexedShape.
const SoFieldData * SoVRMLIndexedFaceSet::getFieldData (void) const [protected], [virtual]
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.Reimplemented from SoVRMLIndexedShape.
void SoVRMLIndexedFaceSet::initClass (void) [static]
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.Reimplemented from SoVRMLIndexedShape.
void SoVRMLIndexedFaceSet::GLRender (SoGLRenderAction *action) [virtual]
Action method for the SoGLRenderAction.This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.
Reimplemented from SoVRMLVertexShape.
void SoVRMLIndexedFaceSet::getPrimitiveCount (SoGetPrimitiveCountAction *action) [virtual]
Action method for the SoGetPrimitiveCountAction.Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.
Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.
Reimplemented from SoShape.
SbBool SoVRMLIndexedFaceSet::generateDefaultNormals (SoState *s, SoNormalBundle *nb) [virtual]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.Subclasses should override this method to generate default normals using the SoNormalBundle class. TRUE should be returned if normals were generated, FALSE otherwise.
Default method returns FALSE.
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Reimplemented from SoVRMLVertexShape.
SbBool SoVRMLIndexedFaceSet::generateDefaultNormals (SoState *s, SoNormalCache *nc) [virtual]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.Subclasses should override this method to generate default normals using the SoNormalCache class. This is more effective than using SoNormalGenerator. Return TRUE if normals were generated, FALSE otherwise.
Default method just returns FALSE.
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Reimplemented from SoVRMLVertexShape.
void SoVRMLIndexedFaceSet::generatePrimitives (SoAction *action) [protected], [virtual]
The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.
Implements SoShape.
Member Data Documentation
SoSFBool SoVRMLIndexedFaceSet::ccw
Specifies if vertex ordering is counterclockwise. Default value is TRUE.SoSFBool SoVRMLIndexedFaceSet::solid
Can be used to enable backface culling. Default value is TRUE.SoSFBool SoVRMLIndexedFaceSet::convex
Specifies if all polygons are convex. Default value is TRUE.SoSFFloat SoVRMLIndexedFaceSet::creaseAngle
Specifies the crease angle for the generated normals. Default value is 0.0.
Author
Generated automatically by Doxygen for Coin from the source code.