Class Square2d

Defines a square in two-dimensional coordinates.

See

https://en.wikipedia.org/wiki/Square

Hierarchy

Quadiralteral2d
- Square2d

Index

Constructors

Properties

_edges _location _vertices width

Accessors

area centroid edges height interiorAngles isConcave isConvex isEquiAngular isEquilateral location perimeter vertices

Methods

contains doesIntersect getIntersectionPoints isOnEdge rotate translate triangulate

Constructors

constructor

new Square2d(location, width): Square2d
Parameters
- location: Point2d
- width: number
Returns Square2d
Overrides Quadiralteral2d.constructor
- Defined in square2d.ts:12

Properties

`Protected` _edges

_edges: Line2d[]

`Private` _location

_location: Point2d

`Protected` _vertices

_vertices: Point2d[]

width

width: number

Accessors

area

get area(): number
Gets the area.

Returns number
Overrides Quadiralteral2d.area
- Defined in square2d.ts:43

centroid

get centroid(): Point2d
Gets the center of the quadrilateral.

Returns Point2d
Inherited from Quadiralteral2d.centroid
- Defined in quadrilateral2d.ts:31

edges

get edges(): Line2d[]
Gets the list or edges.

Returns Line2d[]
Inherited from Quadiralteral2d.edges
- Defined in polygon2d.ts:74

height

get height(): number
Returns number
- Defined in square2d.ts:31
set height(value): void
Parameters
- value: number
Returns void
- Defined in square2d.ts:36

interiorAngles

get interiorAngles(): number[]
Gets the interior angles.

Returns number[]
Inherited from Quadiralteral2d.interiorAngles
- Defined in polygon2d.ts:142

isConcave

get isConcave(): boolean
Gets a value indicating if the polygon is concave.

Returns boolean
See
https://en.wikipedia.org/wiki/Concave_polygon
Inherited from Quadiralteral2d.isConcave
- Defined in polygon2d.ts:185

isConvex

get isConvex(): boolean
Gets a value indicating if the polygon is convex.

Returns boolean
See
https://en.wikipedia.org/wiki/Convex_polygon
Inherited from Quadiralteral2d.isConvex
- Defined in polygon2d.ts:177

isEquiAngular

get isEquiAngular(): boolean
Indicates if the polygon have all corner angles equal.

Returns boolean
true if this is the case.
Inherited from Quadiralteral2d.isEquiAngular
- Defined in polygon2d.ts:159

isEquilateral

get isEquilateral(): boolean
Indicates if the polygon have all edges of the same length.

Returns boolean
true if this is the case.
Inherited from Quadiralteral2d.isEquilateral
- Defined in polygon2d.ts:167

location

get location(): Point2d
Returns Point2d
- Defined in square2d.ts:27

perimeter

get perimeter(): number
Gets the perimeter.

Returns number
Overrides Quadiralteral2d.perimeter
- Defined in square2d.ts:50

vertices

get vertices(): Point2d[]
Gets the list or vertices.

Returns Point2d[]
Inherited from Quadiralteral2d.vertices
- Defined in polygon2d.ts:67

Methods

contains

contains(point): boolean
Checks if the given point is located inside the polygon.
Parameters
- point: Point2d
  The reference point.
Returns boolean
true if the point is inside the polygon.
Inherited from Quadiralteral2d.contains
- Defined in polygon2d.ts:231

doesIntersect

doesIntersect(shape): boolean
Checks if the current polygon intersect with the given shape.
Parameters
- shape: IShape2d
  The reference shape.
Returns boolean
true it the two shapes intersect, otherwise false.
Inherited from Quadiralteral2d.doesIntersect
- Defined in polygon2d.ts:296

getIntersectionPoints

getIntersectionPoints(shape): Point2d[]
Get the intersection points with the given shape.
Parameters
- shape: IShape2d
  The reference shape.
Returns Point2d[]
An array of points if any intersection exist, otherwise an empty array.
Inherited from Quadiralteral2d.getIntersectionPoints
- Defined in polygon2d.ts:305

isOnEdge

isOnEdge(point, threshold?): boolean
Checks if the given point is on one edge of the polygon.
Parameters
- point: Point2d
  The reference point.
- threshold: number = 0
  A value used as a threshold / range to check if the point is on one edge.
Returns boolean
true if the point is on edge.
Inherited from Quadiralteral2d.isOnEdge
- Defined in polygon2d.ts:220

rotate

rotate(angle, origin?): void
Rotates the polygon by the given angle in degree, around a point.
Parameters
- angle: number
  The rotation angle.
- origin: Point2d = ...
  The origin from which the rotation is supposed to be done.
Returns void
Inherited from Quadiralteral2d.rotate
- Defined in polygon2d.ts:204

translate

translate(vector): void
Translates the polygon using the given vector for direction.
Parameters
- vector: Vector2d
  The vector defining the direction.
Returns void
Inherited from Quadiralteral2d.translate
- Defined in polygon2d.ts:193

triangulate

triangulate(): Point2d[][]
Triangulates the polygon using "Fan Triangulation".

Returns Point2d[][]
an array of points representing the triangles.

See
https://en.wikipedia.org/wiki/Fan_triangulation
Inherited from Quadiralteral2d.triangulate
- Defined in polygon2d.ts:256

Generated using TypeDoc