RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSVML > RSGdiPlusGraphics > Classes

TRSGPRegion Class

The TRSGPCanvasRegion class describes an area of the display surface. The area can be any shape. In other words, the boundary of the area can be a combination of curved and straight lines. Regions can also be created from the interiors of rectangles, paths, or a combination of these. Regions are used in clipping and hit-testing operations.

Note
This region class requires a canvas owner.

Namespace: RSGdiPlusGraphics

	Name	Description
	Create(TRSGPCanvas)	Overloaded. Creates a region that is infinite (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Create(TRSGPCanvas).)
	Create(TRSGPCanvas,GpRegion)	Overloaded. Creates a region that is defined by data obtained from another region.
	Create(TRSGPCanvas,HRGN)	Overloaded. Creates a region that is identical to the region that is specified by a handle to a GDI region.
	Create(TRSGPCanvas,TBytes)	Overloaded. Creates a region that is defined by data obtained from another region. The Data parameter is an array of bytes that specifies a region. The data contained in the bytes is obtained from another region by using the GetData method.
	Create(TRSGPCanvas,TRect)	Overloaded. Creates a region that is defined by a rectangle.
	Create(TRSGPCanvas,TRectF)	Overloaded. Creates a region that is defined by a rectangle.
	Create(TRSGPCanvas,TRSGPPath)	Overloaded. Creates a region that is defined by a path.

Top

Name

Description

public property

Bounds

Specifies the rectangle that encloses this region.

If you set the bounds, the region is replaced with a rectangle of that size.

public property

Handle

Handle of the graphics object, used by the MS GDI+ flat API routines (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public property

OnChange

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

public property

OnChanged

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

public property

Owner

Canvas that owns the object. The Canvas will free this graphics object if it is destroyed. However, to keep memory use under control, it is recommended that you free graphics objects when you are finished with them. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Top

Name

Description

public method

ApplyMatrix(TRSGPMatrix)

Transforms this region by multiplying each of its data points by a specified matrix.

public method

Assign(GpRegion)

Overloaded. Copies the GDI+ region to the TRSGPRegion

public method

Assign(HRGN)

Overloaded. Represents method Assign(HRGN).

public method

Assign(TPersistent)

Overloaded. Represents method Assign(TPersistent).

protected method

Changed

Call this method when the graphics object changes. It triggers an OnChange event. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public method

Clear

Updates this region to an empty region. In other words, the region occupies no space on the display device.

public method

Clone

Creates a copy of the current region.

Note
It is the responsibility of the calling code to free the region.

public method

Combine(TRect,TRSGPRegionCombineMode)

Overloaded. Combines the current region with the rectangle region

The mode parameter controls how the combining takes place:

cmReplace

New region replaces existing region

cmComplement

Specifies that the existing region is replaced by the portion of the new region that is outside of the existing region.

cmExclude

Specifies that the existing region is replaced by the portion of itself that is outside of the new region.

cmIntersect

Updates this region to the portion of itself that intersects the specified object's interior.

cmUnion

Updates this region to all portions (intersecting and nonintersecting) of itself and all portions of another object

cmXOR

Updates this region to the nonintersecting portions of itself and the specified object's interior

By default, the region is replaced with the input.

public method

Combine(TRectF,TRSGPRegionCombineMode)

Overloaded. Combines the current region with the rectangle region

The mode parameter controls how the combining takes place:

cmReplace

New region replaces existing region

cmComplement

Specifies that the existing region is replaced by the portion of the new region that is outside of the existing region.

cmExclude

Specifies that the existing region is replaced by the portion of itself that is outside of the new region.

cmIntersect

Updates this region to the portion of itself that intersects the specified object's interior.

cmUnion

Updates this region to all portions (intersecting and nonintersecting) of itself and all portions of another object

cmXOR

Updates this region to the nonintersecting portions of itself and the specified object's interior

By default, the region is replaced with the input.

public method

Combine(TRSGPPath,TRSGPRegionCombineMode)

Overloaded. Combines the current region with the path.

The mode parameter controls how the combining takes place:

cmReplace

New region replaces existing region

cmComplement

Specifies that the existing region is replaced by the portion of the new region that is outside of the existing region.

cmExclude

Specifies that the existing region is replaced by the portion of itself that is outside of the new region.

cmIntersect

Updates this region to the portion of itself that intersects the specified object's interior.

cmUnion

Updates this region to all portions (intersecting and nonintersecting) of itself and all portions of another object

cmXOR

Updates this region to the nonintersecting portions of itself and the specified object's interior

By default, the region is replaced with the input.

public method

Combine(TRSGPRegion,TRSGPRegionCombineMode)

Overloaded. Combines the current region with the data from the input region

The mode parameter controls how the combining takes place:

cmReplace

New region replaces existing region

cmComplement

Specifies that the existing region is replaced by the portion of the new region that is outside of the existing region.

cmExclude

Specifies that the existing region is replaced by the portion of itself that is outside of the new region.

cmIntersect

Updates this region to the portion of itself that intersects the specified object's interior.

cmUnion

Updates this region to all portions (intersecting and nonintersecting) of itself and all portions of another object

cmXOR

Updates this region to the nonintersecting portions of itself and the specified object's interior

By default, the region is replaced with the input.

public method

Equals(TObject)

Overloaded. Determines whether this region is equal to an object. If the Obj is a region, the method compares the shape of the region to see if they are equal.

public method

GetBounds

Returns a rectangle that encloses this region.

public method

GetData

Returns the data that describes this region.

protected method

GetHandle

Call this method to acquire a handle from the GDI+ flat API library (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.GetHandle.)

public method

GetHRGN

Creates a Windows Graphics Device Interface (GDI) region from this region.

public method

GetRegionScans

Overloaded. Gets an array of rectangles that approximate this region. The region is transformed by the owner canvas' matrix before the rectangles are calculated.

public method

IsEmpty

Determines whether this region is empty.

public method

IsInfinite

Determines whether this region is infinite.

public method

IsVisible(TPoint)

Overloaded. Returns true if the point is inside this region.

public method

IsVisible(TPointF)

Overloaded. Returns true if the point is inside this region.

public method

IsVisible(TRect)

Overloaded. Returns true if a rectangle intersects this region.

public method

IsVisible(TRectF)

Overloaded. Returns true if a rectangle intersects this region.

public method

MakeInfinite

Updates this region to an infinite region.

protected method

Notification(TRSGPCanvas)

Called when the Canvas is releasing control of the graphics object. The canvas will no longer be responsible for freeing the graphics object. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public method

Prepare(TRectF,Single)

Prepare the graphics object for drawing. Graphics objects respond in this method to upcoming calls. For example, gradient brushes can make sure the gradient will cover the entire rectangle. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public method

QueryInterface(TGUID,Void)

Represents method QueryInterface(TGUID,Void). (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

protected method

ReleaseHandle

Releases the underlying GDI+ object back to the GDI+ library. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.ReleaseHandle.)

public method

Translate(Integer,Integer)

Overloaded. Offsets this region by specified amounts in the horizontal and vertical directions.

public method

Translate(Single,Single)

Overloaded. Offsets this region by specified amounts in the horizontal and vertical directions.

public method

Update

Update native graphics object (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public method

_AddRef

Represents method _AddRef. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public method

_Release

Represents method _Release. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Top

RiverSoftAVG Products Help

Reference