SoIndexedFaceSet(3)
π SoIndexedFaceSet(3) π
okay bestie, welcome to the SoIndexedFaceSet(3) page from the Library Functions Manual. This class is literally the blueprint for generic indexed facesets, and we're about to go through the whole inheritance situation. No skipping, fr fr. π«Ά
β¨ NAME β¨
SoIndexedFaceSet β The SoIndexedFaceSet class is used to handle generic indexed facesets.
πΈ SYNOPSIS πΈ
#include <Inventor/nodes/SoIndexedFaceSet.h>
Inherits SoIndexedShape.
π 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=0) 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)uint32_t 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=0)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 *in)void get (SbString &fielddata, SoOutput *out)virtual SbBool validateNewFieldValue (SoField *field, void *newval)virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)SbBool getIsBuiltIn (void) 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) constvirtual 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)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)static void initClasses (void)static uint32_t 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)static SoType getClassTypeId (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)static SoType getClassTypeId (void)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 *in, SoBase *&base, SoType expectedtype)static void setInstancePrefix (const SbString &c)static void setTraceRefs (SbBool trace)static SbBool getTraceRefs (void)static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)static SbBool readRoute (SoInput *in)
π 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)
and that's where part one stops, bestie. part two is next, so don't go anywhere. π
π Protected Member Functions inherited from SoShape
bestie these are the family heirlooms β SoIndexedFaceSet didn't invent them, it just inherits them like a trust fund π you can't call them from outside, only the subclasses get to play:
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 SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *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)~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) const
π§ 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
all the extra lil gifts that came in the inheritance bag π«Ά
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 }
Public Attributes inherited from SoIndexedShape
these are literally the fields doing the heavy lifting, no cap:
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
uint32_t uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0static int nextActionMethodIndex = 0
π Detailed Description
okay so the SoIndexedFaceSet class is the girl for handling generic indexed facesets π
Faces get specified through the coordIndex field. Every single face has to be terminated by a negative (-1) index, like closing the door on it πͺβ¨ Coordinates, normals, materials and texture coordinates can all be pulled from the current state (or from the vertexProperty node if it's been set), and indexed to build triangles, quads or polygons.
Here's a usage example of just about the simplest possible use of this node, to show 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. 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. This is done to make this node more easily readable for humans π (yes, for us, the lil guys).
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 {}
FILE FORMAT/DEFAULTS:
IndexedFaceSet {
vertexProperty NULL
coordIndex 0
materialIndex -1
normalIndex -1
textureCoordIndex -1
}
π See also
SoFaceSet,SoIndexedTriangleStripSet
π Constructor & Destructor Documentation
SoIndexedFaceSet::SoIndexedFaceSet (void )
Constructor. the birth of the girl herself π
References SoIndexedFaceSet().
Referenced by getFieldData(), and SoIndexedFaceSet().
SoIndexedFaceSet::~SoIndexedFaceSet () [protected], [virtual]
Destructor. she's logging off π
more of this iconic saga coming right up β don't go anywhere bestie πΈ
β¨ Member Function Documentation β¨
SoType SoIndexedFaceSet::getTypeId (void ) const [virtual]
Okay bestie, this one returns the type identification of an object derived from a class inheriting SoBase. It's giving run-time type checking and "downward" casting energy. π
Usage example:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)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 SoIndexedShape.
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.
References SoIndexedFaceSet().
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 who wants to throw geometry primitives at OpenGL overrides this method. π₯
Reimplemented from SoShape.
References SoIndexedShape::coordIndex, SoShape::finishVertexArray(), SoGLRenderAction::getCacheContext(), SoNode::getNodeType(), SoAction::getState(), SoIndexedShape::getVertexData(), SoState::pop(), SoState::push(), SoVertexShape::readUnlockNormalCache(), SoVertexShape::shouldGLRender(), SoShape::startVertexArray(), SoVertexShape::vertexProperty, and SoNode::VRML1.
void SoIndexedFaceSet::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]
Action method for the SoGetPrimitiveCountAction. It 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.
References SoGetPrimitiveCountAction::addNumTriangles(), SoGetPrimitiveCountAction::canApproximateCount(), SoIndexedShape::coordIndex, and SoShape::shouldPrimitiveCount().
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.
References SoIndexedShape::coordIndex, and SoNode::VRML1.
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.
References SoShape::beginShape(), SoIndexedShape::coordIndex, SoShape::endShape(), SoNode::getNodeType(), SoAction::getState(), SoIndexedShape::getVertexData(), SoFaceDetail::incFaceIndex(), SoFaceDetail::incPartIndex(), SoState::pop(), SoDebugError::postInfo(), SoState::push(), SoVertexShape::readUnlockNormalCache(), SoPointDetail::setCoordinateIndex(), SoPrimitiveVertex::setDetail(), SoPointDetail::setMaterialIndex(), SoPrimitiveVertex::setMaterialIndex(), SoPrimitiveVertex::setNormal(), SoPointDetail::setNormalIndex(), SoPrimitiveVertex::setPoint(), SoPointDetail::setTextureCoordIndex(), SoPrimitiveVertex::setTextureCoords(), SoShape::shapeVertex(), SoVertexShape::vertexProperty, and SoNode::VRML1.
β¨ Author β¨
Generated automatically by Doxygen for Coin from the source code. π€
That's the footer vibe: Coin Β· Version 2.5.0 Β· SoIndexedFaceSet(3). No date on this one, bestie β but the page still ate. π
β¨
π¦ where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms