dePortalSystemFace Class Reference

Portal System Face. More...

#include <dePortalSystemFace.h>

List of all members.

Public Types
enum	eFaceTypes { eftWall, eftSemiWall, eftPortal }
	Face types. More...
Public Member Functions
Constructors and Destructors
	dePortalSystemFace ()
	Creates a new portal system face.
	~dePortalSystemFace ()
	Cleans up the portal system face.
Management
int	GetType () const
	Retrieves the type.
void	SetType (int type)
	Sets the type.
int	GetVertexCount () const
	Retrieves the number of vertices.
void	SetVertexCount (int count)
	Sets the number of vertices.
int	GetVertexAt (int index) const
	Retrieves the vertex at the given position.
void	SetVertexAt (int index, int corner)
	Sets the corner at the given position.
int *	GetVertices () const
	Retrieves the pointer to the vertices.
int	GetRoomFront () const
	Retrieves the room on the front side or -1 if not existing.
void	SetRoomFront (int room)
	Sets the room on the front side of -1 if not existing.
int	GetRoomBack () const
	Retrieves the room on the back side or -1 if not existing.
void	SetRoomBack (int room)
	Sets the room on the back side of -1 if not existing.

---

Detailed Description

Portal System Face.

Face in a portal system. A valid face composes of 3 or more vertices. All vertices have to be co-planar and the face has to be convex. Furthermore up to two rooms are stored the face belongs to. The first room is the one on the front side of the face and the second room the one on the back side. If not belonging to any room -1 is stored.

Author:

Plüss Roland

Version:

1.0

Date:

2010

---

Member Enumeration Documentation

enum dePortalSystemFace::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

dePortalSystemFace::dePortalSystemFace

(

)

Creates a new portal system face.

dePortalSystemFace::~dePortalSystemFace

(

)

Cleans up the portal system face.

---

Member Function Documentation

int dePortalSystemFace::GetRoomBack

(

)

const [inline]

Retrieves the room on the back side or -1 if not existing.

int dePortalSystemFace::GetRoomFront

(

)

const [inline]

Retrieves the room on the front side or -1 if not existing.

int dePortalSystemFace::GetType

(

)

const [inline]

Retrieves the type.

int dePortalSystemFace::GetVertexAt

(

int

index )

const

Retrieves the vertex at the given position.

int dePortalSystemFace::GetVertexCount

(

)

const [inline]

Retrieves the number of vertices.

int* dePortalSystemFace::GetVertices

(

)

const [inline]

Retrieves the pointer to the vertices.

void dePortalSystemFace::SetRoomBack

(

int

room )

Sets the room on the back side of -1 if not existing.

void dePortalSystemFace::SetRoomFront

(

int

room )

Sets the room on the front side of -1 if not existing.

void dePortalSystemFace::SetType

(

int

type )

Sets the type.

void dePortalSystemFace::SetVertexAt	(	int	index,
		int	corner
	)

Sets the corner at the given position.

void dePortalSystemFace::SetVertexCount

(

int

count )

Sets the number of vertices.

---

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

• dePortalSystemFace.h