torque

Torque Game Engine Documentation
TGE Version 1.5.2

EarlyOutPolyList Class Reference

#include <earlyOutPolyList.h>

Inheritance diagram for EarlyOutPolyList:

Inheritance graph

Detailed Description

Early out check PolyList.

This class is used primarily for triggers and similar checks. It checks to see if any of the geometry you feed it is inside its area, and if it is, it stops checking for any more data and returns a true value. This is good if you want to know if anything is in your "trigger" area, for instance.

See also:: AbstractPolyList

Public Types

typedef Vector< PlaneF > PlaneList

Public Member Functions

EarlyOutPolyList ()

~EarlyOutPolyList ()

void clear ()

bool isEmpty () const

Are we empty of data?

U32 addPoint (const Point3F &p)

Adds a point to the poly list, and returns an ID number for that point.

U32 addPlane (const PlaneF &plane)

Adds a plane to the poly list, and returns an ID number for that point.

void begin (U32 material, U32 surfaceKey)

Start a surface.

void plane (U32 v1, U32 v2, U32 v3)

Indicate the plane of the surface.

void plane (const PlaneF &p)

Indicate the plane of the surface.

void plane (const U32 index)

Indicate the plane of the surface.

void vertex (U32 vi)

Reference a vertex which is in this surface.

void end ()

Mark the end of a surface.

Data Fields

PlaneList mPlaneList

VectorF mNormal

Protected Member Functions

const PlaneF & getIndexedPlane (const U32 index)

A helper function to convert a plane index to a PlaneF structure.

Private Types

typedef Vector< Vertex > VertexList

typedef Vector< Poly > PolyList

typedef Vector< U32 > IndexList

Private Member Functions

void memcpy (U32 *d, U32 *s, U32 size)

Private Attributes

PolyList mPolyList

VertexList mVertexList

IndexList mIndexList

bool mEarlyOut

PlaneList mPolyPlaneList

Data Structures

struct Poly

struct Vertex

Member Typedef Documentation

typedef Vector<PlaneF> EarlyOutPolyList::PlaneList

typedef Vector<Vertex> EarlyOutPolyList::VertexList [private]

typedef Vector<Poly> EarlyOutPolyList::PolyList [private]

typedef Vector<U32> EarlyOutPolyList::IndexList [private]

Constructor & Destructor Documentation

EarlyOutPolyList::EarlyOutPolyList ( )

EarlyOutPolyList::~EarlyOutPolyList ( )

Member Function Documentation

void EarlyOutPolyList::memcpy	(	U32 *	d,
		U32 *	s,
		U32	size
	)			`[private]`

void EarlyOutPolyList::clear ( )

bool EarlyOutPolyList::isEmpty ( ) const [virtual]

Are we empty of data?

Implements AbstractPolyList.

U32 EarlyOutPolyList::addPoint ( const Point3F & p ) [virtual]

Adds a point to the poly list, and returns an ID number for that point.

Implements AbstractPolyList.

U32 EarlyOutPolyList::addPlane ( const PlaneF & plane ) [virtual]

Adds a plane to the poly list, and returns an ID number for that point.

Implements AbstractPolyList.

void EarlyOutPolyList::begin	(	U32	material,
		U32	surfaceKey
	)			`[virtual]`

Start a surface.

Parameters:

	material	A material ID for this surface.
	surfaceKey	A key value to associate with this surface.

Implements AbstractPolyList.

void EarlyOutPolyList::plane	(	U32	v1,
		U32	v2,
		U32	v3
	)			`[virtual]`

Indicate the plane of the surface.

Implements AbstractPolyList.

void EarlyOutPolyList::plane ( const PlaneF & p ) [virtual]

Indicate the plane of the surface.

Implements AbstractPolyList.

void EarlyOutPolyList::plane ( const U32 index ) [virtual]

Indicate the plane of the surface.

Implements AbstractPolyList.

void EarlyOutPolyList::vertex ( U32 vi ) [virtual]

Reference a vertex which is in this surface.

Implements AbstractPolyList.

void EarlyOutPolyList::end ( ) [virtual]

Mark the end of a surface.

Implements AbstractPolyList.

const PlaneF& EarlyOutPolyList::getIndexedPlane ( const U32 index ) [protected, virtual]

A helper function to convert a plane index to a PlaneF structure.

Implements AbstractPolyList.

Field Documentation

PolyList EarlyOutPolyList::mPolyList [private]

VertexList EarlyOutPolyList::mVertexList [private]

IndexList EarlyOutPolyList::mIndexList [private]

bool EarlyOutPolyList::mEarlyOut [private]

PlaneList EarlyOutPolyList::mPolyPlaneList [private]

PlaneList EarlyOutPolyList::mPlaneList

VectorF EarlyOutPolyList::mNormal

All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen