Torque Game Engine Documentation
CVS Revision Label 1.3.x

ClippedPolyList Class Reference

#include <clippedPolyList.h>

Inheritance diagram for ClippedPolyList:

Detailed Description

This takes the geometry passed to it and clips against the PlaneList set by the caller.

See also:: AbstractPolyList

Public Types

typedef Vector< PlaneF > PlaneList

typedef Vector< Vertex > VertexList

typedef Vector< Poly > PolyList

typedef Vector< U32 > IndexList

Public Member Functions

ClippedPolyList ()

~ClippedPolyList ()

void clear ()

void render ()

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

PolyList mPolyList

VertexList mVertexList

IndexList mIndexList

PlaneList mPolyPlaneList

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 Member Functions

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

Data Structures

struct Poly

struct Vertex

Member Typedef Documentation

typedef Vector<PlaneF> ClippedPolyList::PlaneList

typedef Vector<Vertex> ClippedPolyList::VertexList

typedef Vector<Poly> ClippedPolyList::PolyList

typedef Vector<U32> ClippedPolyList::IndexList

Constructor & Destructor Documentation

ClippedPolyList::ClippedPolyList ( )

ClippedPolyList::~ClippedPolyList ( )

Member Function Documentation

void ClippedPolyList::memcpy ( U32 * d,

U32 * s,

U32 size

) [private]

void ClippedPolyList::clear ( )

Reimplemented in DepthSortList.

void ClippedPolyList::render ( )

Reimplemented in DepthSortList.

bool ClippedPolyList::isEmpty ( ) const [virtual]

Are we empty of data?

Implements AbstractPolyList.

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

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

Implements AbstractPolyList.

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

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

Implements AbstractPolyList.

void ClippedPolyList::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 ClippedPolyList::plane ( U32 v1,

U32 v2,

U32 v3

) [virtual]

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Indicate the plane of the surface.

Implements AbstractPolyList.

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

Reference a vertex which is in this surface.

Implements AbstractPolyList.

void ClippedPolyList::end ( ) [virtual]

Mark the end of a surface.

Implements AbstractPolyList.
Reimplemented in DepthSortList.

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

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

Implements AbstractPolyList.

Field Documentation

PolyList ClippedPolyList::mPolyList

VertexList ClippedPolyList::mVertexList

IndexList ClippedPolyList::mIndexList

PlaneList ClippedPolyList::mPolyPlaneList

PlaneList ClippedPolyList::mPlaneList

VectorF ClippedPolyList::mNormal