iClipper2D Struct Reference
[Geometry utilities]
This interfaces represents a 2D clipper for polygons.
More...
#include <clip2d.h>
Inheritance diagram for iClipper2D:

Public Types | |
enum | ClipperType { clipperPoly, clipperBox } |
The type of a clipper. More... | |
Public Methods | |
virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount)=0 |
Clip a set of 2D points and return in 'OutPolygon' which is expected to contain space at least for MAX_OUTPUT_VERTICES elements. | |
virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csBox2 &BoundingBox)=0 |
Clip a set of 2D points. | |
virtual uint8 | Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csVertexStatus *OutStatus)=0 |
Clips a set of 2D points and provides additional information on each output vertex. | |
virtual uint8 | ClipInPlace (csVector2 *InPolygon, int &InOutCount, csBox2 &BoundingBox)=0 |
Wrapper function: clip a polygon in-place. | |
virtual int | ClassifyBox (const csBox2 &box)=0 |
Classify some bounding box against this clipper. | |
virtual bool | IsInside (const csVector2 &v)=0 |
Return true if given point is inside (or on bound) of clipper polygon. | |
virtual int | GetVertexCount ()=0 |
Return number of vertices for this clipper polygon. | |
virtual csVector2 * | GetClipPoly ()=0 |
Return a pointer to the array of csVector2's. | |
virtual ClipperType | GetClipperType () const=0 |
Retrieve the type of this clipper. |
Detailed Description
This interfaces represents a 2D clipper for polygons.
Definition at line 88 of file clip2d.h.
Member Enumeration Documentation
|
The type of a clipper.
|
Member Function Documentation
|
Classify some bounding box against this clipper. This function returns:
Implemented in csBoxClipper, and csPolygonClipper. |
|
Clips a set of 2D points and provides additional information on each output vertex. The information type can be: vertex is one of original vertices, vertex is on the edge of the original polygon and vertex is arbitrary located inside the original polygon. Both OutPolygon and OutStatus arrays are expected to have enough storage for at least MAX_OUTPUT_VERTICES elements. Returns one of CS_CLIP_*. Implemented in csBoxClipper, and csPolygonClipper. |
|
Clip a set of 2D points. On output OutCount is set to number of vertices in output polygon. The output array is expected to contain space for at least MAX_OUTPUT_VERTICES elements. The bounding box is set to the minimal rectangle that contains the output polygon. Returns one of CS_CLIP_*. Implemented in csBoxClipper, and csPolygonClipper. |
|
Clip a set of 2D points and return in 'OutPolygon' which is expected to contain space at least for MAX_OUTPUT_VERTICES elements. Returns one of CS_CLIP_*. Implemented in csBoxClipper, and csPolygonClipper. |
|
Wrapper function: clip a polygon in-place.
Returns one of CS_CLIP_*. Implemented in csClipper. |
|
Retrieve the type of this clipper.
Implemented in csBoxClipper, and csPolygonClipper. |
|
Return a pointer to the array of csVector2's.
Implemented in csBoxClipper, and csPolygonClipper. |
|
Return number of vertices for this clipper polygon.
Implemented in csBoxClipper, and csPolygonClipper. |
|
Return true if given point is inside (or on bound) of clipper polygon.
Implemented in csBoxClipper, and csPolygonClipper. |
The documentation for this struct was generated from the following file:
- igeom/clip2d.h
Generated for Crystal Space by doxygen 1.2.18