Class Circle

constructor

• new Circle(center, radius): Circle

• Create a new circle with given center point and radius.

  Parameters

  • center: Vertex

    The center point of the circle.
  • radius: number

    The radius of the circle.

  Returns Circle

  Name

  Circle

center

Readonly className

isDestroyed

radius

Readonly uid

Static circleUtils

circleIntersection

• circleIntersection(circle): Line

• Calculate the intersection points (if exists) with the given circle.

  Parameters

  • circle: Circle

  Returns Line

  The intersection points (as a line) or null if the two circles do not intersect.

  Method

  circleIntersection

  Instance

  Memberof

  Circle

closestPoint

• closestPoint(vert): Vertex

• Calculate the closest point on the outline of this circle to the given point.

  Parameters

  • vert: XYCoords

    The point to find the closest circle point for.

  Returns Vertex

  The closest point on this circle.

  Method

  closestPoint

  Instance

  Memberof

  Circle

containsCircle

• containsCircle(circle): boolean

• Check if the given circle is fully contained inside this circle.

  Parameters

  • circle: Circle

    The circle to check if it is contained in this circle.

  Returns boolean

  true if any only if the given circle is completely inside this circle.

  Method

  containsCircle

  Instance

  Memberof

  Circle

containsPoint

• containsPoint(point): boolean

• Check if the given circle is fully contained inside this circle.

  Parameters

  • point: XYCoords

    The point to check if it is contained in this circle.

  Returns boolean

  true if the given point is inside this circle.

  Method

  containsPoint

  Instance

  Memberof

  Circle

destroy

• destroy(): void

• This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used.

  Returns void

lineDistance

• lineDistance(line): number

• Calculate the distance from this circle to the given line.

  • If the line does not intersect this ciecle then the returned value will be the minimal distance.
  • If the line goes through this circle then the returned value will be max inner distance and it will be negative.

  Parameters

  • line: VertTuple<any>

    The line to measure the distance to.

  Returns number

  The minimal distance from the outline of this circle to the given line.

  Method

  lineDistance

  Instance

  Memberof

  Circle

lineIntersection

• lineIntersection(a, b): Line

• Calculate the intersection points (if exists) with the given infinite line (defined by two points).

  Parameters

  • a: Vertex
  • b: XYCoords

    The second of the two points defining the line.

  Returns Line

  The intersection points (as a line) or null if this circle does not intersect the line given.

  Method

  lineIntersection

  Instance

  Memberof

  Circle

tangentAt

• tangentAt(angle): Vector

• Get a tangent line of this circle for a given angle.

  Point a of the returned line is located on the circle, the length equals the radius.

  Parameters

  • angle: number

    The angle (in radians) to use.

  Returns Vector

  The tangent line.

  Method

  tangentAt

  Instance

  Memberof

  Circle

vertAt

• vertAt(angle): Vertex

• Get the vertex on the this circle for the given angle.

  Parameters

  • angle: number

    The angle (in radians) to use.

  Returns Vertex

  The vertex (point) at the given angle.

  Method

  vertAt

  Instance

  Memberof

  Circle