AeonGames::PointLight Class Reference

Point light component representing an omnidirectional light source. More...

#include <C:/Code/AeonEngine/engine/components/PointLight.h>

Inheritance diagram for AeonGames::PointLight:

Collaboration diagram for AeonGames::PointLight:

Public Member Functions
	PointLight ()
	Default constructor.
Overrides
const StringId &	GetId () const final
	Get the unique identifier for this component type.
size_t	GetPropertyCount () const final
	Get the number of properties exposed by this component.
const StringId *	GetPropertyInfoArray () const final
	Get the array of property identifiers.
Property	GetProperty (const StringId &aId) const final
	Get the value of a property.
void	SetProperty (uint32_t, const Property &aProperty) final
	Set the value aProperty for the property identified by aId.
void	Update (Node &aNode, double aDelta) final
	Update the component state.
void	Render (const Node &aNode, Renderer &aRenderer, void *aWindowId) final
	Render the component.
void	ProcessMessage (Node &aNode, uint32_t aMessageType, const void *aMessageData) final
	Process an incoming message.
Public Member Functions inherited from AeonGames::Component
virtual DLL	~Component ()=0
	Pure virtual destructor.
DLL void	SetProperty (const StringId &aId, const Property &aProperty)
	Set a property by its StringId identifier.
DLL void	SetProperty (const std::string &aId, const Property &aProperty)
	Set a property by its string name.

Static Public Member Functions
static const StringId &	GetClassId ()
	Returns the class identifier for the PointLight component.

Detailed Description

Point light component representing an omnidirectional light source.

Definition at line 25 of file PointLight.h.

Constructor & Destructor Documentation

PointLight()

AeonGames::PointLight::PointLight

(

)

Default constructor.

Definition at line 35 of file PointLight.cpp.

Member Function Documentation

GetClassId()

const StringId & AeonGames::PointLight::GetClassId ( )

static

Returns the class identifier for the PointLight component.

Definition at line 30 of file PointLight.cpp.

GetId()

const StringId & AeonGames::PointLight::GetId ( ) const

finalvirtual

Get the unique identifier for this component type.

Returns

Reference to the component's StringId.

Implements AeonGames::Component.

Definition at line 41 of file PointLight.cpp.

GetProperty()

Property AeonGames::PointLight::GetProperty ( const StringId & aId ) const

finalvirtual

Get the value of a property.

Parameters

aId	Identifier of the property to retrieve.

Returns

The property value.

Implements AeonGames::Component.

Definition at line 58 of file PointLight.cpp.

GetPropertyCount()

size_t AeonGames::PointLight::GetPropertyCount ( ) const

finalvirtual

Get the number of properties exposed by this component.

Returns

Property count.

Implements AeonGames::Component.

Definition at line 48 of file PointLight.cpp.

GetPropertyInfoArray()

const StringId * AeonGames::PointLight::GetPropertyInfoArray ( ) const

finalvirtual

Get the array of property identifiers.

Returns

Pointer to the first element of the property info array.

Implements AeonGames::Component.

Definition at line 53 of file PointLight.cpp.

ProcessMessage()

void AeonGames::PointLight::ProcessMessage ( Node & aNode, uint32_t aMessageType, const void * aMessageData )

finalvirtual

Process an incoming message.

Parameters

aNode	Node this component is attached to.
aMessageType	Type identifier of the message.
aMessageData	Pointer to message-specific data.

Implements AeonGames::Component.

Definition at line 75 of file PointLight.cpp.

Render()

void AeonGames::PointLight::Render ( const Node & aNode, Renderer & aRenderer, void * aWindowId )

finalvirtual

Render the component.

Parameters

aNode	Node this component is attached to.
aRenderer	Renderer used for drawing.
aWindowId	Platform-specific window identifier.

Implements AeonGames::Component.

Definition at line 71 of file PointLight.cpp.

SetProperty()

void AeonGames::PointLight::SetProperty ( uint32_t aId, const Property & aProperty )

finalvirtual

Set the value aProperty for the property identified by aId.

Note

If the type of the value passed does not match the expected types no change should be made.

Implements AeonGames::Component.

Definition at line 63 of file PointLight.cpp.

Update()

void AeonGames::PointLight::Update ( Node & aNode, double aDelta )

finalvirtual

Update the component state.

Parameters

aNode	Node this component is attached to.
aDelta	Elapsed time since the last update, in seconds.

Implements AeonGames::Component.

Definition at line 67 of file PointLight.cpp.

---

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

• engine/components/PointLight.h
• engine/components/PointLight.cpp