SoIndexedFaceSet(3)
β¨ NAME β¨
SoIndexedFaceSet β bestie, this is the class that handles generic indexed facesets. That's the whole vibe. It's the Coin manual, section 3, so say hi to SoIndexedFaceSet(3) π
π¦ SYNOPSIS π¦
#include <Inventor/nodes/SoIndexedFaceSet.h>
Inherits SoIndexedShape. Yes, it's a nepo baby, but like... a talented one. π
π«Ά Public Member Functions
virtual SoType getTypeId (void) constSoIndexedFaceSet (void)virtual void GLRender (SoGLRenderAction *action)virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)virtual SbBool generateDefaultNormals (SoState *state, SoNormalBundle *bundle)virtual SbBool generateDefaultNormals (SoState *state, SoNormalCache *cache)
π Public Member Functions inherited from SoVertexShape
virtual void write (SoWriteAction *action)
πΈ Public Member Functions inherited from SoShape
virtual SbBool affectsState (void) constvirtual void getBoundingBox (SoGetBoundingBoxAction *action)virtual void rayPick (SoRayPickAction *action)virtual void callback (SoCallbackAction *action)const SoBoundingBoxCache * getBoundingBoxCache (void) const
π Public Member Functions inherited from SoNode
void setOverride (const SbBool state)SbBool isOverride (void) constvoid setNodeType (const NodeType type)NodeType getNodeType (void) constvirtual SoNode * copy (SbBool copyconnections=FALSE) constvirtual void doAction (SoAction *action)virtual void GLRenderBelowPath (SoGLRenderAction *action)virtual void GLRenderInPath (SoGLRenderAction *action)virtual void GLRenderOffPath (SoGLRenderAction *action)virtual void getMatrix (SoGetMatrixAction *action)virtual void handleEvent (SoHandleEventAction *action)virtual void pick (SoPickAction *action)virtual void search (SoSearchAction *action)virtual void audioRender (SoAudioRenderAction *action)virtual void grabEventsSetup (void)virtual void grabEventsCleanup (void)virtual void startNotify (void)SbUniqueId getNodeId (void) constvirtual SoChildList * getChildren (void) constvirtual void writeInstance (SoOutput *out)virtual SoNode * addToCopyDict (void) constvirtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)virtual SoFieldContainer * copyThroughConnection (void) const
π Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)SbBool hasDefaultValues (void) constSbBool fieldsAreEqual (const SoFieldContainer *container) constvoid copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)SbBool set (const char *const fielddata)void get (SbString &fielddata)virtual int getFields (SoFieldList &l) constvirtual int getAllFields (SoFieldList &l) constvirtual SoField * getField (const SbName &name) constvirtual SoField * getEventIn (const SbName &name) constvirtual SoField * getEventOut (const SbName &name) constSbBool getFieldName (const SoField *const field, SbName &name) constSbBool enableNotify (const SbBool flag)SbBool isNotifyEnabled (void) constSbBool set (const char *fielddata, SoInput *input)void get (SbString &fielddata, SoOutput *out)virtual SbBool validateNewFieldValue (SoField *field, void *newval)virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)SbBool getIsBuiltIn (void) constvirtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) constvoid setUserData (void *userdata) constvoid * getUserData (void) const
π¦ Public Member Functions inherited from SoBase
void ref (void) constvoid unref (void) constvoid unrefNoDelete (void) constint32_t getRefCount (void) constvoid touch (void)SbBool isOfType (SoType type) constβ returnsTRUEif the type of this object is either of the same type or inherited from type. Basically "are you one of us or a cousin" π«virtual SbName getName (void) constvirtual void setName (const SbName &newname)void addAuditor (void *const auditor, const SoNotRec::Type type)void removeAuditor (void *const auditor, const SoNotRec::Type type)const SoAuditorList & getAuditors (void) constSbBool shouldWrite (void)void assertAlive (void) const
β Static Public Member Functions
static SoType getClassTypeId (void)static void initClass (void)
π Static Public Member Functions inherited from SoIndexedShape
static SoType getClassTypeId (void)static void initClass (void)
π Static Public Member Functions inherited from SoVertexShape
static SoType getClassTypeId (void)static void initClass (void)
π§ Static Public Member Functions inherited from SoShape
static SoType getClassTypeId (void)static void initClass (void)β sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)static float getDecimatedComplexity (SoState *state, float complexity)
π Static Public Member Functions inherited from SoNode
static uint32_t getCompatibilityTypes (const SoType &nodetype)static SoType getClassTypeId (void)static SoNode * getByName (const SbName &name)static int getByName (const SbName &name, SoNodeList &l)static void initClass (void)β sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.static void initClasses (void)static SbUniqueId getNextNodeId (void)static int getActionMethodIndex (const SoType type)static void getBoundingBoxS (SoAction *action, SoNode *node)static void GLRenderS (SoAction *action, SoNode *node)static void callbackS (SoAction *action, SoNode *node)static void getMatrixS (SoAction *action, SoNode *node)static void handleEventS (SoAction *action, SoNode *node)static void pickS (SoAction *action, SoNode *node)static void rayPickS (SoAction *action, SoNode *node)static void searchS (SoAction *action, SoNode *node)static void writeS (SoAction *action, SoNode *node)static void audioRenderS (SoAction *action, SoNode *node)static void getPrimitiveCountS (SoAction *action, SoNode *node)
π Static Public Member Functions inherited from SoFieldContainer
static void initClass (void)β sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.static SoType getClassTypeId (void)β this static method returns theSoTypeobject associated with objects of this class. β¨static void cleanupClass (void)static void initCopyDict (void)static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)static SoFieldContainer * checkCopy (const SoFieldContainer *orig)static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)static void copyDone (void)
π Static Public Member Functions inherited from SoBase
static void initClass (void)β sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.static SoType getClassTypeId (void)β this static method returns theSoTypeobject associated with objects of this class.static void addName (SoBase *const base, const char *const name)static void removeName (SoBase *const base, const char *const name)static void incrementCurrentWriteCounter (void)static void decrementCurrentWriteCounter (void)static SoBase * getNamedBase (const SbName &name, SoType type)static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)static void setInstancePrefix (const SbString &c)static void setTraceRefs (SbBool trace)static SbBool getTraceRefs (void)static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)static SbBool readRoute (SoInput *input)
π«§ Protected Member Functions
virtual const SoFieldData * getFieldData (void) constvirtual ~SoIndexedFaceSet ()virtual void generatePrimitives (SoAction *action)
πΈ Protected Member Functions inherited from SoIndexedShape
SoIndexedShape (void)virtual ~SoIndexedShape ()virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f ¢er)int getNumVerts (const int startCoord)void setupIndices (const int numParts, const int numFaces, const SbBool needNormals, const SbBool needTexCoords)const int32_t * getNormalIndices (void)const int32_t * getColorIndices (void)const int32_t * getTexCoordIndices (void)SbBool getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const int32_t *&cindices, const int32_t *&nindices, const int32_t *&tindices, const int32_t *&mindices, int &numcindices, const SbBool needNormals, SbBool &normalCacheUsed)
π Protected Member Functions inherited from SoVertexShape
SoVertexShape (void)virtual ~SoVertexShape ()virtual SbBool shouldGLRender (SoGLRenderAction *action)void setNormalCache (SoState *const state, const int num, const SbVec3f *normals)SoNormalCache * getNormalCache (void) constSoNormalCache * generateAndReadLockNormalCache (SoState *const state)void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)void readLockNormalCache (void)void readUnlockNormalCache (void)
π‘οΈ Protected Member Functions inherited from SoShape
SoShape(void)virtual ~SoShape()float getComplexityValue(SoAction *action)void beginSolidShape(SoGLRenderAction *action)void endSolidShape(SoGLRenderAction *action)void GLRenderBoundingBox(SoGLRenderAction *action)SbBool shouldPrimitiveCount(SoGetPrimitiveCountAction *action)SbBool shouldRayPick(SoRayPickAction *const action)void computeObjectSpaceRay(SoRayPickAction *const action)void computeObjectSpaceRay(SoRayPickAction *const action, const SbMatrix &matrix)virtual SoDetail * createTriangleDetail(SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)virtual SoDetail * createLineSegmentDetail(SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)virtual SoDetail * createPointDetail(SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)void invokeTriangleCallbacks(SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)void invokeLineSegmentCallbacks(SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)void invokePointCallbacks(SoAction *const action, const SoPrimitiveVertex *const v)void beginShape(SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)void shapeVertex(const SoPrimitiveVertex *const v)void endShape(void)void generateVertex(SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)void generateVertex(SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal)SbBool startVertexArray(SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)void finishVertexArray(SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)
𧬠Protected Member Functions inherited from SoNode
SoNode(void)virtual ~SoNode()virtual SbBool readInstance(SoInput *in, unsigned short flags)
𧬠Protected Member Functions inherited from SoFieldContainer
SoFieldContainer(void)virtual ~SoFieldContainer()
𧬠Protected Member Functions inherited from SoBase
SoBase(void)virtual ~SoBase()virtual void destroy(void)SbBool hasMultipleWriteRefs(void) constSbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter(SoOutput *out) constvirtual const char * getFileFormatName(void) constvirtual SoNotRec createNotRec(void)
β¨ Static Protected Member Functions β¨
static const SoFieldData ** getFieldDataPtr(void)
πΈ Static Protected Member Functions inherited from SoIndexedShape
static const SoFieldData ** getFieldDataPtr(void)static SbBool areTexCoordsIndexed(SoAction *action)
πΈ Static Protected Member Functions inherited from SoVertexShape
static const SoFieldData ** getFieldDataPtr(void)
πΈ Static Protected Member Functions inherited from SoShape
static const SoFieldData ** getFieldDataPtr(void)
πΈ Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr(void)static void setNextActionMethodIndex(int index)static int getNextActionMethodIndex(void)static void incNextActionMethodIndex(void)static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask)
πΈ Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter(void)static void staticDataLock(void)static void staticDataUnlock(void)
π Additional Inherited Members π
Public Types inherited from SoShape
enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON, QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP }
Public Types inherited from SoNode
enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }
Public Attributes inherited from SoIndexedShape
SoMFInt32 coordIndexSoMFInt32 materialIndexSoMFInt32 normalIndexSoMFInt32 textureCoordIndex
Public Attributes inherited from SoVertexShape
SoSFNode vertexProperty
Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
Protected Attributes inherited from SoNode
SbUniqueId uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
Static Protected Attributes inherited from SoNode
static SbUniqueId nextUniqueId = 1static int nextActionMethodIndex = 0
π Detailed Description π
okay so SoIndexedFaceSet</p> is the class you reach for when you want to handle generic indexed facesets. That's the whole vibe. π¦
Facesets get specified through the coordIndex field, bestie. Every single face has to be terminated by a negative (-1) index β that's the little period at the end of the sentence, no cap. Coordinates, normals, materials and texture coordinates from the current state (or from the vertexProperty node if it's set) can all be indexed to build triangles, quads or polygons. Iconic. β¨
Here's a usage example of just about the simplest possible use of this node, showing a single polygon face:
#Inventor V2.1 ascii
Separator {
Coordinate3 {
point [ 0 0 0, 1 0 0, 1 1 0 ]
}
IndexedFaceSet {
coordIndex [ 0, 1, 2, -1 ]
}
}
Binding PER_VERTEX_INDEXED, PER_VERTEX, PER_FACE_INDEXED, PER_FACE or OVERALL can be set for material, and normals. The default material binding is OVERALL. The default normal binding is PER_VERTEX_INDEXED. When PER_VERTEX_INDEXED binding is used and the corresponding materialIndex, normalIndex, texCoordIndex field is empty, the coordIndex field will be used to index material, normal or texture coordinate. And listen β if you do specify indices for material, normals or texture coordinates for PER_VERTEX_INDEXED binding, make sure your index array matches the coordIndex array: there should be a -1 wherever there is a -1 in the coordIndex field. That's literally done to make this node more easily readable for humans. thoughtful king behavior fr fr π
A fairly common request when rendering facesets is how to display a set of faces with different colors on the backside versus the frontside. There is not direct support for this in the API, but it can easily be implemented by duplicating all faces in both the SoShapeHints::COUNTERCLOCKWISE and the SoShapeHints::CLOCKWISE order. Here is a simple usage example, showing the technique for a single polygon, using two SoFaceSet nodes for rendering the same polygon from both sides:
#Inventor V2.1 ascii
Separator {
Coordinate3 { point [ 0 0 0, 1 0 0, 1 1 0 ] }
Separator {
Material { diffuseColor [ 1 1 0 ] }
ShapeHints {
vertexOrdering COUNTERCLOCKWISE
shapeType SOLID
}
FaceSet { numVertices [ 3 ] }
}
Separator {
Material { diffuseColor [ 1 0 0 ] }
ShapeHints {
vertexOrdering CLOCKWISE
shapeType SOLID
}
FaceSet { numVertices [ 3 ] }
}
}
The same effect can also be done in the following manner, using an SoIndexedFaceSet to explicitly render the polygon coordinates in both directions (clockwise and counterclockwise):
#Inventor V2.1 ascii
Separator {
Coordinate3 { point [ 0 0 0, 1 0 0, 1 1 0 ] }
Material { diffuseColor [ 1 0 0, 1 1 0 ] }
MaterialBinding { value PER_FACE_INDEXED }
ShapeHints {
vertexOrdering COUNTERCLOCKWISE
shapeType SOLID
}
IndexedFaceSet {
coordIndex [ 0, 1, 2, -1, 2, 1, 0, -1 ]
materialIndex [ 0, 1 ]
}
}
Another rather rare issue that might be interesting to know about is that to render polygons with concave borders, you should set up an SoShapeHints node with SoShapeHints::faceType set to SoShapeHints::UNKNOWN_FACE_TYPE in the scene graph before the SoIndexedFaceSet (or SoFaceSet) node. This needs to be done to force the rendering code to tessellate the polygons properly to triangles before sending it off to OpenGL. Without it, the polygons will be sent as-is to OpenGL, and the OpenGL implementation's tessellator is often not able to tessellate properly. π Here is an example which usually fails without the SoShapeHints node (try commenting it out, and see what happens):
#Inventor V2.1 ascii
ShapeHints { faceType UNKNOWN_FACE_TYPE }
Coordinate3
{
point [ 2 0 0,
1 0 0,
1 1 0,
0 1 0,
0 2 0,
1 2 0,
2 2 0,
2 1 0 ]
}
FaceSet {}
π fr fr, thatFaceSet {}up there is empty on purpose β the whole point is theSoShapeHintsdoing the work.
FILE FORMAT/DEFAULTS:
IndexedFaceSet {
vertexProperty NULL
coordIndex 0
materialIndex -1
normalIndex -1
textureCoordIndex -1
}
π See also
SoFaceSetSoIndexedTriangleStripSet
π Constructor & Destructor Documentation π
π SoIndexedFaceSet::SoIndexedFaceSet (void )
Constructor. β¨
π SoIndexedFaceSet::~SoIndexedFaceSet () [protected], [virtual]
Destructor. π
β¨ Member Function Documentation β¨
okay bestie, this is the part where we meet the actual methods π
these are the functions that make SoIndexedFaceSet do its little thing. buckle up, there's a bunch of them, and yes we're doing all of them. no skips. π«Ά
πΈ SoType SoIndexedFaceSet::getClassTypeId (void ) [static]
This static method returns the SoType object associated with objects of this class.
static = it's a class-level thing, you don't need an instance to call it. iconic behavior fr.
π¦ SoType SoIndexedFaceSet::getTypeId (void ) const [virtual]
Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.
Reimplemented from SoIndexedShape.
so likeβ¦ it tells you what you actually are at runtime, which is very main character energy of it. β¨
π const SoFieldData ** SoIndexedFaceSet::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.
Returns the SoFieldData class which holds information about fields in this node.
translation: not for you, bestie, it's giving "staff only" door. π
π const SoFieldData * SoIndexedFaceSet::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 SoIndexedShape.
β void SoIndexedFaceSet::initClass (void ) [static]
that's it. that's the whole description. no notes. it justβ¦ initializes the class. periodt. π
π₯ void SoIndexedFaceSet::GLRender (SoGLRenderAction * action) [virtual]
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.
Reimplemented from SoShape.
"throw geometry primitives at OpenGL" is such an unhinged phrase and yet. accurate. π
π void SoIndexedFaceSet::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 calculate their primitive count also override this method to change the relevant state variables.
Reimplemented from SoShape.
counting triangles, line segments and points. lowkey the math girlie of the node family. π
π§ SbBool SoIndexedFaceSet::generateDefaultNormals (SoState * state, SoNormalBundle * bundle) [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 SoVertexShape.
π SbBool SoIndexedFaceSet::generateDefaultNormals (SoState * state, SoNormalCache * cache) [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 SoVertexShape.
yes there are two of these, and they're overloads β same name, different last argument. do not merge them in your head, bestie, they're different functions. π
π void SoIndexedFaceSet::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.
little trio ofbeginShape()/shapeVertex()/endShape()β they're a girl group and they always perform together. π€β¨
π Author π
Generated automatically by Doxygen for Coin from the source code.
not a human author, just Doxygen doing its little robot thing. slay, i guess. π€
and that's the whole page, bestie!! π₯³ this was Version 4.0.10 of the Coin docs, dated Thu Jun 25 2026 00:00:00, and it's the SoIndexedFaceSet(3) manpage. thanks for reading all three parts with me, you ate that π
π mwah, go build something cute with it π¦
π¦ where this page comes from
- fedora 43: Coin4-devel 4.0.10-1.fc43 Β· BSD-3-Clause AND GPL-3.0-or-later
- fedora 43: Coin4-devel 4.0.10-1.fc43 Β· BSD-3-Clause AND GPL-3.0-or-later
- fedora 44: Coin4-devel 4.0.10-1.fc44 Β· BSD-3-Clause AND GPL-3.0-or-later
- fedora 44: Coin4-devel 4.0.10-1.fc44 Β· BSD-3-Clause AND GPL-3.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms