Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

csPoly2D Class Reference

The following class represents a general 2D polygon with a bounding box. More...

#include <poly2d.h>

Inheritance diagram for csPoly2D:

csPolygon2D List of all members.

Public Methods

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

 csPoly2D (const csPoly2D &copy)
 Copy constructor.

virtual ~csPoly2D ()
 Destructor.

csPoly2D& operator= (const csPoly2D &other)
 Assignment operator.

void MakeEmpty ()
 Initialize the polygon to empty.

int GetVertexCount ()
 Get the number of vertices.

int GetVertexCount () const
 Get the number of vertices.

csVector2GetVertices ()
 Get the array with all vertices.

csVector2GetVertex (int i)
 Get the specified vertex.

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

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

csVector2GetFirst ()
 Get the first vertex.

csVector2GetLast ()
 Get the last vertex.

bool In (const csVector2 &v)
 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 csVector2 &v)
 Add a vertex (2D) to the polygon. More...

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

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

void UpdateBoundingBox ()
 Update the bounding box (useful after SetVertices).

csBox2GetBoundingBox ()
 Get the bounding box (in 2D space) for this polygon.

bool ClipAgainst (iClipper2D *view)
 Clipping routines. More...

void Intersect (const csPlane2 &plane, csPoly2D &left, csPoly2D &right) const
 Intersect this polygon with a given plane and return the two resulting polygons in left and right. More...

void ClipPlane (const csPlane2 &plane, csPoly2D &right) const
 This routine is similar to Intersect but it only returns the polygon on the 'right' (positive) side of the plane.

void ExtendConvex (const csPoly2D &other, int this_edge)
 Extend this polygon with another polygon so that the resulting polygon is: (a) still convex, (b) fully contains this polygon, and (c) contains as much as possible of the other polgon. More...

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

void Random (int num, const csBox2 &max_bbox)
 Generate a random convex polygon with the specified number of vertices. More...


Static Public Methods

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


Protected Attributes

csVector2vertices
 The 2D vertices.

int num_vertices
int max_vertices
csBox2 bbox
 A 2D bounding box that is maintained automatically.


Detailed Description

The following class represents a general 2D polygon with a bounding box.


Member Function Documentation

int csPoly2D::AddVertex ( float x,
float y )
 

Add a vertex (2D) to the polygon.

Return index of added vertex.

int csPoly2D::AddVertex ( const csVector2 & v ) [inline]
 

Add a vertex (2D) to the polygon.

Return index of added vertex.

bool csPoly2D::ClipAgainst ( iClipper2D * view )
 

Clipping routines.

They return false if the resulting polygon is not visible for some reason. Note that these routines must not be called if the polygon is not visible. These routines will not check that. Note that these routines will put the resulting clipped 2D polygon in place of the original 2D polygon.

void csPoly2D::ExtendConvex ( const csPoly2D & other,
int this_edge )
 

Extend this polygon with another polygon so that the resulting polygon is: (a) still convex, (b) fully contains this polygon, and (c) contains as much as possible of the other polgon.

'this_edge' is the index of the common edge for this polygon. Edges are indexed with 0 being the edge from 0 to 1 and n-1 being the edge from n-1 to 0.

void csPoly2D::Intersect ( const csPlane2 & plane,
csPoly2D & left,
csPoly2D & right ) const
 

Intersect this polygon with a given plane and return the two resulting polygons in left and right.

This version is robust. If one of the edges of this polygon happens to be on the same plane as 'plane' then the edge will go to the polygon which already has most edges. i.e. you will not get degenerate polygons.

void csPoly2D::Random ( int num,
const csBox2 & max_bbox )
 

Generate a random convex polygon with the specified number of vertices.

The polygon will be inside the given bounding box. @@ Currently only triangles are supported.

void csPoly2D::SetVertices ( csVector2 const * v,
int num ) [inline]
 

Set all polygon vertices at once.

Copies the array. Note! This doesn't update the bounding box!


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