Interface ReadonlyCircle

Read-only circle shape.

Remarks

x and y refer to the circle's center.

interface ReadonlyCircle {
    radius: number;
    x: number;
    y: number;
    clone(): Circle;
    containsPoint(point: Vec2Like): boolean;
    equals(other: CircleLike, epsilon?: number): boolean;
    intersectsCircle(other: CircleLike): boolean;
    intersectsRect(rect: RectLike): boolean;
}

Hierarchy (View Summary)

CircleLike
Shape
- ReadonlyCircle

Implemented by

Circle

Index

Properties

Methods

clone containsPoint equals intersectsCircle intersectsRect

Properties

`Readonly`radius

radius: number

`Readonly`x

x: number

`Readonly`y

y: number

Methods

clone

clone(): Circle
Returns Circle
- Defined in math/shapes/circle.ts:40

containsPoint

containsPoint(point: Vec2Like): boolean
Check if this shape contains point.
Parameters
- point: Vec2Like
  Point to check
Returns boolean
true if this shape contains the point
Overrides Shape.containsPoint
- Defined in math/shapes/circle.ts:36

equals

equals(other: CircleLike, epsilon?: number): boolean
Parameters
- other: CircleLike
- Optionalepsilon: number
Returns boolean
- Defined in math/shapes/circle.ts:38

intersectsCircle

intersectsCircle(other: CircleLike): boolean
Parameters
- other: CircleLike
Returns boolean
- Defined in math/shapes/circle.ts:32

intersectsRect

intersectsRect(rect: RectLike): boolean
Check if this shape and rect intersect.
Parameters
- rect: RectLike
  Rect
Returns boolean
true if shape and rect intersect
Overrides Shape.intersectsRect
- Defined in math/shapes/circle.ts:34