Click or drag to resize
DigitalRuneMeshInstancingNodeT Class
Represents a MeshNode which uses hardware instancing to efficiently render many instances of a single Mesh.
Inheritance Hierarchy
SystemObject
  DigitalRune.Graphics.SceneGraphSceneNode
    DigitalRune.Graphics.SceneGraphMeshNode
      DigitalRune.Graphics.SceneGraphMeshInstancingNodeT

Namespace: DigitalRune.Graphics.SceneGraph
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)
Syntax
public class MeshInstancingNode<T> : MeshNode, 
	IMeshInstancingNode
where T : struct, new(), IVertexType

Type Parameters

T
The vertex type which stores instance data, usually InstanceData.

The MeshInstancingNodeT type exposes the following members.

Constructors
  NameDescription
Public methodMeshInstancingNodeT(Mesh)
Initializes a new instance of the MeshInstancingNodeT class.
Public methodMeshInstancingNodeT(Mesh, ICollectionT)
Initializes a new instance of the MeshInstancingNodeT class.
Top
Methods
  NameDescription
Public methodClone
Creates a new SceneNode that is a clone of the current instance (incl. all children).
Protected methodCloneCore
Makes the instance a clone (deep copy) of the specified SceneNode.
(Overrides MeshNodeCloneCore(SceneNode).)
Protected methodCreateInstanceCore
When implemented in a derived class, creates a new instance of the SceneNode derived class.
(Overrides MeshNodeCreateInstanceCore.)
Public methodDispose(Boolean)
Releases all resources used by the scene node and all descendant nodes.
(Inherited from SceneNode.)
Protected methodDispose(Boolean, Boolean)
Releases the unmanaged resources used by an instance of the SceneNode class and optionally releases the managed resources.
(Overrides MeshNodeDispose(Boolean, Boolean).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInvalidate
Invalidates this scene node and all children.
(Inherited from SceneNode.)
Public methodInvalidateInstances
Notifies this MeshInstancingNodeT that an element in Instances was modified.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnParentChanged
Called when Parent was changed.
(Inherited from SceneNode.)
Protected methodOnPoseChanged
Raises the PoseChanged event.
(Inherited from SceneNode.)
Protected methodOnSceneChanged
Raises the SceneChanged event.
(Inherited from SceneNode.)
Protected methodOnShapeChanged
Raises the ShapeChanged event.
(Inherited from SceneNode.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodClearLastPose
Clears the LastPoseWorld property of the current scene node (and its descendants).
(Defined by SceneHelper.)
Public Extension MethodClearLastScale
Clears the LastScaleWorld property of the current scene node (and its descendants).
(Defined by SceneHelper.)
Public Extension MethodContains
Determines whether whether a scene node contains another scene node in its subtree.
(Defined by SceneHelper.)
Public Extension MethodGetAncestors
Gets the ancestors of the given scene node.
(Defined by SceneHelper.)
Public Extension MethodGetChildren
Gets the children of the given scene node.
(Defined by SceneHelper.)
Public Extension MethodGetDescendantsOverloaded.
Gets the descendants of the given scene node using a depth-first search.
(Defined by SceneHelper.)
Public Extension MethodGetDescendants(Boolean)Overloaded.
Gets the descendants of the given scene node using a depth-first or a breadth-first search.
(Defined by SceneHelper.)
Public Extension MethodGetLeaves
Gets the leaves of the scene node.
(Defined by SceneHelper.)
Public Extension MethodGetRoot
Gets the root node.
(Defined by SceneHelper.)
Public Extension MethodGetSceneNode
Gets a scene node by name from the subtree of the specified scene node.
(Defined by SceneHelper.)
Public Extension MethodGetSelfAndAncestors
Gets the scene node and its ancestors scene.
(Defined by SceneHelper.)
Public Extension MethodGetSubtreeOverloaded.
Gets the subtree (the given scene node and all of its descendants) using a depth-first search.
(Defined by SceneHelper.)
Public Extension MethodGetSubtree(Boolean)Overloaded.
Gets the subtree (the given scene node and all of its descendants) using a depth-first or a breadth-first search.
(Defined by SceneHelper.)
Public Extension MethodGetSubtreeAabb
Gets the AABB of the current subtree.
(Defined by SceneHelper.)
Public Extension MethodLookAt(Vector3F, Vector3F)Overloaded.
Rotates the scene node so that it faces a certain direction (in world space).
(Defined by SceneHelper.)
Public Extension MethodLookAt(Vector3F, Vector3F, Vector3F)Overloaded.
Moves and rotates the scene node so that it faces a certain direction (in world space).
(Defined by SceneHelper.)
Public Extension MethodSetInstanceAlpha
Sets the opacity (alpha) of a scene node - see remarks.
(Defined by SceneHelper.)
Public Extension MethodSetLastPose
Sets LastPoseWorld to the current PoseWorld.
(Defined by SceneHelper.)
Public Extension MethodSetLastScale
Sets LastScaleWorld to the current ScaleWorld.
(Defined by SceneHelper.)
Public Extension MethodSupportsInstanceAlpha
Determines whether the opacity of the scene node can be changed using SetInstanceAlpha(SceneNode, Single).
(Defined by SceneHelper.)
Top
Properties
  NameDescription
Public propertyAabb
Gets the axis-aligned bounding box (AABB) in world space.
(Inherited from SceneNode.)
Public propertyActualIsEnabled
Gets a value indicating whether this scene node is actually enabled. (The method checks the current scene node and its ancestors.)
(Inherited from SceneNode.)
Public propertyCastsShadows
Gets or sets a value indicating whether this scene node blocks the light and casts shadows.
(Inherited from SceneNode.)
Public propertyChildren
Gets or sets the children of this scene node.
(Inherited from SceneNode.)
Public propertyInstances
Gets or sets the collection which stores data for each instance.
Public propertyIsDisposed
Gets a value indicating whether this scene node has been disposed of.
(Inherited from SceneNode.)
Public propertyIsEnabled
Gets or sets a value indicating whether this scene node is enabled. (May override children - see remarks.)
(Inherited from SceneNode.)
Public propertyIsRenderable
Gets or sets a value indicating whether this scene node can be rendered with a SceneNodeRenderer.
(Inherited from SceneNode.)
Public propertyIsShadowCasterCulled
Gets or sets a value indicating whether the occlusion culling determined that this scene node does not need to be rendered into the shadow map of the directional light.
(Inherited from SceneNode.)
Public propertyIsStatic
Gets or sets a value indicating whether this scene node is static (immobile).
(Inherited from SceneNode.)
Public propertyLastFrame
Gets or sets the number of the last frame in which the scene node was rendered.
(Inherited from SceneNode.)
Public propertyLastPoseWorld
Gets or sets the PoseWorld of the last frame.
(Inherited from SceneNode.)
Public propertyLastScaleWorld
Gets or sets the ScaleWorld of the last frame.
(Inherited from SceneNode.)
Public propertyMaterialInstances
Gets a collection of MaterialInstances associated with the mesh.
(Inherited from MeshNode.)
Public propertyMaxDistance
Gets or sets the maximum distance up to which the scene node is rendered. (Needs to be normalized - see remarks.)
(Inherited from SceneNode.)
Public propertyMesh
Gets or sets the mesh.
(Inherited from MeshNode.)
Public propertyMorphWeights
Gets or sets the weights of the morph targets.
(Inherited from MeshNode.)
Public propertyName
Gets or sets the name of this scene node.
(Inherited from SceneNode.)
Public propertyParent
Gets the parent scene node.
(Inherited from SceneNode.)
Public propertyPoseLocal
Gets or sets the pose (position and orientation) relative to the parent scene node.
(Inherited from SceneNode.)
Public propertyPoseWorld
Gets or sets the pose (position and orientation) in world space.
(Inherited from SceneNode.)
Public propertyProxy
Gets or sets the proxy node.
(Inherited from SceneNode.)
Public propertyRenderData
Gets or sets the cached renderer data.
(Inherited from SceneNode.)
Public propertyScaleLocal
Gets or sets the scale relative to the parent scene node.
(Inherited from SceneNode.)
Public propertyScaleWorld
Gets the total effective scale (which incorporates the scale factors of parent scene nodes).
(Inherited from SceneNode.)
Public propertySceneData
Gets or sets scene data.
(Inherited from SceneNode.)
Public propertyShape
Gets or sets the bounding shape of this scene node.
Public propertySkeletonPose
Gets or sets the skeleton pose for mesh skinning.
(Inherited from MeshNode.)
Public propertySortTag
Gets or sets the sort tag.
(Inherited from SceneNode.)
Public propertyUserData
Gets or sets user-defined data.
(Inherited from SceneNode.)
Public propertyUserFlags
Gets or sets a 16-bit value which can be used to store user-defined information or flags.
(Inherited from SceneNode.)
Top
Events
  NameDescription
Public eventSceneChanged
Occurs when the local subtree changed.
(Inherited from SceneNode.)
Public eventShapeChanged
Occurs when the Shape or ScaleWorld was changed.
(Inherited from SceneNode.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIDisposableDispose
Releases all resources used by the scene node and all descendant nodes.
(Inherited from SceneNode.)
Explicit interface implementationPrivate methodIGeometricObjectClone
Creates a new IGeometricObject that is a clone (deep copy) of the current instance.
(Inherited from SceneNode.)
Explicit interface implementationPrivate propertyIGeometricObjectPose
Gets the pose (position and orientation) in world space.
(Inherited from SceneNode.)
Explicit interface implementationPrivate eventIGeometricObjectPoseChanged
Occurs when the pose was changed.
(Inherited from SceneNode.)
Explicit interface implementationPrivate propertyIGeometricObjectScale
Gets the total effective scale (which incorporates the scale factors of parent scene nodes).
(Inherited from SceneNode.)
Top
Remarks

This mesh node has a property Instances which defines a collection of instance data. The element type is a vertex structure. Each element in the collection encodes data for one instance of the mesh, such as world matrix, color and alpha.

Vertex structure:A suitable vertex structure to use for the instance data is InstanceData. InstanceData is supported by the standard material effects. However, custom vertex types can be used to store different instance data. If the vertex type is not InstanceData then the mesh must use custom material effects, i.e. custom HLSL shaders that know how to interpret the encoded instance data.

If an element in Instances is changed at runtime, InvalidateInstances must be called to inform the mesh node that any internally cached data must be updated.

Bounding shape: The Shape must be set manually to a suitable shape which contains all instances of the mesh! Per default, the shape is Infinite which is safe for rendering but those not allow culling and therefore is very inefficient.

Scales, poses and world transforms: When a mesh instance is rendered, a material effect can combine the scale and pose of the scene node with the transform stored in the instance data. The effect can also ignore the scale/pose of this mesh node and only use the transform in the instance data. Currently, the predefined material effects of DigitalRune Graphics use the later method because the shader is faster. That means, the instance data should store the world space matrix, and the scale/pose of the mesh node is ignored. (However, the scale/pose of the mesh is still used to position the bounding box for frustum culling!)

Limitations: Following MeshNode features are currently not supported and will be ignored when an MeshInstancingNodeT is rendered:

Additionally, the MeshInstancingNodeT can only be used in the HiDef graphics profile and not in the Reach graphics profile!

Cloning: When an MeshInstancingNodeT is cloned the Instances collection is only copied by references (shallow copy). The original and the cloned mesh node will reference the same Instances collection.

See Also