PLMesh::Geometry Class Reference

A geometry defines a part of the index buffer to describe a geometry. More...

#include <Geometry.h>

List of all members.

Public Member Functions
PLMESH_API	Geometry ()
	Constructor.
PLMESH_API	~Geometry ()
	Destructor.
PLMESH_API PLCore::String	GetName () const
	Returns the geometrie's name.
PLMESH_API void	SetName (const PLCore::String &sName="")
	Sets the geometry name.
PLMESH_API PLCore::uint32	GetFlags () const
	Returns the geometry flags.
PLMESH_API void	SetFlags (PLCore::uint32 nFlags=0)
	Sets the geometry flags.
PLMESH_API bool	IsActive () const
	Returns the geometry active flag.
PLMESH_API void	SetActive (bool bActive=true)
	Sets the geometry active flag.
PLMESH_API PLRenderer::Primitive::Enum	GetPrimitiveType () const
	Returns the type of the primitives.
PLMESH_API void	SetPrimitiveType (PLRenderer::Primitive::Enum nPrimitiveType=PLRenderer::Primitive::Unknown)
	Sets the type of the primitives.
PLMESH_API PLCore::uint32	GetMaterial () const
	Returns the material used by this geometry.
PLMESH_API void	SetMaterial (PLCore::uint32 nMaterial=0)
	Sets the material used by this geometry.
PLMESH_API PLCore::uint32	GetStartIndex () const
	Returns the start index.
PLMESH_API void	SetStartIndex (PLCore::uint32 nStartIndex=0)
	Sets the start index.
PLMESH_API PLCore::uint32	GetIndexSize () const
	Returns the index size.
PLMESH_API void	SetIndexSize (PLCore::uint32 nIndexSize=0)
	Sets the index size.
PLMESH_API PLCore::uint32	GetNumOfTriangles () const
	Returns the number of triangles the geometry consists of.
PLMESH_API Geometry &	operator= (const Geometry &cSource)
	Copy operator.
PLMESH_API bool	operator== (const Geometry &cGeometry) const
	Compares two geometries.

---

Detailed Description

A geometry defines a part of the index buffer to describe a geometry.

---

Constructor & Destructor Documentation

PLMESH_API PLMesh::Geometry::Geometry

(

)

Constructor.

PLMESH_API PLMesh::Geometry::~Geometry

(

)

Destructor.

---

Member Function Documentation

PLMESH_API PLCore::String PLMesh::Geometry::GetName

(

)

const

Returns the geometrie's name.

Returns:

Name of the geometry

PLMESH_API void PLMesh::Geometry::SetName

(

const PLCore::String &

sName = ""

)

Sets the geometry name.

Parameters:

[in]

sName

Name of the geometry

PLMESH_API PLCore::uint32 PLMesh::Geometry::GetFlags

(

)

const

Returns the geometry flags.

Returns:

Geometry flags

PLMESH_API void PLMesh::Geometry::SetFlags

(

PLCore::uint32

nFlags = 0

)

Sets the geometry flags.

Parameters:

[in]

nFlags

Geometry flags

PLMESH_API bool PLMesh::Geometry::IsActive

(

)

const

Returns the geometry active flag.

Returns:

'true' if the geometry is active, else 'false'

PLMESH_API void PLMesh::Geometry::SetActive

(

bool

bActive = true

)

Sets the geometry active flag.

Parameters:

[in]

bActive

'true' if the geometry is active, else 'false'

PLMESH_API PLRenderer::Primitive::Enum PLMesh::Geometry::GetPrimitiveType

(

)

const

Returns the type of the primitives.

Returns:

Primitive type (e.g. triangles, triangle strips etc.)

PLMESH_API void PLMesh::Geometry::SetPrimitiveType

(

PLRenderer::Primitive::Enum

nPrimitiveType = PLRenderer::Primitive::Unknown

)

Sets the type of the primitives.

Parameters:

[in]

nPrimitiveType

Primitive type (e.g. triangles, triangle strips etc.)

PLMESH_API PLCore::uint32 PLMesh::Geometry::GetMaterial

(

)

const

Returns the material used by this geometry.

Returns:

Number of the material that is used

PLMESH_API void PLMesh::Geometry::SetMaterial

(

PLCore::uint32

nMaterial = 0

)

Sets the material used by this geometry.

Parameters:

[in]

nMaterial

Number of the material that is used

PLMESH_API PLCore::uint32 PLMesh::Geometry::GetStartIndex

(

)

const

Returns the start index.

Returns:

Start index

PLMESH_API void PLMesh::Geometry::SetStartIndex

(

PLCore::uint32

nStartIndex = 0

)

Sets the start index.

Parameters:

[in]

nStartIndex

Start index

PLMESH_API PLCore::uint32 PLMesh::Geometry::GetIndexSize

(

)

const

Returns the index size.

Returns:

Index size

PLMESH_API void PLMesh::Geometry::SetIndexSize

(

PLCore::uint32

nIndexSize = 0

)

Sets the index size.

Parameters:

[in]

nIndexSize

Index size

PLMESH_API PLCore::uint32 PLMesh::Geometry::GetNumOfTriangles

(

)

const

Returns the number of triangles the geometry consists of.

Returns:

Number of triangles (always 0 if less than 3 indices!)

PLMESH_API Geometry& PLMesh::Geometry::operator=

(

const Geometry &

cSource

)

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

Reference to this object

PLMESH_API bool PLMesh::Geometry::operator==

(

const Geometry &

cGeometry

)

const

Compares two geometries.

Parameters:

[in]

cGeometry

Geometry to compare with

Returns:

'true' if both geometries are equal, else 'false'

---

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

• Geometry.h