Class Sector2d

Defines a sector in two-dimensional coordinates.

See

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

Hierarchy

Arc2d
- Sector2d

Implements

IClosedShape2d

Index

Constructors

Accessors

angle area center from fromToCenter isCircular length perimeter to toToCenter

Methods

contains doesIntersect getIntersectionPoints isOnEdge rotate translate

Constructors

constructor

new Sector2d(from, to, center): Sector2d
Parameters
- from: Point2d
- to: Point2d
- center: Point2d
Returns Sector2d
Overrides Arc2d.constructor
- Defined in sector2d.ts:13

Accessors

angle

get angle(): number
Gets the arc angle.

Returns number
Inherited from Arc2d.angle
- Defined in arc2d.ts:59

area

get area(): number
Gets the are of the sector.

Returns number
Implementation of IClosedShape2d.area
- Defined in sector2d.ts:20

center

get center(): Point2d
Gets the center of the arc.

Returns Point2d
Inherited from Arc2d.center
- Defined in arc2d.ts:41

from

get from(): Point2d
Gets the starting point of the arc.

Returns Point2d
Inherited from Arc2d.from
- Defined in arc2d.ts:27

`Protected` fromToCenter

get fromToCenter(): number
Returns number
Inherited from Arc2d.fromToCenter
- Defined in arc2d.ts:93

isCircular

get isCircular(): boolean
Gets a value indicating if the arc is circular, or not.

Returns boolean
true if this is the case, otherwise false.
Inherited from Arc2d.isCircular
- Defined in arc2d.ts:49

length

get length(): number
Gets the length of the arc.

Returns number
See
https://en.wikipedia.org/wiki/Arc_length
Inherited from Arc2d.length
- Defined in arc2d.ts:77

perimeter

get perimeter(): number
Gets the perimeter of the sector.

Returns number
Implementation of IClosedShape2d.perimeter
- Defined in sector2d.ts:37

to

get to(): Point2d
Gets the ending point of the arc.

Returns Point2d
Inherited from Arc2d.to
- Defined in arc2d.ts:34

`Protected` toToCenter

get toToCenter(): number
Returns number
Inherited from Arc2d.toToCenter
- Defined in arc2d.ts:102

Methods

contains

contains(point): boolean
Checks if the given point is located inside the sector.
Parameters
- point: Point2d
  The reference point.
Returns boolean
true if the point is inside the sector.
Implementation of IClosedShape2d.contains
- Defined in sector2d.ts:46

doesIntersect

doesIntersect(shape): boolean
Checks if the given shape intersects with the arc.
Parameters
- shape: IShape2d
  The reference shape.
Returns boolean
true it the two shapes intersect, otherwise false.
Implementation of IClosedShape2d.doesIntersect
Inherited from Arc2d.doesIntersect
- Defined in arc2d.ts:166

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.
Implementation of IClosedShape2d.getIntersectionPoints
Overrides Arc2d.getIntersectionPoints
- Defined in sector2d.ts:74

isOnEdge

isOnEdge(point, threshold?): boolean
Checks if the given point is on one edge of the arc.
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.
Implementation of IClosedShape2d.isOnEdge
Inherited from Arc2d.isOnEdge
- Defined in arc2d.ts:138

rotate

rotate(angle, origin?): void
Rotates the arc 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
Implementation of IClosedShape2d.rotate
Inherited from Arc2d.rotate
- Defined in arc2d.ts:126

translate

translate(vector): void
Translates the arc using the given vector for direction.
Parameters
- vector: Vector2d
  The vector defining the direction.
Returns void
Implementation of IClosedShape2d.translate
Inherited from Arc2d.translate
- Defined in arc2d.ts:115

Generated using TypeDoc