Ndk::RenderSystem Class Reference

NDK class that represents the rendering system. More...

Inherits Ndk::System< SystemType >.

Public Member Functions
	RenderSystem ()
	Constructs an RenderSystem object by default.
	RenderSystem (const RenderSystem &renderSystem)
template<typename T >
T &	ChangeRenderTechnique ()
	Changes the render technique used for the system. More...
Nz::AbstractRenderTechnique &	ChangeRenderTechnique (std::unique_ptr< Nz::AbstractRenderTechnique > &&renderTechnique)
	Changes the render technique used for the system. More...
const Nz::BackgroundRef &	GetDefaultBackground () const
	Gets the background used for rendering. More...
const Nz::Matrix4f &	GetCoordinateSystemMatrix () const
	Gets the coordinates matrix used for rendering. More...
Nz::Vector3f	GetGlobalForward () const
	Gets the "forward" global direction. More...
Nz::Vector3f	GetGlobalRight () const
	Gets the "right" global direction. More...
Nz::Vector3f	GetGlobalUp () const
	Gets the "up" global direction. More...
Nz::AbstractRenderTechnique &	GetRenderTechnique () const
	Gets the render technique used for rendering. More...
void	SetDefaultBackground (Nz::BackgroundRef background)
	Sets the background used for rendering. More...
void	SetGlobalForward (const Nz::Vector3f &direction)
	Sets the "forward" global direction. More...
void	SetGlobalRight (const Nz::Vector3f &direction)
	Sets the "right" global direction. More...
void	SetGlobalUp (const Nz::Vector3f &direction)
	Sets the "up" global direction. More...

Static Public Attributes
static SystemIndex	systemIndex

Detailed Description

NDK class that represents the rendering system.

Remarks

This system is enabled if the entity is a 'camera' with the trait: CameraComponent and NodeComponent or a drawable element with trait: GraphicsComponent and NodeComponent or a light element with trait: LightComponent and NodeComponent or a set of particles with trait: ParticleGroupComponent

Member Function Documentation

ChangeRenderTechnique() [1/2]

template<typename T >

T & Ndk::RenderSystem::ChangeRenderTechnique ( )

inline

Changes the render technique used for the system.

Returns

A reference to the render technique type

ChangeRenderTechnique() [2/2]

Nz::AbstractRenderTechnique & Ndk::RenderSystem::ChangeRenderTechnique ( std::unique_ptr< Nz::AbstractRenderTechnique > &&  renderTechnique )

inline

Changes the render technique used for the system.

Returns

A reference to the abstract render technique

Parameters

renderTechnique

Render technique to use

GetCoordinateSystemMatrix()

const Nz::Matrix4f & Ndk::RenderSystem::GetCoordinateSystemMatrix ( ) const

inline

Gets the coordinates matrix used for rendering.

Returns

A constant reference to the matrix of coordinates

GetDefaultBackground()

const Nz::BackgroundRef & Ndk::RenderSystem::GetDefaultBackground ( ) const

inline

Gets the background used for rendering.

Returns

A reference to the background

GetGlobalForward()

Nz::Vector3f Ndk::RenderSystem::GetGlobalForward ( ) const

inline

Gets the "forward" global direction.

Returns

The forward direction, by default, it's -UnitZ() (Right hand coordinates)

GetGlobalRight()

Nz::Vector3f Ndk::RenderSystem::GetGlobalRight ( ) const

inline

Gets the "right" global direction.

Returns

The right direction, by default, it's UnitX() (Right hand coordinates)

GetGlobalUp()

Nz::Vector3f Ndk::RenderSystem::GetGlobalUp ( ) const

inline

Gets the "up" global direction.

Returns

The up direction, by default, it's UnitY() (Right hand coordinates)

GetRenderTechnique()

Nz::AbstractRenderTechnique & Ndk::RenderSystem::GetRenderTechnique ( ) const

inline

Gets the render technique used for rendering.

Returns

A reference to the abstract render technique being used

SetDefaultBackground()

void Ndk::RenderSystem::SetDefaultBackground ( Nz::BackgroundRef  background )

inline

Sets the background used for rendering.

Parameters

background

A reference to the background

SetGlobalForward()

void Ndk::RenderSystem::SetGlobalForward ( const Nz::Vector3f &  direction )

inline

Sets the "forward" global direction.

Parameters

direction

The new forward direction

SetGlobalRight()

void Ndk::RenderSystem::SetGlobalRight ( const Nz::Vector3f &  direction )

inline

Sets the "right" global direction.

Parameters

direction

The new right direction

SetGlobalUp()

void Ndk::RenderSystem::SetGlobalUp ( const Nz::Vector3f &  direction )

inline

Sets the "up" global direction.

Parameters

direction

The new up direction

---

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

• SDK/include/NDK/Systems/RenderSystem.hpp
• SDK/include/NDK/Systems/RenderSystem.inl
• SDK/src/NDK/Systems/RenderSystem.cpp