Click or drag to resize
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: 10.3.0.0 (10.3.0.0)
Syntax
public abstract class SoIndexedShape : SoVertexShape

The SoIndexedShape type exposes the following members.

Methods
  NameDescription
Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(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.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

This handles AABB bounding box computation for all shapes derived from this class.

(Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

This handles OOBB bounding box computation for all shapes derived from this class.

(Overrides SoShapeComputeBBox(SoAction, SbXfBox3d, SbVec3d).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

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.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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.)
Public methodGetBoundingBox

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.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNormalCache

Returns the current normal cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Inherited from SoShape.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetTangentCache

Returns the current tangent cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Inherited from SoVertexShape.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

This handles pointPicking mode.

(Overrides SoShapeRayPick(SoRayPickAction).)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

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.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoVertexShape.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertycoordIndex

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

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymaterialIndex

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

Public propertynormalIndex

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

Public propertytangentIndex

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

Public propertytextureCoordIndex

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

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvertexProperty

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 OIV.Inventor.Nodes.SoVertexShape.m_vertexProperty field (from OIV.Inventor.Nodes.SoVertexShape), or the current inherited coordinates. The OIV.Inventor.Nodes.SoIndexedShape.m_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:

  <TABLE border=0 cellspacing=0 cellpadding=5>
    <TR><TD valign=_top> OVERALL              <TD valign=_top> One material for the entire shape.
    <TR><TD valign=_top> PER_PART             <TD valign=_top> Specific to the subclass.
    <TR><TD valign=_top> PER_PART_INDEXED     <TD valign=_top> Same as PER_PART, using indices from the #materialIndex,
OIV.Inventor.Nodes.SoIndexedShape.m_normalIndex or OIV.Inventor.Nodes.SoIndexedShape.m_tangentIndex field.

PER_FACE

Specific to the subclass.

PER_FACE_INDEXED

Same as PER_FACE, using indices from the OIV.Inventor.Nodes.SoIndexedShape.m_materialIndex, OIV.Inventor.Nodes.SoIndexedShape.m_normalIndex or OIV.Inventor.Nodes.SoIndexedShape.m_tangentIndex field.

PER_VERTEX

One material per vertex.

PER_VERTEX_INDEXED

One material per vertex, using indices from the OIV.Inventor.Nodes.SoIndexedShape.m_materialIndex, OIV.Inventor.Nodes.SoIndexedShape.m_normalIndex or OIV.Inventor.Nodes.SoIndexedShape.m_tangentIndex field.

When any _INDEXED binding is used for materials, normals or tangents, the OIV.Inventor.Nodes.SoIndexedShape.m_materialIndex, OIV.Inventor.Nodes.SoIndexedShape.m_normalIndex or OIV.Inventor.Nodes.SoIndexedShape.m_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.m_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.m_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.m_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.m_coordIndex, OIV.Inventor.Nodes.SoIndexedShape.m_materialIndex, OIV.Inventor.Nodes.SoIndexedShape.m_normalIndex, OIV.Inventor.Nodes.SoIndexedShape.m_tangentIndex, and OIV.Inventor.Nodes.SoIndexedShape.m_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
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