Class PolygonArea
An area with an arbitrary number of sides and corners
Implements
Namespace: GoRogue.MapGeneration
Assembly: GoRogue.dll
Syntax
public class PolygonArea : Object, IReadOnlyArea, IMatchable<IReadOnlyArea>, IEnumerable<Point>, IEnumerable, IMatchable<PolygonArea>Constructors
PolygonArea(Lines.Algorithm, Point[])
Returns a new PolygonArea with corners at the provided points.
Declaration
public PolygonArea(Lines.Algorithm algorithm, params Point[] corners)Parameters
| Type | Name | Description |
|---|---|---|
| Lines.Algorithm | algorithm | Which Line-drawing algorithm to use |
| Point[] | corners | The points which are corners for this polygon |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
PolygonArea(Point[])
Returns a new polygon with corners at the provided points, using the algorithm DDA to produce lines
Declaration
public PolygonArea(params Point[] corners)Parameters
| Type | Name | Description |
|---|---|---|
| Point[] | corners | The corners of the polygon |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
PolygonArea(IEnumerable<Point>, Lines.Algorithm)
Creates a new Polygon, with corners at the provided points
Declaration
public PolygonArea(IEnumerable<Point> corners, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<Point> | corners | Each corner of the polygon, which is copied into a new list |
| Lines.Algorithm | algorithm | Which Line Algorithm to use |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
PolygonArea(ref List<Point>, Lines.Algorithm)
Creates a new Polygon, with corners at the provided points
Declaration
public PolygonArea(ref List<Point> corners, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| List<Point> | corners | The corners of this polygon |
| Lines.Algorithm | algorithm | Which Line Algorithm to use |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
Fields
LineAlgorithm
Which Line-Drawing algorithm to use
Declaration
public readonly Lines.Algorithm LineAlgorithmField Value
| Type | Description |
|---|---|
| Lines.Algorithm |
Properties
Bottom
The bottom-most Y-value of the Polygon
Declaration
public int Bottom { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Bounds
Declaration
public Rectangle Bounds { get; }Property Value
| Type | Description |
|---|---|
| Rectangle |
Center
The Center point of this Polygon
Declaration
public Point Center { get; }Property Value
| Type | Description |
|---|---|
| Point |
Remarks
There is no guarantee that the center point lies within the polygon
Corners
The corners of this polygon
Declaration
public IReadOnlyList<Point> Corners { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<Point> |
Count
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Height
how tall this Polygon is
Declaration
public int Height { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
InnerPoints
The interior points of the polygon
Declaration
public IReadOnlyArea InnerPoints { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyArea |
Item[Int32]
Declaration
public Point this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index |
Property Value
| Type | Description |
|---|---|
| Point |
Left
The left-most X-value of the Polygon
Declaration
public int Left { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
OuterPoints
The exterior points of the polygon
Declaration
public IReadOnlyMultiArea OuterPoints { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyMultiArea |
Right
The right-most X-value of the Polygon
Declaration
public int Right { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Top
The top-most Y-value of the Polygon
Declaration
public int Top { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
UseIndexEnumeration
Declaration
public bool UseIndexEnumeration { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Width
How Wide this Polygon is
Declaration
public int Width { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
Contains(IReadOnlyArea)
Declaration
public bool Contains(IReadOnlyArea area)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyArea | area |
Returns
| Type | Description |
|---|---|
| Boolean |
Contains(Point)
Declaration
public bool Contains(Point position)Parameters
| Type | Name | Description |
|---|---|---|
| Point | position |
Returns
| Type | Description |
|---|---|
| Boolean |
Contains(Int32, Int32)
Declaration
public bool Contains(int positionX, int positionY)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | positionX | |
| Int32 | positionY |
Returns
| Type | Description |
|---|---|
| Boolean |
FlipHorizontal(Int32)
Flip horizontally around an X-axis
Declaration
public PolygonArea FlipHorizontal(int x)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | x | The value around which to flip. |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new, flipped PolygonArea |
FlipVertical(Int32)
Flip vertically around a Y-axis
Declaration
public PolygonArea FlipVertical(int y)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | y | The value around which to flip. |
Returns
| Type | Description |
|---|---|
| PolygonArea |
GetEnumerator()
Declaration
public IEnumerator<Point> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<Point> |
Intersects(IReadOnlyArea)
Declaration
public bool Intersects(IReadOnlyArea area)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyArea | area |
Returns
| Type | Description |
|---|---|
| Boolean |
IsCorner(Point)
Returns true if the position provided is a corner of this polygon
Declaration
public bool IsCorner(Point position)Parameters
| Type | Name | Description |
|---|---|---|
| Point | position |
Returns
| Type | Description |
|---|---|
| Boolean |
Matches(PolygonArea)
Compares the polygons to ensure that they are defined by the same corners, and thus represent the same area.
Declaration
public bool Matches(PolygonArea other)Parameters
| Type | Name | Description |
|---|---|---|
| PolygonArea | other |
Returns
| Type | Description |
|---|---|
| Boolean | True if the polygons represent the same area; false otherwise. |
Matches(IReadOnlyArea)
Declaration
public bool Matches(IReadOnlyArea other)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyArea | other |
Returns
| Type | Description |
|---|---|
| Boolean |
Parallelogram(Point, Int32, Int32, Boolean, Lines.Algorithm)
Creates a new Polygon in the shape of a parallelogram.
Declaration
public static PolygonArea Parallelogram(Point origin, int width, int height, bool fromTop = false, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| Point | origin | Origin of the parallelogram. |
| Int32 | width | Width of the parallelogram. |
| Int32 | height | Height of the parallelogram. |
| Boolean | fromTop | Whether the parallelogram extends downward-right or upwards-right from the start |
| Lines.Algorithm | algorithm | Line-drawing algorithm to use for finding boundaries. |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new Polygon in the shape of a parallelogram |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
Rectangle(Rectangle, Lines.Algorithm)
Creates a new Polygon from a GoRogue.Rectangle.
Declaration
public static PolygonArea Rectangle(Rectangle rectangle, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| Rectangle | rectangle | The rectangle |
| Lines.Algorithm | algorithm | Line-drawing algorithm to use for finding boundaries. |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new Polygon in the shape of a rectangle |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
RegularPolygon(Point, Int32, Double, Lines.Algorithm)
Creates a polygon whose sides are even-length
Declaration
public static PolygonArea RegularPolygon(Point center, int numberOfSides, double radius, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| Point | center | The center point of this polygon |
| Int32 | numberOfSides | Number of sides and corners on this polygon |
| Double | radius | The desired distance between the center and each corner |
| Lines.Algorithm | algorithm | Which line-drawing algorithm to use |
Returns
| Type | Description |
|---|---|
| PolygonArea |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Must have 3 or more corners; Algorithm must produce ordered lines. |
RegularStar(Point, Int32, Double, Double, Lines.Algorithm)
Creates a new star-shaped polygon
Declaration
public static PolygonArea RegularStar(Point center, int points, double outerRadius, double innerRadius, Lines.Algorithm algorithm)Parameters
| Type | Name | Description |
|---|---|---|
| Point | center | The center point of the star |
| Int32 | points | How many points this star has |
| Double | outerRadius | The distance between the center and a tip of the star |
| Double | innerRadius | The distance between the center and an armpit of the star |
| Lines.Algorithm | algorithm | Which line-drawing algorithm to use |
Returns
| Type | Description |
|---|---|
| PolygonArea |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Stars must have 3 or more points; algorithm must be ordered; inner and outer radius must be positive |
Rotate(Double)
Rotates the Polygon around it's center.
Declaration
public PolygonArea Rotate(double degrees)Parameters
| Type | Name | Description |
|---|---|---|
| Double | degrees | The amount of degrees to rotate |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new, rotated PolygonArea |
Rotate(Double, Point)
Rotates the Polygon around a point of origin
Declaration
public PolygonArea Rotate(double degrees, Point origin)Parameters
| Type | Name | Description |
|---|---|---|
| Double | degrees | The amount of degrees to rotate |
| Point | origin | The Point around which to rotate |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new, rotated PolygonArea |
ToString()
Returns a string detailing the region's corner locations.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |
Translate(Point)
Moves the Polygon in the indicated direction.
Declaration
public PolygonArea Translate(Point delta)Parameters
| Type | Name | Description |
|---|---|---|
| Point | delta | The amount (X and Y) to translate by. |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new, translated PolygonArea |
Translate(Int32, Int32)
Moves the Polygon in the indicated direction.
Declaration
public PolygonArea Translate(int dx, int dy)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | dx | The X-value by which to shift |
| Int32 | dy | The Y-value by which to shift |
Returns
| Type | Description |
|---|---|
| PolygonArea |
Transpose(Point)
Invert the X and Y values of a Polygon, respective to a diagonal line
Declaration
public PolygonArea Transpose(Point xy)Parameters
| Type | Name | Description |
|---|---|---|
| Point | xy | Any point which intersects the line around which to transpose |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new PolygonArea |
Transpose(Int32, Int32)
Invert the X and Y values of a Polygon, respective to a diagonal line
Declaration
public PolygonArea Transpose(int x, int y)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | x | Any X-value of a point which intersects the line around which to transpose |
| Int32 | y | Any Y-value of a Point which intersects the line around which to transpose |
Returns
| Type | Description |
|---|---|
| PolygonArea | A new PolygonArea |