SpotLight Class Reference

A spotlight, where light rays in a given cone are radiating from a single point in space. Implements distance attenuation and cone soft transition. More...

#include <SpotLight.hpp>

Public Member Functions
	SpotLight ()=default
	SpotLight (const glm::vec3 &worldPosition, const glm::vec3 &worldDirection, const glm::vec3 &color, float innerAngle, float outerAngle, float radius)
void	draw (LightRenderer &renderer) override
void	update (double fullTime, double frameTime) override
void	setScene (const BoundingBox &sceneBox) override
glm::vec3	sample (const glm::vec3 &position, float &dist, float &attenuation) const override
bool	decode (const KeyValues &params)
KeyValues	encode () const override
const glm::vec3 &	position () const
const glm::vec3 &	direction () const
const glm::vec2 &	angles () const
float	radius () const
Public Member Functions inherited from Light
	Light ()
	Light (const glm::vec3 &color)
void	addAnimation (const std::shared_ptr< Animation > &anim)
virtual void	draw (LightRenderer &renderer)=0
virtual void	update (double fullTime, double frameTime)=0
virtual void	setScene (const BoundingBox &sceneBox)=0
virtual glm::vec3	sample (const glm::vec3 &position, float &dist, float &attenuation) const =0
virtual KeyValues	encode () const
bool	castsShadow () const
void	setCastShadow (bool shouldCast)
const glm::vec3 &	intensity () const
void	setIntensity (const glm::vec3 &color)
const glm::mat4 &	vp () const
const glm::mat4 &	model () const
const ShadowMap::Region &	shadowMap () const
void	registerShadowMap (const Texture *map, ShadowMode mode, size_t layer=0, const glm::vec2 &minUV=glm::vec2(0.0f), const glm::vec2 &maxUV=glm::vec2(1.0f))
bool	animated () const
virtual	~Light ()=default
	Light (const Light &)=delete
Light &	operator= (const Light &)=delete
	Light (Light &&)=default
Light &	operator= (Light &&)=delete

Private Attributes
glm::mat4	_projectionMatrix = glm::mat4(1.0f)
	Light projection matrix.
glm::mat4	_viewMatrix = glm::mat4(1.0f)
	Light view matrix.
Animated< glm::vec3 >	_lightDirection { glm::vec3(1.0f, 0.0f, 0.0f) }
	Light direction.
Animated< glm::vec3 >	_lightPosition { glm::vec3(0.0f) }
	Light position.
glm::vec2	_angles = glm::vec2(glm::quarter_pi<float>(), glm::half_pi<float>())
	The inner and outer cone attenuation angles.
float	_radius = 1.0f
	The attenuation radius.

Additional Inherited Members
Static Public Member Functions inherited from Light
static std::shared_ptr< Light >	decode (const KeyValues &params)
Protected Member Functions inherited from Light
bool	decodeBase (const KeyValues &params)
Protected Attributes inherited from Light
std::vector< std::shared_ptr< Animation > >	_animations
	Animations list (will be applied in order).
ShadowMap::Region	_shadowMapInfos
	Region of the (optional) shadow map containing this light information.
BoundingBox	_sceneBox
	The scene bounding box, to fit the shadow map.
glm::mat4	_vp
	VP matrix for shadow casting.
glm::mat4	_model
	Model matrix of the mesh containing the light-covered region.
glm::vec3	_color
	Colored intensity.
bool	_castShadows
	Is the light casting shadows (and thus use a shadow map)..

Detailed Description

A spotlight, where light rays in a given cone are radiating from a single point in space. Implements distance attenuation and cone soft transition.

It can be associated with a shadow 2D map with perspective projection, generated using Variance shadow mapping. It is rendered as a cone in deferred rendering.

See also

GPU::Frag::Spot_light, GPU::Frag::Light_shadow, GPU::Frag::Light_debug

Inherits Light.

Constructor & Destructor Documentation

SpotLight() [1/2]

SpotLight::SpotLight ( )

default

Default constructor.

SpotLight() [2/2]

SpotLight::SpotLight	(	const glm::vec3 &	worldPosition,
		const glm::vec3 &	worldDirection,
		const glm::vec3 &	color,
		float	innerAngle,
		float	outerAngle,
		float	radius
	)

Constructor.

Parameters

worldPosition	the light position in world space
worldDirection	the light cone direction in world space
color	the colored intensity of the light
innerAngle	the inner angle of the cone attenuation
outerAngle	the outer angle of the cone attenuation
radius	the distance at which the light is completely attenuated

Member Function Documentation

angles()

const glm::vec2 & SpotLight::angles ( ) const

inline

Get the light cone inner and outer angles. Attenuation happens between the two angles.

Returns

the angles

decode()

bool SpotLight::decode

(

const KeyValues &

params

)

Setup a spot light parameters from a list of key-value tuples. The following keywords will be searched for:

direction: dirX,dirY,dirZ
position: X,Y,Z
radius: radius
cone: innerAngle outerAngle
intensity: R,G,B
shadows: bool
animations:
    - animationtype: ...
    - ...

Parameters

params

the parameters tuple

Returns

decoding status

direction()

const glm::vec3 & SpotLight::direction ( ) const

inline

Get the light principal direction in world space.

Returns

the direction

draw()

void SpotLight::draw ( LightRenderer &  renderer )

overridevirtual

Process the light using a specific renderer.

See also

LightRenderer for the expected interface details.

Parameters

renderer

the light-specific renderer

Implements Light.

encode()

KeyValues SpotLight::encode ( ) const

overridevirtual

Generate a key-values representation of the light. See decode for the keywords and layout.

Returns

a tuple representing the light

Reimplemented from Light.

position()

const glm::vec3 & SpotLight::position ( ) const

inline

Get the light position in world space.

Returns

the position

radius()

float SpotLight::radius ( ) const

inline

Get the light influence radius. No emitted light propagates further than this distance from the light position.

Returns

the radius

sample()

glm::vec3 SpotLight::sample ( const glm::vec3 &  position, float &  dist, float &  attenuation  ) const

overridevirtual

Sample a direction from a reference point to the light.

Parameters

position	the 3D point
dist	will contain the distance from the light to the point
attenuation	will contain the light attenuation factor

Returns

a direction from the point to the light

Implements Light.

setScene()

void SpotLight::setScene ( const BoundingBox &  sceneBox )

overridevirtual

Update the scene bounding box used for internal setup (shadow map,...).

Parameters

sceneBox

the new bounding box

Implements Light.

update()

void SpotLight::update ( double  fullTime, double  frameTime  )

overridevirtual

Apply the animations for a frame duration.

Parameters

fullTime	the time since the launch of the application
frameTime	the time elapsed since the last frame

Implements Light.

---

The documentation for this class was generated from the following files:

• src/engine/scene/lights/SpotLight.hpp
• src/engine/scene/lights/SpotLight.cpp