Click or drag to resize
DigitalRuneScene Class
Manages a scene of 3D objects represented by scene nodes (a.k.a the "scene graph").
Inheritance Hierarchy

Namespace: DigitalRune.Graphics.SceneGraph
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)
Syntax
public class Scene : SceneNode, IScene

The Scene type exposes the following members.

Constructors
  NameDescription
Public methodScene
Initializes a new instance of the Scene class.
Top
Methods
  NameDescription
Public methodClone
Creates a new SceneNode that is a clone of the current instance (incl. all children).
(Inherited from SceneNode.)
Protected methodCloneCore
Not supported.
(Overrides SceneNodeCloneCore(SceneNode).)
Protected methodCreateInstanceCore
Not supported.
(Overrides SceneNodeCreateInstanceCore.)
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 SceneNodeDispose(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.)
Protected methodGetDefaultGroup
Called when the default group of a new scene node is set.
Public methodGetGroup
Gets the group ID of a scene node.
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 methodHaveContact
Determines whether bounding shapes of two scene nodes overlap.
Public methodInvalidate
Invalidates this scene node and all children.
(Inherited from SceneNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnParentChanged
Called when Parent was changed.
(Overrides SceneNodeOnParentChanged(SceneNode, SceneNode).)
Protected methodOnPoseChanged
Raises the PoseChanged event.
(Inherited from SceneNode.)
Protected methodOnSceneChanged
Raises the SceneChanged event.
(Overrides SceneNodeOnSceneChanged(SceneChangedEventArgs).)
Protected methodOnShapeChanged
Raises the ShapeChanged event.
(Inherited from SceneNode.)
Public methodQueryT
Gets the scene nodes that touch the specified reference node.
Public methodSetGroup
Sets the group ID of a scene node.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Updates the scene.
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 propertyEnableMultithreading
Gets or sets a value indicating whether multithreading is enabled.
Public propertyFilter
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 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 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.
(Inherited from SceneNode.)
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

See IScene for general information about scenes. The Scene is the default implementation of IScene. It internally uses a CollisionDomain to accelerate scene queries (such as frustum culling).

A Scene is derived from SceneNode and therefore provides the same helper methods for manipulation and traversal. But a Scene object can only be the root node of the scene graph - it cannot be attached to another scene node. See SceneNode for more details regarding the scene hierarchy.

Scene Transformations:
A Scene is derived from SceneNode and therefore also has a transformation (see ScaleLocal/PoseLocal or ScaleWorld/PoseWorld) and a bounding shape (see Shape). The bounding shape is always empty (see EmptyShape) - it is not used. Since a Scene is always the root of a 3D scene PoseLocal and PoseWorld are always identical. The default scale is One, the default position is Zero and the default orientation is Identity. By setting a different values the entire scene is moved or rotated in world space.

Scene Queries and Scene Node Filtering:
QueryT(SceneNode, RenderContext) can be used to query all scene nodes that touch a given reference node: For example, to get all mesh nodes within the camera frustum, or all light nodes that affect a mesh node. QueryT(SceneNode, RenderContext) uses Filter to further filter the query result. See Filter for more information.

Scene Node Groups:
GetGroup(SceneNode) and SetGroup(SceneNode, Int32) can be used to put scene nodes into groups, where a group is simply an integer ID. This group can be used for filtering. Per default, meshes are in group 1, lights are in group 2, cameras are in group 3, all other objects are in group 0. The default grouping can be changed by overriding GetDefaultGroup(SceneNode). The default groups and Filter settings are:

GroupScene Nodes
0 Scene nodes which can touch all other nodes including scene nodes of the same type. This is the default group for custom scene node types derived from SceneNode.
1CameraNode
2LightNode
3 Scene nodes which can be rendered: BillboardNode, FogNode, LensFlareNode, FigureNode, ParticleSystemNode, SpriteNode
Nodes in this group can only touch cameras (group 1).
4 Scene nodes which can be rendered and lit: MeshNode
Nodes in this group can only touch cameras (group 1) and lights (group 2).

Cloning:
A Scene cannot be cloned. Calling Clone will raise an exception.

See Also