In file include/csgeom/polyclip.h:

## class csClipper

> The csClipper class is an abstract parent to all 2D clipping objects

## Inheritance:

### Public Methods

  virtual bool | Clip (csVector2 *Polygon, csVector2* dest_poly, int Count, int &OutCount) Clip a set of 2D points and return in 'dest_poly'
  virtual bool | Clip (csVector2 *Polygon, int &Count, int MaxCount, csBox *BoundingBox) Clip a set of 2D points and return them in the same array
  virtual int | GetNumVertices () Return number of vertices for this clipper polygon.
  virtual const csVector2 | GetVertex (int i) Return vertex at index for this clipper polygon.
  virtual bool | IsInside (float x, float y) Return true if given point is inside (or on bound) of clipper polygon.

### Protected Fields

  static csPoly2DPool | polypool This variable holds a pool for 2D polygons as used by the clipper.

## Documentation

> The csClipper class is an abstract parent to all 2D clipping objects

`static csPoly2DPool polypool`
  This variable holds a pool for 2D polygons as used by the clipper.

`virtual bool Clip(csVector2 *Polygon, csVector2* dest_poly, int Count, int &OutCount)`
  Clip a set of 2D points and return in 'dest_poly'. 'dest_poly' must be big enough to hold the clipped polygon. Return false if polygon is not visible (clipped away).

`virtual bool Clip(csVector2 *Polygon, int &Count, int MaxCount, csBox *BoundingBox)`
  Clip a set of 2D points and return them in the same array. On input MaxCount contains number of elements that Output can hold. On output Count is set to number of vertices in output polygon.

`virtual bool IsInside(float x, float y)`
  Return true if given point is inside (or on bound) of clipper polygon.

`virtual int GetNumVertices()`
  Return number of vertices for this clipper polygon.

`virtual const csVector2 GetVertex(int i)`
  Return vertex at index for this clipper polygon.

Direct child classes:
  csPolygonClipper
  csBoxClipper

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de