Radium Engine  1.5.20
Loading...
Searching...
No Matches
Ra::Engine::Scene::DirectionalLight Class Referencefinal

#include <Engine/Scene/DirLight.hpp>

+ Inheritance diagram for Ra::Engine::Scene::DirectionalLight:
+ Collaboration diagram for Ra::Engine::Scene::DirectionalLight:

Public Member Functions

 DirectionalLight (Entity *entity, const std::string &name="dirlight")
 
void setDirection (const Eigen::Matrix< Scalar, 3, 1 > &dir) override
 
const Eigen::Matrix< Scalar, 3, 1 > & getDirection () 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::ColorgetColor () const
 
void setColor (const Core::Utils::Color &color)
 
virtual void setPosition (const Eigen::Matrix< Scalar, 3, 1 > &)
 
const LightTypegetType () 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::RenderParametersgetRenderParameters () const
 Gives read-only access to the renderParameters of the light.
 
Data::RenderParametersgetRenderParameters ()
 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 EntitygetEntity () const
 Return the entity the component belongs to.
 
virtual const std::stringgetName () const
 Return the component's name.
 
virtual void setSystem (System *system)
 Set the system to which the component belongs.
 
virtual SystemgetSystem () 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 {}
 
Entitym_entity { nullptr }
 
Systemm_system { nullptr }
 

Detailed Description

Directional light for rendering

Definition at line 15 of file DirLight.hpp.

Constructor & Destructor Documentation

◆ DirectionalLight()

Ra::Engine::Scene::DirectionalLight::DirectionalLight ( Entity * entity,
const std::string & name = "dirlight" )
explicit

Definition at line 8 of file DirLight.cpp.

Member Function Documentation

◆ getDirection()

const Eigen::Matrix< Scalar, 3, 1 > & Ra::Engine::Scene::DirectionalLight::getDirection ( ) const
inline

Definition at line 38 of file DirLight.hpp.

◆ getShaderInclude()

std::string Ra::Engine::Scene::DirectionalLight::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 13 of file DirLight.cpp.

◆ setDirection()

void Ra::Engine::Scene::DirectionalLight::setDirection ( const Eigen::Matrix< Scalar, 3, 1 > & )
inlineoverridevirtual

set the direction of lighting

Todo
put this only on directional and spot light sources
Parameters
dir

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

Definition at line 33 of file DirLight.hpp.

+ Here is the call graph for this function:

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