GeoCore::BClip

BClip Class Reference

#include <BClip.h>

List of all members.

Detailed Description

Represents an area that will be used for clipping.

Public Member Functions

 BClip (const BClip &clip)
 Copy constructor.
 BClip ()
 Default constructor.
virtual BClip * Clone () const
 Creates a deep-copy of this object.
virtual const EClipType GetClipType (void) const
 Get the type of this BClip.
virtual const
BAreaGeoPtr & 		GetGeometry (void) const
 Gets the geometry of this BClip.
const BRect & GetMBR () const
 Gets the MBR of the clip region.
bool Initialize ()
 Set up the clipper based on its geometry (polygon, etc.
virtual bool IsClipped (const BPoint &point) const
 Determines if specified BPoint is clipped by this BClip.
virtual void SetClipType (EClipType type)
 Set the type of this BClip.
virtual void SetGeometry (const BAreaGeoPtr &geo)
 Sets the geometry of this BClip.
virtual void Transform (const BTransform &cst)
 Transforms the coordinates of this BClip to a different coordinate system.
virtual void TransformReverse (const BTransform &cst)
 Transforms the coordinates of this BClip to a different coordinate system using the "reverse" of the BTransform.
virtual ~BClip ()
 Destructor.

Protected Member Functions

BGeometryPtr ApplyClip (BGeometryPtr &clippee)
 Applies this BClip to the passed in "clippee" geometry.

Friends

class BFeature

Constructor & Destructor Documentation

BClip (  ) 

Default constructor.

This will create a BClip that does not have any geometry.

BClip ( const BClip &  clip  ) 

Copy constructor.

Parameters:
clip the BClip to copy.

virtual ~BClip (  )  [inline, virtual]

Destructor.

Member Function Documentation

BGeometryPtr ApplyClip ( BGeometryPtr &  clippee  )  [protected]

Applies this BClip to the passed in "clippee" geometry.

Parameters:
clippee The BGeometry object that will be clipped.
Returns:
The resulting clipped geometry or NULL if everything is clipped.

virtual BClip* Clone (  )  const [inline, virtual]

Creates a deep-copy of this object.

Returns:
A deep-copy of this object.

virtual const EClipType GetClipType ( void   )  const [inline, virtual]

Get the type of this BClip.

Returns:
The type of this BClip.

virtual const BAreaGeoPtr& GetGeometry ( void   )  const [inline, virtual]

Gets the geometry of this BClip.

Returns:
The geometry of this BClip.

const BRect& GetMBR (  )  const [inline]

Gets the MBR of the clip region.

This is equivalent to the MBR of the underlying geometry for this BClip.

Returns:
The MBR of the clip region.

bool Initialize (  ) 

Set up the clipper based on its geometry (polygon, etc.

)

virtual bool IsClipped ( const BPoint &  point  )  const [virtual]

Determines if specified BPoint is clipped by this BClip.

This is equivalent to determining if the BPoint is within the bounds of the underlying geometry of this BClip.

Parameters:
point The BPoint to test for containment.
Returns:
True if the BPoint is outside of this BClip region and false otherwise.

virtual void SetClipType ( EClipType  type  )  [inline, virtual]

Set the type of this BClip.

Parameters:
type The new type for this BClip.

virtual void SetGeometry ( const BAreaGeoPtr &  geo  )  [virtual]

Sets the geometry of this BClip.

Parameters:
geo The geometry of the BClip.

virtual void Transform ( const BTransform &  cst  )  [virtual]

Transforms the coordinates of this BClip to a different coordinate system.

Parameters:
cst The BTransform that describes the transformation.

virtual void TransformReverse ( const BTransform &  cst  )  [virtual]

Transforms the coordinates of this BClip to a different coordinate system using the "reverse" of the BTransform.

Parameters:
cst The BTransform that describes the transformation.

Friends And Related Function Documentation

friend class BFeature [friend]

The documentation for this class was generated from the following file:
GeoTranslate 5.0 From Blue Marble Geographics