PLScene::SkyLayer Class Reference

Sky layer. More...

#include <SNSky.h>

Inheritance diagram for PLScene::SkyLayer:

List of all members.

Public Types
enum	EType {   Unknown = 0, Plane = 1, Cube = 2, Sphere = 3,   Dome = 4, Cylinder = 5 }
	Sky layer type. More...
Public Member Functions
	pl_enum (EType) pl_enum_value(Unknown
Unknown sky type	pl_enum_value (Plane,"Sky plane") pl_enum_value(Cube
Unknown sky type Sky cube	pl_enum_value (Sphere,"Sky sphere") pl_enum_value(Dome
Unknown sky type Sky cube Sky dome	pl_enum_value (Cylinder,"Sky cylinder") pl_enum_endpl_class(PLS_RTTI_EXPORT
Unknown sky type Sky cube Sky dome Sky layer	pl_attribute (Type, pl_enum_type(EType), Unknown, ReadWrite, GetSet,"Sky layer type","") pl_attribute(Position
Unknown sky type Sky cube Sky dome Sky layer Sky layer	pl_attribute (Rotation, PLMath::Vector3, PLMath::Vector3::Zero, ReadWrite, GetSet,"Sky layer rotation","") pl_attribute(Scale
Unknown sky type Sky cube Sky dome Sky layer Sky layer Sky layer pl_attribute(Name, PLCore::String,"", ReadWrite, GetSet,"Optional sky layer name. If not defined, a name is chosen automatically.","") pl_class_end public PLS_API void	SetType (EType nValue)
PLS_API const PLMath::Vector3 &	GetPosition () const
PLS_API void	SetPosition (const PLMath::Vector3 &vValue)
PLS_API const PLMath::Vector3 &	GetRotation () const
PLS_API void	SetRotation (const PLMath::Vector3 &vValue)
PLS_API const PLMath::Vector3 &	GetScale () const
PLS_API void	SetScale (const PLMath::Vector3 &vValue)
virtual PLS_API	~SkyLayer ()
	Destructor.
PLS_API SNSky *	GetSky () const
	Returns the sky this sky layer is in.
PLS_API PLMesh::MeshHandler *	GetMeshHandler () const
	Returns the sky layer mesh handler.
PLS_API bool	LoadMaterial (const PLCore::String &sFilename, PLCore::uint32 nMaterial=0)
	Loads a material.
PLS_API const PLMath::Matrix3x4 &	GetTransformMatrix ()
	Returns the current final transform matrix.
Public Attributes
Unknown sky type Sky cube Sky dome	SkyLayer
Unknown sky type Sky cube Sky dome	PLScene
Unknown sky type Sky cube Sky dome Sky layer	ReadWrite
Unknown sky type Sky cube Sky dome Sky layer	GetSet
Unknown sky type Sky cube Sky dome Sky layer Sky layer	position
Unknown sky type Sky cube Sky dome Sky layer Sky layer	ReadWrite
Unknown sky type Sky cube Sky dome Sky layer Sky layer	GetSet
Unknown sky type Sky cube Sky dome Sky layer Sky layer Sky layer	scale

---

Detailed Description

Sky layer.

Note:

• Each sky mesh geometry has it's own material
• A sky plane has one geometry
• A sky cube has 6 geometries
  Order: x-positive (0), x-negative (1), y-positive (2), y-negative (3), z-positive (4), z-negative (5)

---

Member Enumeration Documentation

enum PLScene::SkyLayer::EType

Sky layer type.

Enumerator:

Unknown	Unknown sky type
Plane	Sky plane
Cube	Sky cube
Sphere	Sky sphere
Dome	Sky dome
Cylinder	Sky cylinder

---

Constructor & Destructor Documentation

virtual PLS_API PLScene::SkyLayer::~SkyLayer

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLScene::SkyLayer::pl_enum

(

EType

)

Unknown sky type PLScene::SkyLayer::pl_enum_value	(	Plane	,
		"Sky plane"
	)

Unknown sky type Sky cube PLScene::SkyLayer::pl_enum_value	(	Sphere	,
		"Sky sphere"
	)

Unknown sky type Sky cube Sky dome PLScene::SkyLayer::pl_enum_value	(	Cylinder	,
		"Sky cylinder"
	)

Unknown sky type Sky cube Sky dome Sky layer PLScene::SkyLayer::pl_attribute	(	Type	,
		pl_enum_type(EType)	,
		Unknown	,
		ReadWrite	,
		GetSet	,
		"Sky layer type"	,
		""
	)

Unknown sky type Sky cube Sky dome Sky layer Sky layer PLScene::SkyLayer::pl_attribute	(	Rotation	,
		PLMath::Vector3	,
		PLMath::Vector3::Zero	,
		ReadWrite	,
		GetSet	,
		"Sky layer rotation"	,
		""
	)

Unknown sky type Sky cube Sky dome Sky layer Sky layer Sky layer pl_attribute (Name, PLCore::String, "", ReadWrite, GetSet, "Optional sky layer name. If not defined, a name is chosen automatically.", "") pl_class_end public PLS_API void PLScene::SkyLayer::SetType

(

EType

nValue

)

PLS_API const PLMath::Vector3& PLScene::SkyLayer::GetPosition

(

)

const

PLS_API void PLScene::SkyLayer::SetPosition

(

const PLMath::Vector3 &

vValue

)

PLS_API const PLMath::Vector3& PLScene::SkyLayer::GetRotation

(

)

const

PLS_API void PLScene::SkyLayer::SetRotation

(

const PLMath::Vector3 &

vValue

)

PLS_API const PLMath::Vector3& PLScene::SkyLayer::GetScale

(

)

const

PLS_API void PLScene::SkyLayer::SetScale

(

const PLMath::Vector3 &

vValue

)

PLS_API SNSky* PLScene::SkyLayer::GetSky

(

)

const

Returns the sky this sky layer is in.

Returns:

The sky this sky layer is in, NEVER a null pointer

PLS_API PLMesh::MeshHandler* PLScene::SkyLayer::GetMeshHandler

(

)

const

Returns the sky layer mesh handler.

Returns:

The mesh of the sky layer handler, a null pointer on error

PLS_API bool PLScene::SkyLayer::LoadMaterial	(	const PLCore::String &	sFilename,
		PLCore::uint32	nMaterial = 0
	)

Loads a material.

Parameters:

[in]	sFilename	Material filename
[in]	nMaterial	Material ID

Returns:

'true' if all went fine, else 'false'

PLS_API const PLMath::Matrix3x4& PLScene::SkyLayer::GetTransformMatrix

(

)

Returns the current final transform matrix.

Returns:

The current final transform matrix

Note:

• If position, rotation or scale was changed, the current transform matrix is recalculated internally before it is returned

---

Member Data Documentation

Unknown sky type Sky cube Sky dome PLScene::SkyLayer::SkyLayer

Unknown sky type Sky cube Sky dome PLScene::SkyLayer::PLScene

Unknown sky type Sky cube Sky dome Sky layer PLScene::SkyLayer::ReadWrite

Unknown sky type Sky cube Sky dome Sky layer PLScene::SkyLayer::GetSet

Unknown sky type Sky cube Sky dome Sky layer Sky layer PLScene::SkyLayer::position

Unknown sky type Sky cube Sky dome Sky layer Sky layer PLScene::SkyLayer::ReadWrite

Unknown sky type Sky cube Sky dome Sky layer Sky layer PLScene::SkyLayer::GetSet

Unknown sky type Sky cube Sky dome Sky layer Sky layer Sky layer PLScene::SkyLayer::scale

---

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

• SNSky.h