LightQuery Class

LightQuery Class

Returns the lights that affect a specific scene node.

Inheritance Hierarchy

SystemObject
DigitalRune.Graphics.SceneGraphLightQuery

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 LightQuery : ISceneQuery

Public Class LightQuery
	Implements ISceneQuery

public ref class LightQuery : ISceneQuery

type LightQuery =  
    class
        interface ISceneQuery
    end

The LightQuery type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Reset	Resets this query.
	Set	Sets the query result.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AmbientLights	Gets the ambient lights.
	DirectionalLights	Gets the directional lights.
	ImageBasedLights	Gets the image-based lights.
	OtherLights	Gets other lights that did not fit into any of the predefined categories (AmbientLights, DirectionalLights, etc.).
	PointLights	Gets the point lights.
	ProjectorLights	Gets the projector lights.
	ReferenceNode	Gets the reference node.
	Spotlights	Gets the spotlights.

Top

Remarks

A LightQuery can be executed against a scene by calling QueryT(SceneNode, RenderContext). The query can be used to get all LightNodes that affect a certain reference node in the scene. The reference node is typically the scene node that is currently being rendered.

The light nodes are grouped by type (ambient lights, directional lights, etc.). The lights within each group are usually sorted descending by the approximate light contribution on the reference node. That means, lights that have a strong influence on the reference node are listed before lights that have a weak influence.

Reference

DigitalRune.Graphics.SceneGraph Namespace