Torque Game Engine Documentation
TGE Version 1.5.2

OptimizedPolyList Class Reference

#include <optimizedPolyList.h>

Inheritance diagram for OptimizedPolyList:

[legend]

Detailed Description

A concrete, renderable PolyList.

This class is used to store geometry from a PolyList query.

It allows you to render this data, as well.

See also:: AbstractPolyList

Public Types

enum {
  NonShared = 0,
  Concave,
  Convex
}

typedef Vector< PlaneF > PlaneList

typedef Vector< Point3F > VertexList

typedef Vector< Poly > PolyList

typedef Vector< U32 > IndexList

typedef Vector< Edge > EdgeList

Public Member Functions

const TriangleLighting * getTriangleLighting (const U32 index)

OptimizedPolyList ()

~OptimizedPolyList ()

void clear ()

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.

bool isEqual (Point3F &a, Point3F &b)

void copyPolyToList (OptimizedPolyList *target, U32 pdx) const

void copyPolyToList (OptimizedPolyList *target, const FullPoly &poly) const

FullPoly getFullPoly (U32 pdx)

void render ()

bool isEmpty () const

Are we empty of data?

Data Fields

Vector< TriangleLighting > mTriangleLightingList

PolyList mPolyList

VertexList mVertexList

IndexList mIndexList

PlaneList mPlaneList

EdgeList mEdgeList

PlaneList mPolyPlaneList

Protected Member Functions

const PlaneF & getIndexedPlane (const U32 index)

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

Data Structures

struct Edge

struct FullPoly

struct Poly

struct TriangleLighting

Member Typedef Documentation

typedef Vector<PlaneF> OptimizedPolyList::PlaneList

typedef Vector<Point3F> OptimizedPolyList::VertexList

typedef Vector<Poly> OptimizedPolyList::PolyList

typedef Vector<U32> OptimizedPolyList::IndexList

typedef Vector<Edge> OptimizedPolyList::EdgeList

Member Enumeration Documentation

anonymous enum

Enumerator:

NonShared
Concave
Convex

Constructor & Destructor Documentation

OptimizedPolyList::OptimizedPolyList ( )

OptimizedPolyList::~OptimizedPolyList ( )

Member Function Documentation

const TriangleLighting* OptimizedPolyList::getTriangleLighting ( const U32 index ) [inline]

void OptimizedPolyList::clear ( )

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

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

Implements AbstractPolyList.

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

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

Implements AbstractPolyList.

void OptimizedPolyList::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 OptimizedPolyList::plane	(	U32	v1,
		U32	v2,
		U32	v3
	)			`[virtual]`

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Reference a vertex which is in this surface.

Implements AbstractPolyList.

void OptimizedPolyList::end ( ) [virtual]

Mark the end of a surface.

Implements AbstractPolyList.

bool OptimizedPolyList::isEqual	(	Point3F &	a,
		Point3F &	b
	)			`[inline]`

void OptimizedPolyList::copyPolyToList	(	OptimizedPolyList *	target,
		U32	pdx
	)			const

void OptimizedPolyList::copyPolyToList	(	OptimizedPolyList *	target,
		const FullPoly &	poly
	)			const

FullPoly OptimizedPolyList::getFullPoly ( U32 pdx )

void OptimizedPolyList::render ( )

bool OptimizedPolyList::isEmpty ( ) const [virtual]

Are we empty of data?

Implements AbstractPolyList.

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

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

Implements AbstractPolyList.

Field Documentation

Vector<TriangleLighting> OptimizedPolyList::mTriangleLightingList

PolyList OptimizedPolyList::mPolyList

VertexList OptimizedPolyList::mVertexList

IndexList OptimizedPolyList::mIndexList

PlaneList OptimizedPolyList::mPlaneList

EdgeList OptimizedPolyList::mEdgeList

PlaneList OptimizedPolyList::mPolyPlaneList