SoIndexedShape Class

Abstract base class for all indexed vertex-based shapes.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)

Syntax

C++

Copy

public abstract class SoIndexedShape : SoVertexShape

Public MustInherit Class SoIndexedShape
	Inherits SoVertexShape

public ref class SoIndexedShape abstract : public SoVertexShape

[<AbstractClassAttribute>]
type SoIndexedShape =  
    class
        inherit SoVertexShape
    end

The SoIndexedShape type exposes the following members.

Methods

	Name	Description
	AffectsState	Overrides default method on OIV.Inventor.Nodes.SoNode. (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes)	Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. (Inherited from SoShape.)
	Callback	Implements primitive generation for all shapes. (Inherited from SoShape.)
	ComputeBBox(SoAction, SbBox3f, SbVec3f)	This handles AABB bounding box computation for all shapes derived from this class. (Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
	ComputeBBox(SoAction, SbXfBox3d, SbVec3d)	This handles OOBB bounding box computation for all shapes derived from this class. (Overrides SoShapeComputeBBox(SoAction, SbXfBox3d, SbVec3d).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoNode.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	EndShape	end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. (Inherited from SoShape.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNormalCache	Returns the current normal cache, or NULL if there is none. (Inherited from SoVertexShape.)
	GetPrimitiveCount	Counts number of primitives produced by this shape. (Inherited from SoShape.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetShapeType	Gets the current shape Full Scene Antialiasing type. (Inherited from SoShape.)
	GetStringName	(Inherited from SoBase.)
	GetTangentCache	Returns the current tangent cache, or NULL if there is none. (Inherited from SoVertexShape.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	Implements rendering by rendering each primitive generated by subclass. (Inherited from SoVertexShape.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Used by BoundingBoxAction to know if bounding box computation should be ignored or not. (Inherited from SoShape.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	This handles pointPicking mode. (Overrides SoShapeRayPick(SoRayPickAction).)
	Search	(Inherited from SoNode.)
	Set	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. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetShapeType	set the antialiasing type for this shape. (Inherited from SoShape.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ShapeVertex	add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoVertexShape.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoShape.)
	coordIndex	The indices of the coordinates that the shape uses as its vertices.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	materialIndex	The indices of the materials that are used for the shape.
	normalIndex	The indices of the normals that are used for the shape.
	tangentIndex	The indices of the tangents that are used for the shape.
	textureCoordIndex	The indices of the texture coordinates that are used for the shape.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	vertexProperty	vertex property node. (Inherited from SoVertexShape.)

Top

Remarks

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

All subclasses of OIV.Inventor.Nodes.SoNonIndexedShape construct objects by using the coordinates specified by the vertexProperty field (from OIV.Inventor.Nodes.SoVertexShape), or the current inherited coordinates. The OIV.Inventor.Nodes.SoIndexedShape.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:

When any _INDEXED binding is used for materials, normals or tangents, the OIV.Inventor.Nodes.SoIndexedShape.materialIndex, OIV.Inventor.Nodes.SoIndexedShape.normalIndex or OIV.Inventor.Nodes.SoIndexedShape.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 OIV.Inventor.Nodes.SoIndexedShape.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 OIV.Inventor.Nodes.SoIndexedShape.coordIndex are skipped; for other index bindings all the values in the fields are used, in order.

Explicit texture coordinates (as defined by OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoIndexedShape.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 OIV.Inventor.Nodes.SoIndexedShape.coordIndex, OIV.Inventor.Nodes.SoIndexedShape.materialIndex, OIV.Inventor.Nodes.SoIndexedShape.normalIndex, OIV.Inventor.Nodes.SoIndexedShape.tangentIndex, and OIV.Inventor.Nodes.SoIndexedShape.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.

Reference

OIV.Inventor.Nodes Namespace

OIV.Inventor.Nodes.SoIndexedFaceSet

OIV.Inventor.Nodes.SoIndexedLineSet

OIV.Inventor.Nodes.SoIndexedTriangleStripSet

OIV.Inventor.Nodes.SoMaterialBinding

OIV.Inventor.Nodes.SoNonIndexedShape

OIV.Inventor.Nodes.SoNormalBinding

OIV.Inventor.Nodes.SoShapeHints

OIV.Inventor.Nodes.SoTextureCoordinateBinding

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoShape
              OIV.Inventor.NodesSoVertexShape
                OIV.Inventor.NodesSoIndexedShape
                  OIV.Inventor.NodesSoIndexedFaceSet
                  OIV.Inventor.NodesSoIndexedLineSet
                  OIV.Inventor.NodesSoIndexedPointSet
                  OIV.Inventor.NodesSoIndexedQuadMesh
                  OIV.Inventor.NodesSoIndexedTriangleFanSet
                  OIV.Inventor.NodesSoIndexedTriangleSet
                  OIV.Inventor.NodesSoIndexedTriangleStripSet

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