dePortalSystem Class Reference

Portal System. More...

#include <dePortalSystem.h>

Inheritance diagram for dePortalSystem:

List of all members.

Public Types
enum	eFaceTypes { eftWall, eftSemiWall, eftPortal }
	Face types. More...
Public Member Functions
Constructors and Destructors
	dePortalSystem (dePortalSystemManager *manager)
	Creates a new portal system.
virtual	~dePortalSystem ()
	Cleans up the portal system.
Management
const decDVector &	GetPosition () const
	Retrieves the position.
void	SetPosition (const decDVector &position)
	Sets the position.
const decQuaternion &	GetOrientation () const
	Retrieves the orientation.
void	SetOrientation (const decQuaternion &orientation)
	Sets the orientation.
int	GetRoomCount () const
	Retrieves the number of rooms.
void	SetRoomCount (int roomCount)
	Sets the number of rooms.
void	NotifyLayoutChanged ()
	Notifies the peers that the layout of the portal system changed.
bool	Verify () const
	Verify the portal system.
Vertices
int	GetVertexCount () const
	Retrieves the number of vertices.
void	SetVertexCount (int count)
	Sets the number of vertices.
const decVector &	GetVertexAt (int index) const
	Retrieves the vertex at the given position.
void	SetVertexAt (int index, const decVector &vertex)
	Sets the vertex at the given position.
decVector *	GetVertices () const
	Retrieves the pointer to the vertices.
Faces
int	GetFaceCount () const
	Retrieves the number of faces.
void	SetFaceCount (int count)
	Sets the number of faces.
dePortalSystemFace &	GetFaceAt (int index)
	Retrieves the face at the given position.
const dePortalSystemFace &	GetFaceAt (int index) const
dePortalSystemFace *	GetFaces () const
	Retrieves the pointer to the faces.
System Peers
deBaseGraphicPortalSystem *	GetGraphicPeer () const
	Retrieves the graphic system peer.
void	SetGraphicPeer (deBaseGraphicPortalSystem *peer)
	Sets the graphic system peer.

---

Detailed Description

Portal System.

Stores a portal system to help in visibility determination.

Author:

Plüss Roland

Version:

1.0

Date:

2010

---

Member Enumeration Documentation

enum dePortalSystem::eFaceTypes

Face types.

Enumerator:

eftWall	Face blocks view in both directions.
eftSemiWall	Face blocks view only in the direction of the face normal.
eftPortal	Face is a portal not blocking the view in any direction.

---

Constructor & Destructor Documentation

dePortalSystem::dePortalSystem

(

dePortalSystemManager *

manager )

Creates a new portal system.

virtual dePortalSystem::~dePortalSystem

(

)

[virtual]

Cleans up the portal system.

---

Member Function Documentation

dePortalSystemFace& dePortalSystem::GetFaceAt

(

int

index )

Retrieves the face at the given position.

const dePortalSystemFace& dePortalSystem::GetFaceAt

(

int

index )

const

int dePortalSystem::GetFaceCount

(

)

const [inline]

Retrieves the number of faces.

dePortalSystemFace* dePortalSystem::GetFaces

(

)

const [inline]

Retrieves the pointer to the faces.

deBaseGraphicPortalSystem* dePortalSystem::GetGraphicPeer

(

)

const [inline]

Retrieves the graphic system peer.

const decQuaternion& dePortalSystem::GetOrientation

(

)

const [inline]

Retrieves the orientation.

const decDVector& dePortalSystem::GetPosition

(

)

const [inline]

Retrieves the position.

int dePortalSystem::GetRoomCount

(

)

const [inline]

Retrieves the number of rooms.

const decVector& dePortalSystem::GetVertexAt

(

int

index )

const

Retrieves the vertex at the given position.

int dePortalSystem::GetVertexCount

(

)

const [inline]

Retrieves the number of vertices.

decVector* dePortalSystem::GetVertices

(

)

const [inline]

Retrieves the pointer to the vertices.

void dePortalSystem::NotifyLayoutChanged

(

)

Notifies the peers that the layout of the portal system changed.

This has to be called after changes made to vertices, faces or rooms.

void dePortalSystem::SetFaceCount

(

int

count )

Sets the number of faces.

void dePortalSystem::SetGraphicPeer

(

deBaseGraphicPortalSystem *

peer )

Sets the graphic system peer.

void dePortalSystem::SetOrientation

(

const decQuaternion &

orientation )

Sets the orientation.

void dePortalSystem::SetPosition

(

const decDVector &

position )

Sets the position.

void dePortalSystem::SetRoomCount

(

int

roomCount )

Sets the number of rooms.

void dePortalSystem::SetVertexAt	(	int	index,
		const decVector &	vertex
	)

Sets the vertex at the given position.

void dePortalSystem::SetVertexCount

(

int

count )

Sets the number of vertices.

bool dePortalSystem::Verify

(

)

const

Verify the portal system.

---

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

• dePortalSystem.h