Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

csPoly3D Class Reference

The following class represents a general 3D polygon. More...

#include <poly3d.h>

Inheritance diagram for csPoly3D:

csVector3Array List of all members.

Public Methods

 csPoly3D (int start_size=10)
 Make a new empty polygon.

 csPoly3D (const csPoly3D &copy)
 Copy constructor.

virtual ~csPoly3D ()
 Destructor.

void MakeEmpty ()
 Initialize the polygon to empty.

int GetVertexCount () const
 Get the number of vertices.

csVector3GetVertices () const
 Get the array with all vertices.

csVector3GetVertex (int i) const
 Get the specified vertex.

csVector3operator[] (int i)
 Get the specified vertex.

csVector3operator[] (int i) const
 Get the specified vertex.

csVector3GetFirst () const
 Get the first vertex.

csVector3GetLast () const
 Get the last vertex.

bool In (const csVector3 &v) const
 Test if this vector is inside the polygon.

void MakeRoom (int new_max)
 Make room for at least the specified number of vertices.

void SetVertexCount (int n)
 Set the number of vertices.

int AddVertex (const csVector3 &v)
 Add a vertex (3D) to the polygon. More...

int AddVertex (float x, float y, float z)
 Add a vertex (3D) to the polygon. More...

void SetVertices (csVector3 const *v, int num)
 Set all polygon vertices at once. More...

bool ProjectXPlane (const csVector3 &point, float plane_x, csPoly2D *poly2d) const
 Project this polygon onto a X plane as seen from some point in space. More...

bool ProjectYPlane (const csVector3 &point, float plane_y, csPoly2D *poly2d) const
 Project this polygon onto a Y plane as seen from some point in space. More...

bool ProjectZPlane (const csVector3 &point, float plane_z, csPoly2D *poly2d) const
 Project this polygon onto a Z plane as seen from some point in space. More...

bool ProjectAxisPlane (const csVector3 &point, int plane_nr, float plane_pos, csPoly2D *poly2d) const
 Project this polygon onto an axis-aligned plane as seen from some point in space. More...

int Classify (const csPlane3 &pl) const
 Classify this polygon with regards to a plane. More...

int ClassifyX (float x) const
 Same as Classify() but for X plane only.

int ClassifyY (float y) const
 Same as Classify() but for Y plane only.

int ClassifyZ (float z) const
 Same as Classify() but for Z plane only.

void CutToPlane (const csPlane3 &split_plane)
 Cut this polygon with a plane and only keep the front side.

void SplitWithPlane (csPoly3D &front, csPoly3D &back, const csPlane3 &split_plane) const
 Split this polygon with the given plane (A,B,C,D).

void SplitWithPlaneX (csPoly3D &front, csPoly3D &back, float x) const
 Split this polygon to the x-plane.

void SplitWithPlaneY (csPoly3D &front, csPoly3D &back, float y) const
 Split this polygon to the y-plane.

void SplitWithPlaneZ (csPoly3D &front, csPoly3D &back, float z) const
 Split this polygon to the z-plane.

csVector3 ComputeNormal () const
 Compute the normal of this polygon.

csPlane3 ComputePlane () const
 Compute the plane of this polygon.

float GetSignedArea () const
 Calculate the signed area of this polygon.

csVector3 GetCenter () const
 Compute and get the central vertex of this polygon.


Static Public Methods

bool In (csVector3 *poly, int num_poly, const csVector3 &v)
 Test if a vector is inside the given polygon.

int Classify (const csPlane3 &pl, csVector3 *vertices, int num_vertices)
 Static function to classify a polygon with regards to a plane. More...

csVector3 ComputeNormal (csVector3 *vertices, int num)
 Compute the normal of a polygon.

csPlane3 ComputePlane (csVector3 *vertices, int num)
 Compute the plane of a polygon.


Protected Attributes

csVector3vertices
 The 3D vertices.

int num_vertices
int max_vertices

Detailed Description

The following class represents a general 3D polygon.


Member Function Documentation

int csPoly3D::AddVertex ( float x,
float y,
float z )
 

Add a vertex (3D) to the polygon.

Return index of added vertex.

int csPoly3D::AddVertex ( const csVector3 & v ) [inline]
 

Add a vertex (3D) to the polygon.

Return index of added vertex.

int csPoly3D::Classify ( const csPlane3 & pl ) const [inline]
 

Classify this polygon with regards to a plane.

If this poly is on same plane it returns CS_POL_SAME_PLANE. If this poly is completely in front of the given plane it returnes CS_POL_FRONT. If this poly is completely back of the given plane it returnes CS_POL_BACK. Otherwise it returns CS_POL_SPLIT_NEEDED.

int csPoly3D::Classify ( const csPlane3 & pl,
csVector3 * vertices,
int num_vertices ) [static]
 

Static function to classify a polygon with regards to a plane.

If this poly is on same plane it returns CS_POL_SAME_PLANE. If this poly is completely in front of the given plane it returnes CS_POL_FRONT. If this poly is completely back of the given plane it returnes CS_POL_BACK. Otherwise it returns CS_POL_SPLIT_NEEDED.

bool csPoly3D::ProjectAxisPlane ( const csVector3 & point,
int plane_nr,
float plane_pos,
csPoly2D * poly2d ) const [inline]
 

Project this polygon onto an axis-aligned plane as seen from some point in space.

Fills the given 2D polygon with the projection on the plane. This function assumes that there actually is a projection. Plane_nr is 0 for the X plane, 1 for Y, and 2 for Z.

bool csPoly3D::ProjectXPlane ( const csVector3 & point,
float plane_x,
csPoly2D * poly2d ) const
 

Project this polygon onto a X plane as seen from some point in space.

Fills the given 2D polygon with the projection on the plane. This function assumes that there actually is a projection. If the polygon to project comes on the same plane as 'point' then it will return false (no valid projection).

bool csPoly3D::ProjectYPlane ( const csVector3 & point,
float plane_y,
csPoly2D * poly2d ) const
 

Project this polygon onto a Y plane as seen from some point in space.

Fills the given 2D polygon with the projection on the plane. This function assumes that there actually is a projection. If the polygon to project comes on the same plane as 'point' then it will return false (no valid projection).

bool csPoly3D::ProjectZPlane ( const csVector3 & point,
float plane_z,
csPoly2D * poly2d ) const
 

Project this polygon onto a Z plane as seen from some point in space.

Fills the given 2D polygon with the projection on the plane. This function assumes that there actually is a projection. If the polygon to project comes on the same plane as 'point' then it will return false (no valid projection).

void csPoly3D::SetVertices ( csVector3 const * v,
int num ) [inline]
 

Set all polygon vertices at once.

Copies the array.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000