Abstract base class for light objects. More...

#include <light.hpp>

Inheritance diagram for scene::light:

Public Member Functions
virtual light_type	get_light_type () const noexcept=0
	Returns an enumeration denoting the light object type. More...

const aabb_type &	get_bounds () const noexcept override
	Returns the bounds of the object. More...

void	set_color (const math::fvec3 &color)
	Sets the color of the light. More...

void	set_color_temperature (float temperature)
	Sets the color of the light from a color temperature. More...

constexpr const math::fvec3 &	get_color () const noexcept
	Returns the scene-linear RGB color of the light. More...

Public Member Functions inherited from scene::object< light >
const std::size_t	get_object_type_id () const noexcept final
	Returns the type ID for this scene object type. More...

Public Member Functions inherited from scene::object_base
virtual void	render (render::context &ctx) const
	Adds render operations to a render context. More...

void	look_at (const vector_type &position, const vector_type &target, const vector_type &up)

constexpr void	set_layer_mask (std::uint32_t mask) noexcept
	Sets the layer mask of the object. More...

void	set_transform (const transform_type &transform)
	Sets the transform of the object. More...

void	set_translation (const vector_type &translation)
	Sets the translation of the object. More...

void	set_rotation (const quaternion_type &rotation)
	Sets the rotation of the object. More...

constexpr std::uint32_t	get_layer_mask () const noexcept
	Returns the layer mask of the object. More...

constexpr const transform_type &	get_transform () const noexcept
	Returns the transform of the object. More...

constexpr const vector_type &	get_translation () const noexcept
	Returns the translation of the object. More...

constexpr const quaternion_type &	get_rotation () const noexcept
	Returns the rotation of the object. More...

constexpr const vector_type &	get_scale () const noexcept
	Returns the scale of the object. More...

void	set_scale (const vector_type &scale)
	Sets the scale of the object. More...

void	set_scale (float scale)
	Sets the scale of the object. More...

Protected Member Functions
virtual void	color_updated ()
	Called each time the light color is modified. More...

Additional Inherited Members
Public Types inherited from scene::object_base
using	vector_type = math::fvec3

using	quaternion_type = math::fquat

using	transform_type = math::transform< float >

using	aabb_type = geom::box< float >

Static Public Attributes inherited from scene::object< light >
static const std::atomic< std::size_t >	object_type_id
	Unique type ID for this scene object type. More...

Static Protected Member Functions inherited from scene::object_base
static std::size_t	next_object_type_id ()

Protected Attributes inherited from scene::object_base
std::uint32_t	m_layer_mask {1}

transform_type	m_transform {transform_type::identity()}

Detailed Description

Abstract base class for light objects.

Definition at line 31 of file scene/light.hpp.

Member Function Documentation

◆ color_updated()

virtual void scene::light::color_updated ( )

inlineprotectedvirtual

Called each time the light color is modified.

Definition at line 64 of file scene/light.hpp.

◆ get_bounds()

const aabb_type& scene::light::get_bounds ( ) const

inlineoverridevirtualnoexcept

Returns the bounds of the object.

Implements scene::object_base.

Definition at line 37 of file scene/light.hpp.

◆ get_color()

constexpr const math::fvec3& scene::light::get_color ( ) const

inlineconstexprnoexcept

Returns the scene-linear RGB color of the light.

Definition at line 57 of file scene/light.hpp.

◆ get_light_type()

virtual light_type scene::light::get_light_type ( ) const

pure virtualnoexcept

Returns an enumeration denoting the light object type.

Implemented in scene::spot_light, scene::rectangle_light, scene::point_light, and scene::directional_light.

◆ set_color()

void scene::light::set_color ( const math::fvec3 & color )

Sets the color of the light.

Parameters

color Scene-linear RGB color, on [0, 1].

Definition at line 26 of file light.cpp.

◆ set_color_temperature()

void scene::light::set_color_temperature ( float temperature )

Sets the color of the light from a color temperature.

Parameters

temperature Color temperature, in Kelvin.

Definition at line 32 of file light.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members