PointLight Class

PointLight Class

Represents a point light.

Inheritance Hierarchy

SystemObject
DigitalRune.GraphicsLight
DigitalRune.GraphicsPointLight

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

Syntax

C++

Copy

public class PointLight : Light

Public Class PointLight
	Inherits Light

public ref class PointLight : public Light

type PointLight =  
    class
        inherit Light
    end

The PointLight type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	Clone	Creates a new Light that is a clone (deep copy) of the current instance. (Inherited from Light.)
	CloneCore	Makes the instance a clone (deep copy) of the specified Light. (Overrides LightCloneCore(Light).)
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the Light derived class. (Overrides LightCreateInstanceCore.)
	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.)
	GetIntensity	Gets the (approximated) light intensity at the given distance. (Overrides LightGetIntensity(Single).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Attenuation	Gets or sets the exponent for the distance attenuation.
	Color	Gets or sets the RGB color of the light.
	DiffuseIntensity	Gets or sets the diffuse intensity of the light.
	HdrScale	Gets or sets the HDR scale of the light.
	Name	Gets or sets the name of the light. (Inherited from Light.)
	Range	Gets or sets the range of the light.
	Shape	Gets (or sets) the shape of the light volume. (Inherited from Light.)
	SpecularIntensity	Gets or sets the specular intensity of the light.
	Texture	Gets or sets the cube map texture which is projected by this point light.

Top

Remarks

Point lights have color, intensity, position and range - but no direction. Point lights give off light equally in all directions. The PointLight object defines the light properties of a point light that is positioned at the origin (0, 0, 0). A LightNode needs to be created to position a light within a 3D scene.

Color, DiffuseIntensity/SpecularIntensity, HdrScale, and a light distance attenuation factor are multiplied to get the final diffuse and specular light intensities which can be used in the lighting equations.

When using a low dynamic range lighting (LDR lighting) the light intensities are

Diffuse light intensity L_diffuse = Color_RGB · DiffuseIntensity
Specular light intensity L_specular = Color_RGB · SpecularIntensity

When using a high dynamic range lighting (HDR lighting) the light intensities are

Diffuse light intensity L_diffuse = Color_RGB · DiffuseIntensity · HdrScale
Specular light intensity L_specular = Color_RGB · SpecularIntensity · HdrScale

A pure diffuse light can be created by setting DiffuseIntensity > 0 and SpecularIntensity = 0. A pure specular light can be created by setting DiffuseIntensity = 0 and SpecularIntensity > 0.

The Shape of a point light is a SphereShape with a radius equal to Range.

A cube map texture (see Texture) can be assigned to the point light. By default no texture is assigned. If a texture is set, the point light projects this texture on its surroundings (like a disco ball).

Cloning: When the PointLight is cloned the Texture is not duplicated. The Texture is copied by reference.

Reference

DigitalRune.Graphics Namespace