AeonGames::Camera Class Reference

Camera component providing perspective projection parameters for a scene node. More...

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

Inheritance diagram for AeonGames::Camera:

Collaboration diagram for AeonGames::Camera:

Public Member Functions
	Camera ()
	Default constructor.
float	GetFieldOfView () const
	Returns the field of view in degrees.
float	GetNearPlane () const
	Returns the near clipping plane distance.
float	GetFarPlane () const
	Returns the far clipping plane distance.
void	SetFieldOfView (float aFieldOfView)
	Sets the field of view.
void	SetNearPlane (float aNearPlane)
	Sets the near clipping plane distance.
void	SetFarPlane (float aFarPlane)
	Sets the far clipping plane distance.
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 Camera component.

Detailed Description

Camera component providing perspective projection parameters for a scene node.

Definition at line 25 of file Camera.h.

Constructor & Destructor Documentation

Camera()

AeonGames::Camera::Camera

(

)

Default constructor.

Definition at line 36 of file Camera.cpp.

Member Function Documentation

GetClassId()

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

static

Returns the class identifier for the Camera component.

Definition at line 31 of file Camera.cpp.

GetFarPlane()

float AeonGames::Camera::GetFarPlane

(

)

const

Returns the far clipping plane distance.

Definition at line 74 of file Camera.cpp.

GetFieldOfView()

float AeonGames::Camera::GetFieldOfView

(

)

const

Returns the field of view in degrees.

Definition at line 66 of file Camera.cpp.

GetId()

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

finalvirtual

Get the unique identifier for this component type.

Returns

Reference to the component's StringId.

Implements AeonGames::Component.

Definition at line 42 of file Camera.cpp.

GetNearPlane()

float AeonGames::Camera::GetNearPlane

(

)

const

Returns the near clipping plane distance.

Definition at line 70 of file Camera.cpp.

GetProperty()

Property AeonGames::Camera::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 91 of file Camera.cpp.

GetPropertyCount()

size_t AeonGames::Camera::GetPropertyCount ( ) const

finalvirtual

Get the number of properties exposed by this component.

Returns

Property count.

Implements AeonGames::Component.

Definition at line 56 of file Camera.cpp.

GetPropertyInfoArray()

const StringId * AeonGames::Camera::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 61 of file Camera.cpp.

ProcessMessage()

void AeonGames::Camera::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 145 of file Camera.cpp.

Render()

void AeonGames::Camera::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 141 of file Camera.cpp.

SetFarPlane()

void AeonGames::Camera::SetFarPlane

(

float

aFarPlane

)

Sets the far clipping plane distance.

Parameters

aFarPlane

Far plane distance.

Definition at line 86 of file Camera.cpp.

SetFieldOfView()

void AeonGames::Camera::SetFieldOfView

(

float

aFieldOfView

)

Sets the field of view.

Parameters

aFieldOfView

Field of view in degrees.

Definition at line 78 of file Camera.cpp.

SetNearPlane()

void AeonGames::Camera::SetNearPlane

(

float

aNearPlane

)

Sets the near clipping plane distance.

Parameters

aNearPlane

Near plane distance.

Definition at line 82 of file Camera.cpp.

SetProperty()

void AeonGames::Camera::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 105 of file Camera.cpp.

Update()

void AeonGames::Camera::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 130 of file Camera.cpp.

---

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

• engine/components/Camera.h
• engine/components/Camera.cpp