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

CP_Clip Class Reference

CP_Clip. More...

Inheritance diagram for CP_Clip:

CP_NoCopy List of all members.

Public Member Functions

Constructor / Destructor
 CP_Clip ()
 Constructor.
 CP_Clip (const CP_Rect &inClipArea)
 CP_Clip (const CP_Region &inClipArea)
virtual ~CP_Clip ()
 Destructor.
Canvas
void UseInCanvas (CP_Canvas *inDestCanvas=NULL)
Setters
void Inset (SInt16 inHorAmt, SInt16 inVerAmt)
void Set (const CP_Rect &inClipArea)
void Set (const CP_Region &inClipRegion)
Intersection
void Intersect (const CP_Rect &inIntersect)
void Intersect (const CP_Region &inIntersect)
Save / Restore
void Save ()
void Restore ()
Getters
CP_Region GetClipRegion ()

Protected Attributes

CP_Region fClip
CP_Region fSavedClip

Detailed Description

Maintain the clipping region for a CP_Canvas object.


Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_Clip::CP_Clip  ) 
 

Constructor.

Exceptions:
none 

CP_Clip::CP_Clip const CP_Rect inClipArea  ) 
 

Constructor.

Parameters:
inClipArea The rect are we are going to limit drawing to.
Exceptions:
none 

CP_Clip::CP_Clip const CP_Region inClipArea  ) 
 

Constructor.

Parameters:
inClipArea The region we are going to limit drawing to.
Exceptions:
none 

CP_Clip::~CP_Clip  )  [virtual]
 

Destructor.

Exceptions:
none 


Member Function Documentation

void CP_Clip::UseInCanvas CP_Canvas inDestCanvas = NULL  ) 
 

Make the clipping region current for the setup port.

Parameters:
inDestCanvas Pointer to the CP_Canvas object to set the clip region for.
Exceptions:
none 
Returns:
void

void CP_Clip::Inset SInt16  inHorAmt,
SInt16  inVerAmt
 

Inset our clipping region by the specified amount.

Parameters:
inHorAmt Horizontal amount to inset region by.
inVerAmt Vertical amount to inset region by.
Exceptions:
none 
Returns:
void

void CP_Clip::Set const CP_Rect inClipArea  ) 
 

Set our clip area from a CP_Rect.

Parameters:
inClipArea The rectange to use as the clipping area.
Exceptions:
none 
Returns:
void

void CP_Clip::Set const CP_Region inClipRegion  ) 
 

Sets the region to be used for clipping.

Parameters:
inClipRegion The region to use to clip.
Exceptions:
none 
Returns:
void

void CP_Clip::Intersect const CP_Rect inIntersect  ) 
 

Set our clipping region to the intersection of our bounds and the passed in rect.

Parameters:
inIntersect The area to intersect our clipping area with.
Exceptions:
none 
Returns:
void

void CP_Clip::Intersect const CP_Region inIntersect  ) 
 

Set our clipping region to the intersection of our bounds and the passed in region.

Parameters:
inIntersect The area to intersect our clipping area with.
Exceptions:
none 
Returns:
void

void CP_Clip::Save  ) 
 

Save the current clipping region. This is the region that will later be used when calling the Restore method.

Exceptions:
none 
Returns:
void

void CP_Clip::Restore  ) 
 

Restores the previously saved clipping region.

Exceptions:
none 
Returns:
void

CP_Region CP_Clip::GetClipRegion  ) 
 

Returns the region used for clipping.

Exceptions:
none 
Returns:
CP_Region The region used for clipping.


Member Data Documentation

CP_Region CP_Clip::fClip [protected]
 

CP_Region CP_Clip::fSavedClip [protected]
 

Current clipping region.


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:26 2005 for CPLAT by  doxygen 1.4.0