Class RectangularPolygon

A polygon tha allows the optimized drawing of rectangles.

Inheritance

Object

RectangularPolygon

Implements

ISimplePath

IPath

Namespace: SixLabors.ImageSharp.Drawing

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public sealed class RectangularPolygon : object, ISimplePath, IPath

Constructors

| Improve this Doc View Source

RectangularPolygon(PointF, PointF)

Initializes a new instance of the RectangularPolygon class.

Declaration

public RectangularPolygon(PointF topLeft, PointF bottomRight)

Parameters

Type	Name	Description
PointF	topLeft	The which specifies the rectangles top/left point in a two-dimensional plane.
PointF	bottomRight	The which specifies the rectangles bottom/right point in a two-dimensional plane.

| Improve this Doc View Source

RectangularPolygon(PointF, SizeF)

Initializes a new instance of the RectangularPolygon class.

Declaration

public RectangularPolygon(PointF point, SizeF size)

Parameters

Type	Name	Description
PointF	point	The which specifies the rectangles point in a two-dimensional plane.
SizeF	size	The which specifies the rectangles height and width.

| Improve this Doc View Source

RectangularPolygon(RectangleF)

Initializes a new instance of the RectangularPolygon class.

Declaration

public RectangularPolygon(RectangleF rectangle)

Parameters

Type	Name	Description
RectangleF	rectangle	The rectangle.

| Improve this Doc View Source

RectangularPolygon(Single, Single, Single, Single)

Initializes a new instance of the RectangularPolygon class.

Declaration

public RectangularPolygon(float x, float y, float width, float height)

Parameters

Type	Name	Description
Single	x	The horizontal position of the rectangle.
Single	y	The vertical position of the rectangle.
Single	width	The width of the rectangle.
Single	height	The height of the rectangle.

Properties

| Improve this Doc View Source

Bottom

Gets the y-coordinate of the bottom edge.

Declaration

public float Bottom { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Bounds

Gets the bounds enclosing the path.

Declaration

public RectangleF Bounds { get; }

Property Value

Type	Description
RectangleF

| Improve this Doc View Source

Center

Gets the center point.

Declaration

public PointF Center { get; }

Property Value

Type	Description
PointF

| Improve this Doc View Source

Height

Gets the height.

Declaration

public float Height { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

IsClosed

Gets a value indicating whether this instance is a closed path.

Declaration

public bool IsClosed { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Left

Gets the x-coordinate of the left edge.

Declaration

public float Left { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Location

Gets the location.

Declaration

public PointF Location { get; }

Property Value

Type	Description
PointF

| Improve this Doc View Source

PathType

Gets a value indicating whether this instance is closed, open or a composite path with a mixture of open and closed figures.

Declaration

public PathTypes PathType { get; }

Property Value

Type	Description
PathTypes

| Improve this Doc View Source

Points

Gets the points that make this up as a simple linear path.

Declaration

public ReadOnlyMemory<PointF> Points { get; }

Property Value

Type	Description
ReadOnlyMemory<PointF>

| Improve this Doc View Source

Right

Gets the x-coordinate of the right edge.

Declaration

public float Right { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Size

Gets the size.

Declaration

public SizeF Size { get; }

Property Value

Type	Description
SizeF

| Improve this Doc View Source

Top

Gets the y-coordinate of the top edge.

Declaration

public float Top { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Width

Gets the width.

Declaration

public float Width { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

X

Gets the x-coordinate.

Declaration

public float X { get; }

Property Value

Type	Description
Single

| Improve this Doc View Source

Y

Gets the y-coordinate.

Declaration

public float Y { get; }

Property Value

Type	Description
Single

Methods

| Improve this Doc View Source

AsClosedPath()

Returns this path with all figures closed.

Declaration

public IPath AsClosedPath()

Returns

Type	Description
IPath	A new close IPath.

| Improve this Doc View Source

Flatten()

Converts the IPath into a simple linear path.

Declaration

public IEnumerable<ISimplePath> Flatten()

Returns

Type	Description
IEnumerable<ISimplePath>	Returns the current IPath as simple linear path.

| Improve this Doc View Source

Transform(Matrix3x2)

Transforms the path using the specified matrix.

Declaration

public IPath Transform(Matrix3x2 matrix)

Parameters

Type	Name	Description
Matrix3x2	matrix	The matrix.

Returns

Type	Description
IPath	A new path with the matrix applied to it.

Operators

| Improve this Doc View Source

Explicit(Polygon to RectangularPolygon)

Converts the polygon to a rectangular polygon from its bounds.

Declaration

public static explicit operator RectangularPolygon(Polygon polygon)

Parameters

Type	Name	Description
Polygon	polygon	The polygon to convert.

Returns

Type	Description
RectangularPolygon

Implements

ISimplePath

IPath