CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

csBoxClipper Class Reference
[Geometry utilities]

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

#include <csgeom/polyclip.h>

Inheritance diagram for csBoxClipper:

csClipper List of all members.

Public Member Functions

virtual int ClassifyBox (const csBox2 &box)
 Classify some bounding box against this clipper.
virtual uint8 Clip (csVector2 *InPolygon, size_t InCount, csVector2 *OutPolygon, size_t &OutCount, csVertexStatus *OutStatus)
 Clip and return additional information about each vertex.
virtual uint8 Clip (csVector2 *InPolygon, size_t InCount, csVector2 *OutPolygon, size_t &OutCount, csBox2 &BoundingBox)
 Clip and compute the bounding box.
virtual uint8 Clip (csVector2 *InPolygon, size_t InCount, csVector2 *OutPolygon, size_t &OutCount)
 Simple clipping.
 csBoxClipper (float x1, float y1, float x2, float y2)
 Initializes the clipper object to a rectangle with the given coords.
 csBoxClipper (const csBox2 &b)
 Initializes the clipper object to the given bounding region.
virtual ClipperType GetClipperType () const
virtual csVector2GetClipPoly ()
 Return a pointer to the array of csVector2's.
virtual size_t GetVertexCount ()
 Return number of vertices for this clipper polygon.
virtual bool IsInside (const csVector2 &v)
 Return true if given point is inside (or on bound) of clipper polygon.

Detailed Description

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

Definition at line 77 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 95 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 98 of file polyclip.h.


Member Function Documentation

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

Classify some bounding box against this clipper.

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

Clip and return additional information about each vertex.

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

Clip and compute the bounding box.

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

Simple clipping.

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

Return a pointer to the array of csVector2's.

Definition at line 125 of file polyclip.h.

virtual size_t csBoxClipper::GetVertexCount  )  [inline, virtual]
 

Return number of vertices for this clipper polygon.

Definition at line 121 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.

Definition at line 117 of file polyclip.h.

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


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