CrystalSpace

Public API Reference

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

csBoxClipper Class Reference
[Geometry utilities]

The csBoxClipper class is able to clip convex polygons to a rectangle (such as the screen). More...

#include <polyclip.h>

Inheritance diagram for csBoxClipper:

csClipper iClipper2D iBase List of all members.

Public Methods

 csBoxClipper (const csBox2 &b)
 Initializes the clipper object to the given bounding region. More...

 csBoxClipper (float x1, float y1, float x2, float y2)
 Initializes the clipper object to a rectangle with the given coords. More...

virtual uint8 Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount)
 Simple clipping. More...

virtual uint8 Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csBox2 &BoundingBox)
 Clip and compute the bounding box. More...

virtual uint8 Clip (csVector2 *InPolygon, int InCount, csVector2 *OutPolygon, int &OutCount, csVertexStatus *OutStatus)
 Clip and return additional information about each vertex. More...

virtual int ClassifyBox (const csBox2 &box)
 Classify some bounding box against this clipper. More...

virtual bool IsInside (const csVector2 &v)
 Return true if given point is inside (or on bound) of clipper polygon. More...

virtual int GetVertexCount ()
 Return number of vertices for this clipper polygon. More...

virtual csVector2GetClipPoly ()
 Return a pointer to the array of csVector2's. More...


Detailed Description

The csBoxClipper class is able to clip convex polygons to a rectangle (such as the screen).

Definition at line 70 of file polyclip.h.


Constructor & Destructor Documentation

csBoxClipper::csBoxClipper const csBox2   b [inline]
 

Initializes the clipper object to the given bounding region.

Definition at line 88 of file polyclip.h.

csBoxClipper::csBoxClipper float    x1,
float    y1,
float    x2,
float    y2
[inline]
 

Initializes the clipper object to a rectangle with the given coords.

Definition at line 91 of file polyclip.h.


Member Function Documentation

virtual int csBoxClipper::ClassifyBox const csBox2   box [virtual]
 

Classify some bounding box against this clipper.

Implements iClipper2D.

virtual uint8 csBoxClipper::Clip csVector2   InPolygon,
int    InCount,
csVector2   OutPolygon,
int &    OutCount,
csVertexStatus   OutStatus
[virtual]
 

Clip and return additional information about each vertex.

Implements iClipper2D.

virtual uint8 csBoxClipper::Clip csVector2   InPolygon,
int    InCount,
csVector2   OutPolygon,
int &    OutCount,
csBox2   BoundingBox
[virtual]
 

Clip and compute the bounding box.

Implements iClipper2D.

virtual uint8 csBoxClipper::Clip csVector2   InPolygon,
int    InCount,
csVector2   OutPolygon,
int &    OutCount
[virtual]
 

Simple clipping.

Implements iClipper2D.

virtual csVector2* csBoxClipper::GetClipPoly   [inline, virtual]
 

Return a pointer to the array of csVector2's.

Implements iClipper2D.

Definition at line 118 of file polyclip.h.

virtual int csBoxClipper::GetVertexCount   [inline, virtual]
 

Return number of vertices for this clipper polygon.

Implements iClipper2D.

Definition at line 114 of file polyclip.h.

virtual bool csBoxClipper::IsInside const csVector2   v [inline, virtual]
 

Return true if given point is inside (or on bound) of clipper polygon.

Implements iClipper2D.

Definition at line 110 of file polyclip.h.

References csBox2::In, csVector2::x, and csVector2::y.


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