csPolygonClipper Class Reference
[Geometry utilities]
The csPolygonClipper class can be used for clipping any polygon against any other convex polygon.
More...
#include <csgeom/polyclip.h>
Inheritance diagram for csPolygonClipper:
Public Member Functions | |
| csPolygonClipper (csPoly2D *Clipper, bool mirror=false, bool copy=false) | |
| Create a polygon clipper object from a 2D polygon. | |
| csPolygonClipper (csVector2 *Clipper, int Count, bool mirror=false, bool copy=false) | |
| Create a polygon clipper object from a set of 2D vectors. | |
| virtual | ~csPolygonClipper () |
| Destroy the polygon clipper object. | |
| virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount) |
| Simple clipping. | |
| virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csBox2 &BoundingBox) |
| Clip and compute the bounding box. | |
| virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csVertexStatus *OutStatus) |
| Clip and return additional information about each vertex. | |
| virtual int | ClassifyBox (const csBox2 &box) |
| Classify some bounding box against this clipper. | |
| virtual bool | IsInside (const csVector2 &v) |
| Return true if given point is inside (or on bound) of clipper polygon. | |
| virtual int | GetVertexCount () |
| Return number of vertices for this clipper polygon. | |
| virtual csVector2 * | GetClipPoly () |
| Return a pointer to the array of csVector2's. | |
| virtual ClipperType | GetClipperType () const |
| Retrieve the type of this clipper. | |
Detailed Description
The csPolygonClipper class can be used for clipping any polygon against any other convex polygon.The clipper object should be used, if possible, for many polygons (for example, a 3D sprite can initialize a clipper object then clip all of its triangle against it at once) as the initialization of clipper polygon involves some (although not too expensive) calculations. The clipping polygon *should* be convex since the routine does not expect any line to intersect the edge of clipping polygon more than twice.
Definition at line 137 of file polyclip.h.
Constructor & Destructor Documentation
|
||||||||||||||||
|
Create a polygon clipper object from a 2D polygon.
|
|
||||||||||||||||||||
|
Create a polygon clipper object from a set of 2D vectors.
|
|
|
Destroy the polygon clipper object.
|
Member Function Documentation
|
|
Classify some bounding box against this clipper.
Implements iClipper2D. |
|
||||||||||||||||||||||||
|
Clip and return additional information about each vertex.
Implements iClipper2D. |
|
||||||||||||||||||||||||
|
Clip and compute the bounding box.
Implements iClipper2D. |
|
||||||||||||||||||||
|
Simple clipping.
Implements iClipper2D. |
|
|
Retrieve the type of this clipper.
Implements iClipper2D. Definition at line 188 of file polyclip.h. |
|
|
Return a pointer to the array of csVector2's.
Implements iClipper2D. Definition at line 185 of file polyclip.h. |
|
|
Return number of vertices for this clipper polygon.
Implements iClipper2D. Definition at line 182 of file polyclip.h. |
|
|
Return true if given point is inside (or on bound) of clipper polygon.
Implements iClipper2D. |
The documentation for this class was generated from the following file:
- csgeom/polyclip.h
Generated for Crystal Space by doxygen 1.3.9.1