Ra::Engine::Scene::PointLight Class Reference

#include <Engine/Scene/PointLight.hpp>

Inheritance diagram for Ra::Engine::Scene::PointLight:

Collaboration diagram for Ra::Engine::Scene::PointLight:

Public Member Functions
	PointLight (Entity *entity, const std::string &name="pointlight")
void	setPosition (const Eigen::Matrix< Scalar, 3, 1 > &pos) override
const Eigen::Matrix< Scalar, 3, 1 > &	getPosition () const
void	setAttenuation (const Attenuation &attenuation)
void	setAttenuation (Scalar constant, Scalar linear, Scalar quadratic)
const Attenuation &	getAttenuation () const
std::string	getShaderInclude () const override
Public Member Functions inherited from Ra::Engine::Scene::Light
	Light (Entity *entity, const LightType &type, const std::string &name="light")
const Core::Utils::Color &	getColor () const
void	setColor (const Core::Utils::Color &color)
virtual void	setDirection (const Eigen::Matrix< Scalar, 3, 1 > &)
const LightType &	getType () const
void	getRenderParameters (Data::RenderParameters &params) const
	Extract the set of parameters that must be given to a shader for rendering and lighting with this light.
const Data::RenderParameters &	getRenderParameters () const
	Gives read-only access to the renderParameters of the light.
Data::RenderParameters &	getRenderParameters ()
	Gives read-write access to the renderParameters of the light.
void	initialize () override
Public Member Functions inherited from Ra::Engine::Scene::Component
	Component (const std::string &name, Entity *entity)
	CONSTRUCTOR.
virtual	~Component ()
	DESTRUCTOR.
virtual void	setEntity (Entity *entity)
	Set entity the component is part of. This method is called by the entity.
virtual Entity *	getEntity () const
	Return the entity the component belongs to.
virtual const std::string &	getName () const
	Return the component's name.
virtual void	setSystem (System *system)
	Set the system to which the component belongs.
virtual System *	getSystem () const
	Returns the system to which the component belongs.
Core::Utils::Index	addRenderObject (Rendering::RenderObject *renderObject)
	Add a new render object to the component. This adds the RO to the manager for drawing.
void	removeRenderObject (const Core::Utils::Index &roIdx)
	Remove the render object from the component.
virtual bool	canEdit (const Core::Utils::Index &) const
	Returns true if a transform can be edited with the render object index given as a key.
virtual Core::Transform	getTransform (const Core::Utils::Index &) const
	Get the transform associated with the given RO index key.
virtual void	setTransform (const Core::Utils::Index &, const Core::Transform &)
	Set the new transform associated with the RO index key.
void	notifyRenderObjectExpired (const Core::Utils::Index &idx)
virtual Core::Aabb	computeAabb ()
void	invalidateAabb ()
const std::vector< Core::Utils::Index > &	getRenderObjects ()

Additional Inherited Members
Public Types inherited from Ra::Engine::Scene::Light
enum	LightType : int { DIRECTIONAL = 0 , POINT , SPOT , POLYGONAL }
Public Attributes inherited from Ra::Engine::Scene::Component
std::vector< Core::Utils::Index >	m_renderObjects
Static Protected Member Functions inherited from Ra::Engine::Scene::Component
static Rendering::RenderObjectManager *	getRoMgr ()
	Shortcut to access the render object manager.
Protected Attributes inherited from Ra::Engine::Scene::Component
std::string	m_name {}
Entity *	m_entity { nullptr }
System *	m_system { nullptr }

Detailed Description

Point light for rendering

Definition at line 19 of file PointLight.hpp.

Constructor & Destructor Documentation

PointLight()

Ra::Engine::Scene::PointLight::PointLight ( Entity * entity, const std::string & name = "pointlight" )

explicit

Definition at line 8 of file PointLight.cpp.

Member Function Documentation

getAttenuation()

const PointLight::Attenuation & Ra::Engine::Scene::PointLight::getAttenuation ( ) const

inline

Definition at line 64 of file PointLight.hpp.

getPosition()

const Eigen::Matrix< Scalar, 3, 1 > & Ra::Engine::Scene::PointLight::getPosition ( ) const

inline

Definition at line 48 of file PointLight.hpp.

getShaderInclude()

std::string Ra::Engine::Scene::PointLight::getShaderInclude ( ) const

overridevirtual

Abstract method that define the glsl code that manage this light type For the moment, this is not use (except by experimental plugins) but will be part of the shader composition process of radium v2

Returns

Reimplemented from Ra::Engine::Scene::Light.

Definition at line 17 of file PointLight.cpp.

setAttenuation() [1/2]

void Ra::Engine::Scene::PointLight::setAttenuation ( const Attenuation & attenuation )

inline

Definition at line 52 of file PointLight.hpp.

setAttenuation() [2/2]

void Ra::Engine::Scene::PointLight::setAttenuation ( Scalar constant, Scalar linear, Scalar quadratic )

inline

Definition at line 60 of file PointLight.hpp.

setPosition()

void Ra::Engine::Scene::PointLight::setPosition ( const Eigen::Matrix< Scalar, 3, 1 > & )

inlineoverridevirtual

Set the position of the light source

Todo

put this only on point and spot light sources

Parameters

pos

Reimplemented from Ra::Engine::Scene::Light.

Definition at line 43 of file PointLight.hpp.

Here is the call graph for this function:

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/PointLight.hpp
• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/PointLight.cpp