
# class ImmutableArc
Arc element defined by a start point, end point, center point, and orientation. Note that an arc cannot be fully defined without the orientation specified. Arcs with equal start and end points are considered a full circle, except for the case where radius equals 0 in which case the arc is undefined.
ImmutableArc inherits from Shape
# MEMBERS
# member read-only type
Type: Shape.Type
# member read-only circle
Type: Boolean
Description: True if this arc represent a circle, false otherwise
# member read-only reversed
Type: ImmutableArc
Description: Returns a new arc in the reversed direction
# member read-only cc
Type: ImmutableArc
Description: Returns a new arc with direction counter clockwise
# member read-only center
Type: ImmutablePoint
# member read-only p1
Type: ImmutablePoint
# member read-only p2
Type: ImmutablePoint
# member read-only direction
Type: Direction
# member read-only clockwise
Type: Boolean
# member read-only radius
Type: Number
# member read-only radiusSquared
Type: Number
# member read-only span
Type: Number
# member read-only spanDeg
Type: Number
# member read-only startAngle
Type: Number
# member read-only startAngleDeg
Type: Number
# member read-only endAngle
Type: Number
# member read-only endAngleDeg
Type: Number
# CONSTRUCTORS
# constructor ImmutableArc()
Description: Create an arc of length 0 at 0,0.
# constructor ImmutableArc(center, start, end, direction)
Description: Create an arc from three points, start, end, and center. Direction is always required otherwise it is unknown which of the two possible arcs to create for the given points.
Parameters:
- center: (ImmutablePoint) - Arc center
- start: (ImmutablePoint) - Starting point
- end: (ImmutablePoint) - Ending point
- direction: (Direction) - Direction of the arc.
# constructor ImmutableArc(center, radius, startAngle, endAngle, direction)
Description:
Parameters:
- center: (ImmutablePoint) -
- radius: (Number) -
- startAngle: (Number) -
- endAngle: (Number) -
- direction: (Direction) -
# FUNCTIONS
# function getTranslated(point)
Description:
Parameters:
- point: (Point) - The point to translate by
Return:
(ImmutableArc) - Returns a new arc with translated by 'point'
# function getTranslated(x, y)
Description:
Parameters:
- x: (Number) -
- y: (Number) -
Return:
(ImmutableArc) -
# function isEndPoint(point)
Description:
Parameters:
- point: (ImmutablePoint) -
Return:
(Boolean) -
# function pointAngle(point)
Description:
Parameters:
- point: (Point) -
Return:
(Number) -
# function isOnArc(point)
Description:
Parameters:
- point: (Point) -
Return:
(Boolean) -