LightNode Class

LightNode Class

Represents a light in a scene.

Inheritance Hierarchy

SystemObject
DigitalRune.Graphics.SceneGraphSceneNode
DigitalRune.Graphics.SceneGraphLightNode

Namespace: DigitalRune.Graphics.SceneGraph
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public class LightNode : SceneNode

Public Class LightNode
	Inherits SceneNode

public ref class LightNode : public SceneNode

type LightNode =  
    class
        inherit SceneNode
    end

The LightNode type exposes the following members.

Constructors

	Name	Description
	LightNode	Initializes a new instance of the LightNode class.

Top

Methods

	Name	Description
	Clone	Creates a new SceneNode that is a clone of the current instance (incl. all children).
	CloneCore	Makes the instance a clone (deep copy) of the specified SceneNode. (Overrides SceneNodeCloneCore(SceneNode).)
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the SceneNode derived class. (Overrides SceneNodeCreateInstanceCore.)
	Dispose(Boolean)	Releases all resources used by the scene node and all descendant nodes. (Inherited from SceneNode.)
	Dispose(Boolean, Boolean)	Releases the unmanaged resources used by an instance of the SceneNode class and optionally releases the managed resources. (Inherited from SceneNode.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate	Invalidates this scene node and all children. (Inherited from SceneNode.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnParentChanged	Called when Parent was changed. (Inherited from SceneNode.)
	OnPoseChanged	Raises the PoseChanged event. (Inherited from SceneNode.)
	OnSceneChanged	Raises the SceneChanged event. (Inherited from SceneNode.)
	OnShapeChanged	Raises the ShapeChanged event. (Inherited from SceneNode.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ClearLastPose	Clears the LastPoseWorld property of the current scene node (and its descendants). (Defined by SceneHelper.)
	ClearLastScale	Clears the LastScaleWorld property of the current scene node (and its descendants). (Defined by SceneHelper.)
	Contains	Determines whether whether a scene node contains another scene node in its subtree. (Defined by SceneHelper.)
	GetAncestors	Gets the ancestors of the given scene node. (Defined by SceneHelper.)
	GetChildren	Gets the children of the given scene node. (Defined by SceneHelper.)
	GetDescendants	Overloaded. Gets the descendants of the given scene node using a depth-first search. (Defined by SceneHelper.)
	GetDescendants(Boolean)	Overloaded. Gets the descendants of the given scene node using a depth-first or a breadth-first search. (Defined by SceneHelper.)
	GetLeaves	Gets the leaves of the scene node. (Defined by SceneHelper.)
	GetLightContribution	Gets a factor that is an approximation of the perceived light contribution of the given light falling on an object at the given world space position. (Defined by GraphicsHelper.)
	GetRoot	Gets the root node. (Defined by SceneHelper.)
	GetSceneNode	Gets a scene node by name from the subtree of the specified scene node. (Defined by SceneHelper.)
	GetSelfAndAncestors	Gets the scene node and its ancestors scene. (Defined by SceneHelper.)
	GetSubtree	Overloaded. Gets the subtree (the given scene node and all of its descendants) using a depth-first search. (Defined by SceneHelper.)
	GetSubtree(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.)
	GetSubtreeAabb	Gets the AABB of the current subtree. (Defined by SceneHelper.)
	LookAt(Vector3F, Vector3F)	Overloaded. Rotates the scene node so that it faces a certain direction (in world space). (Defined by SceneHelper.)
	LookAt(Vector3F, Vector3F, Vector3F)	Overloaded. Moves and rotates the scene node so that it faces a certain direction (in world space). (Defined by SceneHelper.)
	SetInstanceAlpha	Sets the opacity (alpha) of a scene node - see remarks. (Defined by SceneHelper.)
	SetLastPose	Sets LastPoseWorld to the current PoseWorld. (Defined by SceneHelper.)
	SetLastScale	Sets LastScaleWorld to the current ScaleWorld. (Defined by SceneHelper.)
	SupportsInstanceAlpha	Determines whether the opacity of the scene node can be changed using SetInstanceAlpha(SceneNode, Single). (Defined by SceneHelper.)

Top

Properties

	Name	Description
	Aabb	Gets the axis-aligned bounding box (AABB) in world space. (Inherited from SceneNode.)
	ActualIsEnabled	Gets a value indicating whether this scene node is actually enabled. (The method checks the current scene node and its ancestors.) (Inherited from SceneNode.)
	CastsShadows	Gets or sets a value indicating whether this scene node blocks the light and casts shadows. (Inherited from SceneNode.)
	Children	Gets or sets the children of this scene node. (Inherited from SceneNode.)
	Clip	Gets or sets the clip geometry.
	InvertClip	Gets or sets a value indicating whether Clip geometry determines the volume that can be lit or the volume that should be ignored by the light.
	IsDisposed	Gets a value indicating whether this scene node has been disposed of. (Inherited from SceneNode.)
	IsEnabled	Gets or sets a value indicating whether this scene node is enabled. (May override children - see remarks.) (Inherited from SceneNode.)
	IsRenderable	Gets or sets a value indicating whether this scene node can be rendered with a SceneNodeRenderer. (Inherited from SceneNode.)
	IsShadowCasterCulled	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.)
	IsStatic	Gets or sets a value indicating whether this scene node is static (immobile). (Inherited from SceneNode.)
	LastFrame	Gets or sets the number of the last frame in which the scene node was rendered. (Inherited from SceneNode.)
	LastPoseWorld	Gets or sets the PoseWorld of the last frame. (Inherited from SceneNode.)
	LastScaleWorld	Gets or sets the ScaleWorld of the last frame. (Inherited from SceneNode.)
	Light	Gets or sets the light.
	MaxDistance	Gets or sets the maximum distance up to which the scene node is rendered. (Needs to be normalized - see remarks.) (Inherited from SceneNode.)
	Name	Gets or sets the name of this scene node. (Inherited from SceneNode.)
	Parent	Gets the parent scene node. (Inherited from SceneNode.)
	PoseLocal	Gets or sets the pose (position and orientation) relative to the parent scene node. (Inherited from SceneNode.)
	PoseWorld	Gets or sets the pose (position and orientation) in world space. (Inherited from SceneNode.)
	Priority	Gets or sets the priority.
	Proxy	Gets or sets the proxy node. (Inherited from SceneNode.)
	RenderData	Gets or sets the cached renderer data. (Inherited from SceneNode.)
	ScaleLocal	Gets or sets the scale relative to the parent scene node. (Inherited from SceneNode.)
	ScaleWorld	Gets the total effective scale (which incorporates the scale factors of parent scene nodes). (Inherited from SceneNode.)
	SceneData	Gets or sets scene data. (Inherited from SceneNode.)
	Shadow	Gets or sets the shadow data of this light node.
	Shape	Gets (or sets) the bounding shape of this scene node. (Inherited from SceneNode.)
	SortTag	Gets or sets the sort tag. (Inherited from SceneNode.)
	UserData	Gets or sets user-defined data. (Inherited from SceneNode.)
	UserFlags	Gets or sets a 16-bit value which can be used to store user-defined information or flags. (Inherited from SceneNode.)

Top

Events

	Name	Description
	SceneChanged	Occurs when the local subtree changed. (Inherited from SceneNode.)
	ShapeChanged	Occurs when the Shape or ScaleWorld was changed. (Inherited from SceneNode.)

Top

Explicit Interface Implementations

	Name	Description
	IDisposableDispose	Releases all resources used by the scene node and all descendant nodes. (Inherited from SceneNode.)
	IGeometricObjectClone	Creates a new IGeometricObject that is a clone (deep copy) of the current instance. (Inherited from SceneNode.)
	IGeometricObjectPose	Gets the pose (position and orientation) in world space. (Inherited from SceneNode.)
	IGeometricObjectPoseChanged	Occurs when the pose was changed. (Inherited from SceneNode.)
	IGeometricObjectScale	Gets the total effective scale (which incorporates the scale factors of parent scene nodes). (Inherited from SceneNode.)

Top

Remarks

A LightNode positions a Light in a 3D scene. A Light itself does not define position or direction. Position and orientation are defined by the LightNode. Multiple LightNodes can reference the same Light object.

The position and orientation (light direction) is defined by setting either PoseLocal or PoseWorld. The light direction is the local forward direction (0, 0, -1) of the scene node. The SceneHelper class provides helper methods to direct the light at a certain target: see methods LookAt(SceneNode, Vector3F, Vector3F) and LookAt(SceneNode, Vector3F, Vector3F, Vector3F).

The Shadow property defines whether the light creates a shadow. The property is by default and needs to be set explicitly.

Cloning: When a LightNode is cloned the Light is not cloned. The Light is copied by reference (shallow copy). The original LightNode and the cloned LightNode will reference the same Light object. The Clip geometry is copied by reference. The Shadow data is cloned.

Reference

DigitalRune.Graphics.SceneGraph Namespace