C# Class Axiom.Core.SubMesh

Defines a part of a complete 3D mesh.
Models which make up the definition of a discrete 3D object are made up of potentially multiple parts. This is because different parts of the mesh may use different materials or use different vertex formats, such that a rendering state change is required between them.

Like the Mesh class, instatiations of 3D objects in the scene share the SubMesh instances, and have the option of overriding their material differences on a per-object basis if required. See the SubEntity class for more information.

Show file Open project: WolfgangSt/axiom Class Usage Examples

Public Properties

Property Type Description
indexData Axiom.Graphics.IndexData
useSharedVertices bool
vertexData Axiom.Graphics.VertexData

Protected Properties

Property Type Description
boneAssignmentList List>.Dictionary
boneAssignmentsOutOfDate bool
isMaterialInitialized bool
lodFaceList List
materialName string
operationType Axiom.Graphics.OperationType
parent Axiom.Core.Mesh
vertexAnimationType VertexAnimationType

Public Methods

Method Description
AddBoneAssignment ( VertexBoneAssignment boneAssignment ) : void

Assigns a vertex to a bone with a given weight, for skeletal animation.

This method is only valid after setting the SkeletonName property. You should not need to modify bone assignments during rendering (only the positions of bones) and the engine reserves the right to do some internal data reformatting of this information, depending on render system requirements.

ClearBoneAssignments ( ) : void

Removes all bone assignments for this mesh.

This method is for modifying weights to the shared geometry of the Mesh. To assign weights to the per-SubMesh geometry, see the equivalent methods on SubMesh.

GetRenderOperation ( RenderOperation op ) : void

Overloaded method.
GetRenderOperation ( RenderOperation op, int lodIndex ) : void

Fills a RenderOperation structure required to render this mesh.
RemoveLodLevels ( ) : void
SubMesh ( ) : System

Basic contructor.

Protected Methods

Method Description
CompileBoneAssignments ( ) : void

Must be called once to compile bone assignments into geometry buffer.
dispose ( bool disposeManagedResources ) : void

Method Details

AddBoneAssignment() public method

Assigns a vertex to a bone with a given weight, for skeletal animation.
This method is only valid after setting the SkeletonName property. You should not need to modify bone assignments during rendering (only the positions of bones) and the engine reserves the right to do some internal data reformatting of this information, depending on render system requirements.
public AddBoneAssignment ( VertexBoneAssignment boneAssignment ) : void
boneAssignment VertexBoneAssignment
return void

ClearBoneAssignments() public method

Removes all bone assignments for this mesh.
This method is for modifying weights to the shared geometry of the Mesh. To assign weights to the per-SubMesh geometry, see the equivalent methods on SubMesh.
public ClearBoneAssignments ( ) : void
return void

CompileBoneAssignments() protected method

Must be called once to compile bone assignments into geometry buffer.
protected CompileBoneAssignments ( ) : void
return void

GetRenderOperation() public method

Overloaded method.
public GetRenderOperation ( RenderOperation op ) : void
op Axiom.Graphics.RenderOperation
return void

GetRenderOperation() public method

Fills a RenderOperation structure required to render this mesh.
public GetRenderOperation ( RenderOperation op, int lodIndex ) : void
op Axiom.Graphics.RenderOperation Reference to a RenderOperation structure to populate.
lodIndex int The index of the LOD to use.
return void

RemoveLodLevels() public method

public RemoveLodLevels ( ) : void
return void

SubMesh() public method

Basic contructor.
public SubMesh ( ) : System
return System

dispose() protected method

protected dispose ( bool disposeManagedResources ) : void
disposeManagedResources bool
return void

Property Details

boneAssignmentList protected property

List of bone assignment for this mesh.
protected Dictionary> boneAssignmentList
return List>.Dictionary

boneAssignmentsOutOfDate protected property

Flag indicating that bone assignments need to be recompiled.
protected bool boneAssignmentsOutOfDate
return bool

indexData public property

public IndexData,Axiom.Graphics indexData
return Axiom.Graphics.IndexData

isMaterialInitialized protected property

protected bool isMaterialInitialized
return bool

lodFaceList protected property

protected List lodFaceList
return List

materialName protected property

Name of the material assigned to this subMesh.
protected string materialName
return string

operationType protected property

Mode used for rendering this submesh.
protected OperationType,Axiom.Graphics operationType
return Axiom.Graphics.OperationType

parent protected property

The parent mesh that this subMesh belongs to.
protected Mesh,Axiom.Core parent
return Axiom.Core.Mesh

useSharedVertices public property

Indicates if this submesh shares vertex data with other meshes or whether it has it's own vertices.
public bool useSharedVertices
return bool

vertexAnimationType protected property

Type of vertex animation for dedicated vertex data (populated by Mesh)
protected VertexAnimationType vertexAnimationType
return VertexAnimationType

vertexData public property

public VertexData,Axiom.Graphics vertexData
return Axiom.Graphics.VertexData