Region Class
Summary: Describes the interior of a graphics shape composed of rectangles and paths. This class cannot be inherited.
Module: aspose.imaging
Full Name: aspose.imaging.Region
Constructors
| Name | Description |
|---|---|
| Region() | Initializes a new Region. |
| Region(path) | Initializes a new Region with the specified GraphicsPath. |
| Region(rect) | Initializes a new Region from the specified RectangleF structure. |
| Region(rect) | Initializes a new Region from the specified RectangleF structure. |
Methods
| Name | Description |
|---|---|
| complement(path) | Updates this Region to contain the portion of the specified GraphicsPath that does not intersect with this Region. |
| complement(rect) | Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region. |
| complement(rect) | Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region. |
| complement(region) | Updates this Region to contain the portion of the specified Region that does not intersect with this Region. |
| complement_path(path) | Updates this Region to contain the portion of the specified GraphicsPath that does not intersect with this Region. |
| complement_rect(rect) | Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region. |
| complement_rect_f(rect) | Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region. |
| complement_rgn(region) | Updates this Region to contain the portion of the specified Region that does not intersect with this Region. |
| create_with_path(path) | Initializes a new Region with the specified GraphicsPath. |
| create_with_rect(rect) | Initializes a new Region from the specified RectangleF structure. |
| create_with_rect_f(rect) | Initializes a new Region from the specified RectangleF structure. |
| deep_clone() | Creates an exact deep copy of this Region. |
| exclude(path) | Updates this Region to contain only the portion of its interior that does not intersect with the specified GraphicsPath. |
| exclude(rect) | Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure. |
| exclude(rect) | Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure. |
| exclude(region) | Updates this Region to contain only the portion of its interior that does not intersect with the specified Region. |
| exclude_path(path) | Updates this Region to contain only the portion of its interior that does not intersect with the specified GraphicsPath. |
| exclude_rect(rect) | Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure. |
| exclude_rect_f(rect) | Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure. |
| exclude_rgn(region) | Updates this Region to contain only the portion of its interior that does not intersect with the specified Region. |
| intersect(path) | Updates this Region to the intersection of itself with the specified GraphicsPath. |
| intersect(rect) | Updates this Region to the intersection of itself with the specified RectangleF structure. |
| intersect(rect) | Updates this Region to the intersection of itself with the specified RectangleF structure. |
| intersect(region) | Updates this Region to the intersection of itself with the specified Region. |
| intersect_path(path) | Updates this Region to the intersection of itself with the specified GraphicsPath. |
| intersect_rect(rect) | Updates this Region to the intersection of itself with the specified RectangleF structure. |
| intersect_rect_f(rect) | Updates this Region to the intersection of itself with the specified RectangleF structure. |
| intersect_rgn(region) | Updates this Region to the intersection of itself with the specified Region. |
| is_empty(g) | Tests whether this Region has an empty interior on the specified drawing surface. |
| is_infinite(g) | Tests whether this Region has an infinite interior on the specified drawing surface. |
| is_visible(point) | Tests whether the specified PointF structure is contained within this Region. |
| is_visible(point) | Tests whether the specified PointF structure is contained within this Region. |
| is_visible(point, g) | Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible(point, g) | Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible(rect) | Tests whether any portion of the specified RectangleF structure is contained within this Region. |
| is_visible(rect) | Tests whether any portion of the specified RectangleF structure is contained within this Region. |
| is_visible(rect, g) | Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible(rect, g) | Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible(x, y) | Tests whether the specified point is contained within this Region. |
| is_visible(x, y, g) | Tests whether the specified point is contained within this Region when drawn using the specified Graphics. |
| is_visible(x, y, g) | Tests whether the specified point is contained within this Region when drawn using the specified Graphics. |
| is_visible(x, y, width, height) | Tests whether any portion of the specified rectangle is contained within this Region. |
| is_visible(x, y, width, height) | Tests whether any portion of the specified rectangle is contained within this Region. |
| is_visible(x, y, width, height, g) | Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics. |
| is_visible(x, y, width, height, g) | Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics. |
| is_visible_f(x, y) | Tests whether the specified point is contained within this Region. |
| is_visible_point(point) | Tests whether the specified PointF structure is contained within this Region. |
| is_visible_point_f(point) | Tests whether the specified PointF structure is contained within this Region. |
| is_visible_point_f_with_graphics(point, g) | Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible_point_with_graphics(point, g) | Tests whether the specified Point structure is contained within this Region when drawn using the specified Graphics. |
| is_visible_rect(rect) | Tests whether any portion of the specified RectangleF structure is contained within this Region. |
| is_visible_rect_f(rect) | Tests whether any portion of the specified RectangleF structure is contained within this Region. |
| is_visible_rect_f_with_graphics(rect, g) | Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics. |
| is_visible_rect_with_graphics(rect, g) | Tests whether any portion of the specified Rectangle structure is contained within this Region when drawn using the specified Graphics. |
| is_visible_with_graphics(x, y, g) | Tests whether the specified point is contained within this Region when drawn using the specified Graphics. |
| is_visible_with_graphics_f(x, y, g) | Tests whether the specified point is contained within this Region when drawn using the specified Graphics. |
| is_visible_xywh(x, y, width, height) | Tests whether any portion of the specified rectangle is contained within this Region. |
| is_visible_xywh_graphics(x, y, width, height, g) | Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics. |
| is_visible_xywh_graphics_f(x, y, width, height, g) | Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics. |
| is_visible_xywhf(x, y, width, height) | Tests whether any portion of the specified rectangle is contained within this Region. |
| make_empty() | Initializes this Region to an empty interior. |
| make_infinite() | Initializes this Region object to an infinite interior. |
| transform(matrix) | Transforms this Region by the specified Matrix. |
| translate(dx, dy) | Offsets the coordinates of this Region by the specified amount. |
| translate(dx, dy) | Offsets the coordinates of this Region by the specified amount. |
| translate_f(dx, dy) | Offsets the coordinates of this Region by the specified amount. |
| union(path) | Updates this Region to the union of itself and the specified GraphicsPath. |
| union(rect) | Updates this Region to the union of itself and the specified RectangleF structure. |
| union(rect) | Updates this Region to the union of itself and the specified RectangleF structure. |
| union(region) | Updates this Region to the union of itself and the specified Region. |
| union_path(path) | Updates this Region to the union of itself and the specified GraphicsPath. |
| union_rect(rect) | Updates this Region to the union of itself and the specified RectangleF structure. |
| union_rect_f(rect) | Updates this Region to the union of itself and the specified RectangleF structure. |
| union_rgn(region) | Updates this Region to the union of itself and the specified Region. |
| xor(path) | Updates this Region to the union minus the intersection of itself with the specified GraphicsPath. |
| xor(rect) | Updates this Region to the union minus the intersection of itself with the specified RectangleF structure. |
| xor(rect) | Updates this Region to the union minus the intersection of itself with the specified RectangleF structure. |
| xor(region) | Updates this Region to the union minus the intersection of itself with the specified Region. |
| xor_path(path) | Updates this Region to the union minus the intersection of itself with the specified GraphicsPath. |
| xor_rect(rect) | Updates this Region to the union minus the intersection of itself with the specified RectangleF structure. |
| xor_rect_f(rect) | Updates this Region to the union minus the intersection of itself with the specified RectangleF structure. |
| xor_rgn(region) | Updates this Region to the union minus the intersection of itself with the specified Region. |
Constructor: Region()
Region()
Initializes a new Region.
Constructor: Region(path)
Region(path)
Initializes a new Region with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | A GraphicsPath that defines the new Region. |
Constructor: Region(rect)
Region(rect)
Initializes a new Region from the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | A RectangleF structure that defines the interior of the new Region. |
Constructor: Region(rect)
Region(rect)
Initializes a new Region from the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | A RectangleF structure that defines the interior of the new Region. |
Method: complement(path)
complement(path)
Updates this Region to contain the portion of the specified GraphicsPath that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to complement this Region. |
Method: complement(rect)
complement(rect)
Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to complement this Region. |
Method: complement(rect)
complement(rect)
Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to complement this Region. |
Method: complement(region)
complement(region)
Updates this Region to contain the portion of the specified Region that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region object to complement this Region object. |
Method: complement_path(path)
complement_path(path)
Updates this Region to contain the portion of the specified GraphicsPath that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to complement this Region. |
Method: complement_rect(rect)
complement_rect(rect)
Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to complement this Region. |
Method: complement_rect_f(rect)
complement_rect_f(rect)
Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to complement this Region. |
Method: complement_rgn(region)
complement_rgn(region)
Updates this Region to contain the portion of the specified Region that does not intersect with this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region object to complement this Region object. |
Method: create_with_path(path) [static]
create_with_path(path)
Initializes a new Region with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | A GraphicsPath that defines the new Region. |
Returns
| Type | Description |
|---|---|
| Region |
Method: create_with_rect(rect) [static]
create_with_rect(rect)
Initializes a new Region from the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | A RectangleF structure that defines the interior of the new Region. |
Returns
| Type | Description |
|---|---|
| Region |
Method: create_with_rect_f(rect) [static]
create_with_rect_f(rect)
Initializes a new Region from the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | A RectangleF structure that defines the interior of the new Region. |
Returns
| Type | Description |
|---|---|
| Region |
Method: deep_clone()
deep_clone()
Creates an exact deep copy of this Region.
Returns
| Type | Description |
|---|---|
| Region | The Region that this method creates. |
Method: exclude(path)
exclude(path)
Updates this Region to contain only the portion of its interior that does not intersect with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to exclude from this Region. |
Method: exclude(rect)
exclude(rect)
Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to exclude from this Region. |
Method: exclude(rect)
exclude(rect)
Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to exclude from this Region. |
Method: exclude(region)
exclude(region)
Updates this Region to contain only the portion of its interior that does not intersect with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to exclude from this Region. |
Method: exclude_path(path)
exclude_path(path)
Updates this Region to contain only the portion of its interior that does not intersect with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to exclude from this Region. |
Method: exclude_rect(rect)
exclude_rect(rect)
Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to exclude from this Region. |
Method: exclude_rect_f(rect)
exclude_rect_f(rect)
Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to exclude from this Region. |
Method: exclude_rgn(region)
exclude_rgn(region)
Updates this Region to contain only the portion of its interior that does not intersect with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to exclude from this Region. |
Method: intersect(path)
intersect(path)
Updates this Region to the intersection of itself with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to intersect with this Region. |
Method: intersect(rect)
intersect(rect)
Updates this Region to the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to intersect with this Region. |
Method: intersect(rect)
intersect(rect)
Updates this Region to the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to intersect with this Region. |
Method: intersect(region)
intersect(region)
Updates this Region to the intersection of itself with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to intersect with this Region. |
Method: intersect_path(path)
intersect_path(path)
Updates this Region to the intersection of itself with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to intersect with this Region. |
Method: intersect_rect(rect)
intersect_rect(rect)
Updates this Region to the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to intersect with this Region. |
Method: intersect_rect_f(rect)
intersect_rect_f(rect)
Updates this Region to the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to intersect with this Region. |
Method: intersect_rgn(region)
intersect_rgn(region)
Updates this Region to the intersection of itself with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to intersect with this Region. |
Method: is_empty(g)
is_empty(g)
Tests whether this Region has an empty interior on the specified drawing surface.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| g | Graphics | A Graphics that represents a drawing surface. |
Returns
| Type | Description |
|---|---|
| bool | true if the interior of this Region is empty when the transformation associated with g is applied; otherwise, false. |
Method: is_infinite(g)
is_infinite(g)
Tests whether this Region has an infinite interior on the specified drawing surface.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| g | Graphics | A Graphics that represents a drawing surface. |
Returns
| Type | Description |
|---|---|
| bool | true if the interior of this Region is infinite when the transformation associated with g is applied; otherwise, false. |
Method: is_visible(point)
is_visible(point)
Tests whether the specified PointF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | PointF | The PointF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible(point)
is_visible(point)
Tests whether the specified PointF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | Point | The PointF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible(point, g)
is_visible(point, g)
Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | PointF | The PointF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible(point, g)
is_visible(point, g)
Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | Point | The PointF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible(rect)
is_visible(rect)
Tests whether any portion of the specified RectangleF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of rect is contained within this Region; otherwise, false. |
Method: is_visible(rect)
is_visible(rect)
Tests whether any portion of the specified RectangleF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of rect is contained within this Region; otherwise, false. |
Method: is_visible(rect, g)
is_visible(rect, g)
Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when rect is contained within this Region; otherwise, false. |
Method: is_visible(rect, g)
is_visible(rect, g)
Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when rect is contained within this Region; otherwise, false. |
Method: is_visible(x, y)
is_visible(x, y)
Tests whether the specified point is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the point to test. |
| y | float | The y-coordinate of the point to test. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible(x, y, g)
is_visible(x, y, g)
Tests whether the specified point is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the point to test. |
| y | float | The y-coordinate of the point to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible(x, y, g)
is_visible(x, y, g)
Tests whether the specified point is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the point to test. |
| y | int | The y-coordinate of the point to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible(x, y, width, height)
is_visible(x, y, width, height)
Tests whether any portion of the specified rectangle is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | float | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | float | The width of the rectangle to test. |
| height | float | The height of the rectangle to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region object; otherwise, false. |
Method: is_visible(x, y, width, height)
is_visible(x, y, width, height)
Tests whether any portion of the specified rectangle is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | int | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | int | The width of the rectangle to test. |
| height | int | The height of the rectangle to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region object; otherwise, false. |
Method: is_visible(x, y, width, height, g)
is_visible(x, y, width, height, g)
Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | float | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | float | The width of the rectangle to test. |
| height | float | The height of the rectangle to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region; otherwise, false. |
Method: is_visible(x, y, width, height, g)
is_visible(x, y, width, height, g)
Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | int | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | int | The width of the rectangle to test. |
| height | int | The height of the rectangle to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region; otherwise, false. |
Method: is_visible_f(x, y)
is_visible_f(x, y)
Tests whether the specified point is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the point to test. |
| y | float | The y-coordinate of the point to test. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible_point(point)
is_visible_point(point)
Tests whether the specified PointF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | Point | The PointF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible_point_f(point)
is_visible_point_f(point)
Tests whether the specified PointF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | PointF | The PointF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible_point_f_with_graphics(point, g)
is_visible_point_f_with_graphics(point, g)
Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | PointF | The PointF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible_point_with_graphics(point, g)
is_visible_point_with_graphics(point, g)
Tests whether the specified Point structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| point | Point | The Point structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when point is contained within this Region; otherwise, false. |
Method: is_visible_rect(rect)
is_visible_rect(rect)
Tests whether any portion of the specified RectangleF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of rect is contained within this Region; otherwise, false. |
Method: is_visible_rect_f(rect)
is_visible_rect_f(rect)
Tests whether any portion of the specified RectangleF structure is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of rect is contained within this Region; otherwise, false. |
Method: is_visible_rect_f_with_graphics(rect, g)
is_visible_rect_f_with_graphics(rect, g)
Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when rect is contained within this Region; otherwise, false. |
Method: is_visible_rect_with_graphics(rect, g)
is_visible_rect_with_graphics(rect, g)
Tests whether any portion of the specified Rectangle structure is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The Rectangle structure to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the rect is contained within this Region; otherwise, false. |
Method: is_visible_with_graphics(x, y, g)
is_visible_with_graphics(x, y, g)
Tests whether the specified point is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the point to test. |
| y | int | The y-coordinate of the point to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible_with_graphics_f(x, y, g)
is_visible_with_graphics_f(x, y, g)
Tests whether the specified point is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the point to test. |
| y | float | The y-coordinate of the point to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | True when the specified point is contained within this Region; otherwise, false. |
Method: is_visible_xywh(x, y, width, height)
is_visible_xywh(x, y, width, height)
Tests whether any portion of the specified rectangle is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | int | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | int | The width of the rectangle to test. |
| height | int | The height of the rectangle to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region object; otherwise, false. |
Method: is_visible_xywh_graphics(x, y, width, height, g)
is_visible_xywh_graphics(x, y, width, height, g)
Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | int | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | int | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | int | The width of the rectangle to test. |
| height | int | The height of the rectangle to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region; otherwise, false. |
Method: is_visible_xywh_graphics_f(x, y, width, height, g)
is_visible_xywh_graphics_f(x, y, width, height, g)
Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | float | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | float | The width of the rectangle to test. |
| height | float | The height of the rectangle to test. |
| g | Graphics | A Graphics that represents a graphics context. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region; otherwise, false. |
Method: is_visible_xywhf(x, y, width, height)
is_visible_xywhf(x, y, width, height)
Tests whether any portion of the specified rectangle is contained within this Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| x | float | The x-coordinate of the upper-left corner of the rectangle to test. |
| y | float | The y-coordinate of the upper-left corner of the rectangle to test. |
| width | float | The width of the rectangle to test. |
| height | float | The height of the rectangle to test. |
Returns
| Type | Description |
|---|---|
| bool | true when any portion of the specified rectangle is contained within this Region object; otherwise, false. |
Method: transform(matrix)
transform(matrix)
Transforms this Region by the specified Matrix.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The Matrix by which to transform this Region. |
Method: translate(dx, dy)
translate(dx, dy)
Offsets the coordinates of this Region by the specified amount.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dx | float | The amount to offset this Region horizontally. |
| dy | float | The amount to offset this Region vertically. |
Method: translate(dx, dy)
translate(dx, dy)
Offsets the coordinates of this Region by the specified amount.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dx | int | The amount to offset this Region horizontally. |
| dy | int | The amount to offset this Region vertically. |
Method: translate_f(dx, dy)
translate_f(dx, dy)
Offsets the coordinates of this Region by the specified amount.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dx | float | The amount to offset this Region horizontally. |
| dy | float | The amount to offset this Region vertically. |
Method: union(path)
union(path)
Updates this Region to the union of itself and the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to unite with this Region. |
Method: union(rect)
union(rect)
Updates this Region to the union of itself and the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to unite with this Region. |
Method: union(rect)
union(rect)
Updates this Region to the union of itself and the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to unite with this Region. |
Method: union(region)
union(region)
Updates this Region to the union of itself and the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to unite with this Region. |
Method: union_path(path)
union_path(path)
Updates this Region to the union of itself and the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to unite with this Region. |
Method: union_rect(rect)
union_rect(rect)
Updates this Region to the union of itself and the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to unite with this Region. |
Method: union_rect_f(rect)
union_rect_f(rect)
Updates this Region to the union of itself and the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to unite with this Region. |
Method: union_rgn(region)
union_rgn(region)
Updates this Region to the union of itself and the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to unite with this Region. |
Method: xor(path)
xor(path)
Updates this Region to the union minus the intersection of itself with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to xor with this Region. |
Method: xor(rect)
xor(rect)
Updates this Region to the union minus the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to xor with this Region. |
Method: xor(rect)
xor(rect)
Updates this Region to the union minus the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to xor with this Region. |
Method: xor(region)
xor(region)
Updates this Region to the union minus the intersection of itself with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to xor with this Region. |
Method: xor_path(path)
xor_path(path)
Updates this Region to the union minus the intersection of itself with the specified GraphicsPath.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath to xor with this Region. |
Method: xor_rect(rect)
xor_rect(rect)
Updates this Region to the union minus the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | Rectangle | The RectangleF structure to xor with this Region. |
Method: xor_rect_f(rect)
xor_rect_f(rect)
Updates this Region to the union minus the intersection of itself with the specified RectangleF structure.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rect | RectangleF | The RectangleF structure to xor with this Region. |
Method: xor_rgn(region)
xor_rgn(region)
Updates this Region to the union minus the intersection of itself with the specified Region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| region | Region | The Region to xor with this Region. |