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

Abstract base class for all indexed vertex-based shapes. More...

#include <Inventor/nodes/SoIndexedShape.h>

+ Inheritance diagram for SoIndexedShape:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
- 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 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.
 

Public Attributes

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.
 

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...
 

Detailed Description

Abstract base class for all indexed vertex-based shapes.

This node is the abstract base class for all vertex-based shapes that are constructed from indices, including SoIndexedFaceSet, SoIndexedTriangleStripSet, and SoIndexedLineSet. SoIndexedShape defines fields that are used in all of its subclasses.

All subclasses of SoNonIndexedShape construct objects by using the coordinates specified by the vertexProperty field (from SoVertexShape), or the current inherited coordinates. The coordIndex field defined by this class contains the indices into the current coordinates of the vertices of the shape. These indices are also used for materials, normals, tangents or texture coordinates when the appropriate binding is PER_VERTEX_INDEXED.

Material, normal and tangent bindings are interpreted as follows for each subclass:

OVERALL One material for the entire shape.
PER_PART Specific to the subclass.
PER_PART_INDEXED Same as PER_PART, using indices from the materialIndex, normalIndex or tangentIndex field.
PER_FACE Specific to the subclass.
PER_FACE_INDEXED Same as PER_FACE, using indices from the materialIndex, normalIndex or tangentIndex field.
PER_VERTEX One material per vertex.
PER_VERTEX_INDEXED One material per vertex, using indices from the materialIndex, normalIndex or tangentIndex field.

When any _INDEXED binding is used for materials, normals or tangents, the materialIndex, normalIndex or tangentIndex field is used to determine the indices for the materials, normals or tangents. If this field contains a single value of -1 (the default), the coordinate indices from the coordIndex field are used as well for materials, normals or tangents. When the binding is PER_VERTEX_INDEXED, indices in these fields that correspond to negative indices in coordIndex are skipped; for other index bindings all the values in the fields are used, in order.

Explicit texture coordinates (as defined by SoTextureCoordinate2) may be bound to vertices of an indexed shape consecutively (if the texture coordinate binding is PER_VERTEX) or by using the indices in the textureCoordIndex field (if the binding is PER_VERTEX_INDEXED). As with all vertex-based shapes, if there is a current texture but no texture coordinates are specified, a default texture coordinate mapping is calculated using the bounding box of the shape.

Be sure that the indices contained in the coordIndex, materialIndex, normalIndex, tangentIndex, and textureCoordIndex fields are valid with respect to the current state, or errors will occur.

Limitations:

  • Due to limitations of the OpenGL VBO (vertex buffer object) rendering model, in general it is not possible to use VBO rendering (and performance may be lower) if either the normal binding, tangent binding or the material binding is set to either PER_PART(_INDEXED) or PER_FACE(_INDEXED). See individual derived classes for exceptions.

FILE FORMAT/DEFAULT

    This is an abstract class. See the reference page of a derived class for the format and default values.

SEE ALSO

SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoMaterialBinding, SoNonIndexedShape, SoNormalBinding, SoTangentBinding, SoShapeHints, SoTextureCoordinateBinding

Definition at line 160 of file SoIndexedShape.h.

Member Function Documentation

◆ getClassTypeId()

static SoType SoIndexedShape::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoIndexedShape::getTypeId ( ) const
virtual

Member Data Documentation

◆ coordIndex

SoMFInt32 SoIndexedShape::coordIndex

The indices of the coordinates that the shape uses as its vertices.

The coordinates connect to form faces, lines, or other shapes. Each subclass defines special negative indices to use to indicate separation between faces, lines, and so on.

Definition at line 172 of file SoIndexedShape.h.

◆ materialIndex

SoMFInt32 SoIndexedShape::materialIndex

The indices of the materials that are used for the shape.

This field is used only when the material binding is one of the _INDEXED bindings. By default, the value of this field indicates that the coordinate indices should be used for materials as well.

Definition at line 179 of file SoIndexedShape.h.

◆ normalIndex

SoMFInt32 SoIndexedShape::normalIndex

The indices of the normals that are used for the shape.

This field is used only when the normal binding is one of the _INDEXED bindings. By default, the value of this field indicates that the coordinate indices should be used for normals as well.

Definition at line 186 of file SoIndexedShape.h.

◆ tangentIndex

SoMFInt32 SoIndexedShape::tangentIndex

The indices of the tangents that are used for the shape.

This field is used only when the tangent binding is one of the _INDEXED bindings. By default, the value of this field indicates that the coordinate indices should be used for tangents as well.

Definition at line 193 of file SoIndexedShape.h.

◆ textureCoordIndex

SoMFInt32 SoIndexedShape::textureCoordIndex

The indices of the texture coordinates that are used for the shape.

This field is used only when the texture coordinate binding is one of the _INDEXED bindings. By default, the value of this field indicates that the coordinate indices should be used for texture coordinates as well.

Definition at line 200 of file SoIndexedShape.h.


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