tram::LightComponent Class Reference

Provides a real-time illumination for the scene. More...

#include <components/light.h>

Inheritance diagram for tram::LightComponent:

Public Member Functions
void	Init ()
	Initializes an entity component. More...
void	Start ()
void	SetLocation (vec3 location)
	Sets the location of the light. More...
void	SetColor (Render::color_t color)
	Sets the color of the light. More...
void	SetDistance (float dist)
	Sets the distance of the light. More...
void	SetDirection (vec3 direction)
void	SetExponent (float exponent)
vec3	GetColor ()
	Returns the color of the light. More...
float	GetDistance ()
	Returns the distance of the light. More...
void	EventHandler (Event &event)
	~LightComponent ()
Public Member Functions inherited from tram::EntityComponent
	EntityComponent ()=default
virtual	~EntityComponent ()=default
bool	IsReady ()
	Returns the component's readiness. More...
bool	IsInit ()
	Returns the component's init status. More...
Entity *	GetParent ()
void	SetParent (Entity *parent)

Static Public Member Functions
static bool	IsLightDraw ()
	Checks whether the lights are drawn. More...
static void	SetLightDraw (bool)
	Sets the drawing oflights. More...

Protected Member Functions
void	Update ()
void	SetupModel ()
Protected Member Functions inherited from tram::EntityComponent
void	ResourceReady ()
	Notifies the component of a streamed-in resource. More...

Protected Attributes
Render::light_t	light = {}
vec3	location = {0.0f, 0.0f, 0.0f}
Render::color_t	color = {1.0f, 1.0f, 1.0f}
float	distance = 15.0f
vec3	direction = {0.0f, 0.0f, -1.0f}
float	exponent = 0.0f
Component< RenderComponent >	model
Protected Attributes inherited from tram::EntityComponent
size_t	resources_waiting = 0
bool	is_ready = false
bool	is_init = false
Entity *	parent = nullptr

Detailed Description

Provides a real-time illumination for the scene.

See also

https://racenis.github.io/tram-sdk/documentation/components/light.html

Constructor & Destructor Documentation

~LightComponent()

tram::LightComponent::~LightComponent

(

)

Member Function Documentation

EventHandler()

void tram::LightComponent::EventHandler ( Event &  event )

inlinevirtual

Implements tram::EntityComponent.

GetColor()

Render::color_t tram::LightComponent::GetColor

(

)

Returns the color of the light.

GetDistance()

float tram::LightComponent::GetDistance

(

)

Returns the distance of the light.

Init()

void tram::LightComponent::Init ( )

virtual

Initializes an entity component.

If an entity component has all of its resources already loaded, this will immediately Start() the component.

Reimplemented from tram::EntityComponent.

IsLightDraw()

bool tram::LightComponent::IsLightDraw ( )

static

Checks whether the lights are drawn.

Check SetLightDraw() for more info.

SetColor()

void tram::LightComponent::SetColor

(

Render::color_t

color

)

Sets the color of the light.

SetDirection()

void tram::LightComponent::SetDirection

(

vec3

direction

)

SetDistance()

void tram::LightComponent::SetDistance

(

float

dist

)

Sets the distance of the light.

Sets how far the light will travel.

SetExponent()

void tram::LightComponent::SetExponent

(

float

exponent

)

SetLightDraw()

void tram::LightComponent::SetLightDraw ( bool  draw )

static

Sets the drawing oflights.

If set to true, each light component will initialize a 3D model, which will allow you to see the posiiton of the light sources. Useful for debugging.

SetLocation()

void tram::LightComponent::SetLocation

(

vec3

location

)

Sets the location of the light.

SetupModel()

void tram::LightComponent::SetupModel ( )

protected

Start()

void tram::LightComponent::Start ( )

inlinevirtual

Implements tram::EntityComponent.

Update()

void tram::LightComponent::Update ( )

protected

Member Data Documentation

color

Render::color_t tram::LightComponent::color = {1.0f, 1.0f, 1.0f}

protected

direction

vec3 tram::LightComponent::direction = {0.0f, 0.0f, -1.0f}

protected

distance

float tram::LightComponent::distance = 15.0f

protected

exponent

float tram::LightComponent::exponent = 0.0f

protected

light

Render::light_t tram::LightComponent::light = {}

protected

location

vec3 tram::LightComponent::location = {0.0f, 0.0f, 0.0f}

protected

model

Component<RenderComponent> tram::LightComponent::model

protected

---

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

• C:/Users/Poga/Desktop/painis/tram-sdk/src/components/light.h
• C:/Users/Poga/Desktop/painis/tram-sdk/src/components/light.cpp