gd::Layer Class Reference

Represents a layer of a layout. More...

#include <Layer.h>

Public Member Functions
void	SetName (const gd::String &name_)
	Change layer name.
const gd::String &	GetName () const
	Get layer name.
const gd::String &	GetRenderingType () const
void	SetRenderingType (const gd::String &renderingType_)
const gd::String &	GetCameraType () const
void	SetCameraType (const gd::String &cameraType_)
void	SetVisibility (bool isVisible_)
	Change if layer is displayed or not.
bool	GetVisibility () const
	Return true if layer will be displayed at the layout startup.
void	SetLocked (bool isLocked_)
	Change if layer can be modified or not.
bool	IsLocked () const
	Return true if layer can't be modified.
void	SetLightingLayer (bool isLightingLayer_)
	Set if the layer is a lighting layer or not.
bool	IsLightingLayer () const
	Return true if the layer is a lighting layer.
void	SetFollowBaseLayerCamera (bool followBaseLayerCamera_)
	Set if the layer automatically follows the base layer or not.
bool	IsFollowingBaseLayerCamera () const
	Return true if the layer follows the base layer.
unsigned int	GetAmbientLightColorRed () const
unsigned int	GetAmbientLightColorGreen () const
unsigned int	GetAmbientLightColorBlue () const
void	SetAmbientLightColor (unsigned int r, unsigned int g, unsigned int b)
void	SerializeTo (SerializerElement &element) const
	Serialize layer.
void	UnserializeFrom (const SerializerElement &element)
	Unserialize the layer.
3D
double	GetCamera3DNearPlaneDistance () const
void	SetCamera3DNearPlaneDistance (double distance)
double	GetCamera3DFarPlaneDistance () const
void	SetCamera3DFarPlaneDistance (double distance)
double	GetCamera3DFieldOfView () const
void	SetCamera3DFieldOfView (double angle)
Cameras
void	SetCameraCount (std::size_t n)
	Change the number of cameras inside the layer. More...
std::size_t	GetCameraCount () const
	Get cameras count.
const Camera &	GetCamera (std::size_t n) const
	Return a reference to a camera.
Camera &	GetCamera (std::size_t n)
	Return a reference to a camera.
void	DeleteCamera (std::size_t n)
	Delete a specific camera.
void	AddCamera (const Camera &camera)
	Add an already existing camera.
Effects
EffectsContainer &	GetEffects ()
	Return the effects container.
const EffectsContainer &	GetEffects () const
	Return a const reference to the effects container.

Detailed Description

Represents a layer of a layout.

See also

gd::Layout

Member Function Documentation

GetAmbientLightColorBlue()

unsigned int gd::Layer::GetAmbientLightColorBlue ( ) const

inline

Get the ambient light color blue component.

GetAmbientLightColorGreen()

unsigned int gd::Layer::GetAmbientLightColorGreen ( ) const

inline

Get the ambient light color green component.

GetAmbientLightColorRed()

unsigned int gd::Layer::GetAmbientLightColorRed ( ) const

inline

Get the ambient light color red component.

SetAmbientLightColor()

void gd::Layer::SetAmbientLightColor ( unsigned int  r, unsigned int  g, unsigned int  b  )

inline

Set the ambient light color.

SetCameraCount()

void gd::Layer::SetCameraCount

(

std::size_t

n

)

Change the number of cameras inside the layer.

Change cameras count, automatically adding/removing them.

---

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

• Layer.h
• Layer.cpp