CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csPoly2DEdges Class Reference
[Geometry utilities]

The following class represents a general 2D polygon represented with edges instead of vertices. More...

#include <polyedge.h>

List of all members.

Public Methods

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

 csPoly2DEdges (csPoly2DEdges &copy)
 Copy constructor.

virtual ~csPoly2DEdges ()
 Destructor.

void MakeEmpty ()
 Initialize the polygon to empty.

int GetEdgeCount ()
 Get the number of edges.

csSegment2GetEdges ()
 Get the array with all edges.

csSegment2GetEdge (int i)
 Get the specified edge.

csSegment2operator[] (int i)
 Get the specified edge.

csSegment2GetFirst ()
 Get the first edge.

csSegment2GetLast ()
 Get the last edge.

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 edges.

void SetEdgeCount (int n)
 Set the number of edges.

int AddEdge (const csSegment2 &e)
 Add a edge (2D) to the polygon.

int AddEdge (const csVector2 &v1, const csVector2 &v2)
 Add a edge (2D) to the polygon.

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


Static Public Methods

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


Protected Attributes

csSegment2edges
 The edges.


Detailed Description

The following class represents a general 2D polygon represented with edges instead of vertices.

Definition at line 35 of file polyedge.h.


Constructor & Destructor Documentation

csPoly2DEdges::csPoly2DEdges int    start_size = 10
 

Make a new empty polygon.

csPoly2DEdges::csPoly2DEdges csPoly2DEdges &    copy
 

Copy constructor.

virtual csPoly2DEdges::~csPoly2DEdges   [virtual]
 

Destructor.


Member Function Documentation

int csPoly2DEdges::AddEdge const csVector2   v1,
const csVector2   v2
 

Add a edge (2D) to the polygon.

Return index of added edge.

int csPoly2DEdges::AddEdge const csSegment2   e [inline]
 

Add a edge (2D) to the polygon.

Return index of added edge.

Definition at line 126 of file polyedge.h.

References csSegment2::End(), and csSegment2::Start().

csSegment2* csPoly2DEdges::GetEdge int    i [inline]
 

Get the specified edge.

Definition at line 75 of file polyedge.h.

int csPoly2DEdges::GetEdgeCount   [inline]
 

Get the number of edges.

Definition at line 65 of file polyedge.h.

csSegment2* csPoly2DEdges::GetEdges   [inline]
 

Get the array with all edges.

Definition at line 70 of file polyedge.h.

csSegment2* csPoly2DEdges::GetFirst   [inline]
 

Get the first edge.

Definition at line 93 of file polyedge.h.

csSegment2* csPoly2DEdges::GetLast   [inline]
 

Get the last edge.

Definition at line 99 of file polyedge.h.

bool csPoly2DEdges::In csSegment2   poly,
int    num_edge,
const csVector2   v
[static]
 

Test if a vector is inside the given polygon.

bool csPoly2DEdges::In const csVector2   v
 

Test if this vector is inside the polygon.

void csPoly2DEdges::Intersect const csPlane2   plane,
csPoly2DEdges &    left,
csPoly2DEdges &    right,
bool &    onplane
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 this edge will be ignored and 'onplane' will be set to true.

Note that this routine may result in unconnected polygons. i.e. edges that are not adjacent.

void csPoly2DEdges::MakeEmpty  
 

Initialize the polygon to empty.

void csPoly2DEdges::MakeRoom int    new_max
 

Make room for at least the specified number of edges.

Referenced by SetEdgeCount().

csSegment2& csPoly2DEdges::operator[] int    i [inline]
 

Get the specified edge.

Definition at line 84 of file polyedge.h.

void csPoly2DEdges::SetEdgeCount int    n [inline]
 

Set the number of edges.

Definition at line 120 of file polyedge.h.

References MakeRoom().


Member Data Documentation

csSegment2* csPoly2DEdges::edges [protected]
 

The edges.

Definition at line 39 of file polyedge.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18