ixfx
    Preparing search index...

    Namespace Circles

    A circle is defined as having a radius

    Functions

    area

    Returns the area of circle.

    bbox

    Computes a bounding box that encloses circle

    center

    Returns the center of a circle

    circumference

    Returns circumference of circle (alias of length)

    distanceCenter

    Returns the distance between two circle centers.

    distanceFromExterior

    Returns the distance between the exterior of two circles, or between the exterior of a circle and point. If b overlaps or is enclosed by a, distance is 0.

    exteriorIntegerPoints

    Yields the points making up the exterior (ie. circumference) of the circle. Uses Midpoint Circle Algorithm

    guard

    Throws if radius is out of range. If x,y is present, these will be validated too.

    guardPositioned

    Throws if circle is not positioned or has dodgy fields

    interiorIntegerPoints

    Returns all integer points contained within circle.

    interpolate

    Computes relative position along circle perimeter

    intersectionLine

    Returns the point(s) of intersection between a circle and line.

    intersections

    Returns the points of intersection betweeen a and b.

    isCircle
    isCirclePositioned
    isContainedBy

    Returns true if b is completely contained by a

    isEqual

    Returns true if the two objects have the same values

    isIntersecting

    Returns true if a or b overlap, are equal, or a contains b. A circle can be checked for intersections with another CirclePositioned, Point or RectPositioned.

    isNaN

    Returns true if radius, x or y are NaN

    isPositioned

    Returns true if parameter has x,y. Does not verify if parameter is a circle or not

    length

    Returns circumference of circle (alias of circumference)

    multiplyScalar

    Multiplies a circle's radius and position (if provided) by value.

    nearest

    Returns the nearest point on circle's perimeter closest to point.

    pointOnPerimeter

    Returns a point on a circle's perimeter at a specified angle in radians

    randomPoint

    Returns a random point within a circle.

    toPath

    Returns a CircularPath representation of a circle

    toPositioned

    Returns a positioned version of a circle. If circle is already positioned, it is returned. If no default position is supplied, 0,0 is used.

    Type Aliases

    Circle

    A circle

    CirclePositioned

    A Circle with position

    CircleRandomPointOpts
    CircleToSvg
    CircularPath

    Variables

    toSvg

    Creates a SVG path segment.