Class CircleCollider

This is a circle collider for the excalibur rigid body physics simulation

Hierarchy

Collider
- CircleCollider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CircleCollider(options: CircleColliderOptions): CircleCollider

Overrides Collider.constructor
- Defined in Collision/Colliders/CircleCollider.ts:70
Parameters
- options: CircleColliderOptions
Returns CircleCollider

Properties

events

events: EventDispatcher<Collider> = ...

Readonly id

id: Id<"collider"> = ...

offset

offset: Vector = Vector.Zero

Position of the circle relative to the collider, by default (0, 0).

owner

owner: Entity

Accessors

axes

get axes(): Vector[]

Overrides Collider.axes
- Defined in Collision/Colliders/CircleCollider.ts:229
Get axis not implemented on circles, since there are infinite axis in a circle

Returns Vector[]

bounds

get bounds(): BoundingBox

Overrides Collider.bounds
- Defined in Collision/Colliders/CircleCollider.ts:201
Get the axis aligned bounding box for the circle collider in world coordinates

Returns BoundingBox

center

get center(): Vector

Overrides Collider.center
- Defined in Collision/Colliders/CircleCollider.ts:89
Get the center of the collider in world coordinates

Returns Vector

localBounds

get localBounds(): BoundingBox

Overrides Collider.localBounds
- Defined in Collision/Colliders/CircleCollider.ts:217
Get the axis aligned bounding box for the circle collider in local coordinates

Returns BoundingBox

radius

get radius(): number
set radius(val: number): void

- Defined in Collision/Colliders/CircleCollider.ts:51
Get the radius of the circle

Returns number
- Defined in Collision/Colliders/CircleCollider.ts:61
Set the radius of the circle

Parameters
- val: number
Returns void

worldPos

get worldPos(): Vector

Overrides Collider.worldPos
- Defined in Collision/Colliders/CircleCollider.ts:38
Returns Vector

Methods

clone

clone(): CircleCollider

Overrides Collider.clone
- Defined in Collision/Colliders/CircleCollider.ts:79
Returns a clone of this shape, not associated with any collider

Returns CircleCollider

collide

collide(collider: Collider): CollisionContact[]

Overrides Collider.collide
- Defined in Collision/Colliders/CircleCollider.ts:170
inheritdoc
Parameters
- collider: Collider
Returns CollisionContact[]

contains

contains(point: Vector): boolean

Overrides Collider.contains
- Defined in Collision/Colliders/CircleCollider.ts:101
Tests if a point is contained in this collider

Parameters
- point: Vector
Returns boolean

debug

debug(ex: ExcaliburGraphicsContext, color: Color): void

Overrides Collider.debug
- Defined in Collision/Colliders/CircleCollider.ts:259
Parameters
- ex: ExcaliburGraphicsContext
- color: Color
Returns void

getClosestLineBetween

getClosestLineBetween(shape: Collider): LineSegment

Overrides Collider.getClosestLineBetween
- Defined in Collision/Colliders/CircleCollider.ts:155
Returns the closest line between the surfaces this collider and another

Parameters
- shape: Collider
Returns LineSegment

getFurthestLocalPoint

getFurthestLocalPoint(direction: Vector): Vector

- Defined in Collision/Colliders/CircleCollider.ts:193
Find the local point on the shape in the direction specified

Parameters
- direction: Vector
Returns Vector

getFurthestPoint

getFurthestPoint(direction: Vector): Vector

Overrides Collider.getFurthestPoint
- Defined in Collision/Colliders/CircleCollider.ts:185
Find the point on the collider furthest in the direction specified

Parameters
- direction: Vector
Returns Vector

getInertia

getInertia(mass: number): number

Overrides Collider.getInertia
- Defined in Collision/Colliders/CircleCollider.ts:237
Returns the moment of inertia of a circle given it's mass https://en.wikipedia.org/wiki/List_of_moments_of_inertia

Parameters
- mass: number
Returns number

project

project(axis: Vector): Projection

Overrides Collider.project
- Defined in Collision/Colliders/CircleCollider.ts:249
Project the circle along a specified axis

Parameters
- axis: Vector
Returns Projection

rayCast

rayCast(ray: Ray, max?: number): Vector

Overrides Collider.rayCast
- Defined in Collision/Colliders/CircleCollider.ts:114
Casts a ray at the Circle collider and returns the nearest point of collision

Parameters
- ray: Ray
- max: number = Infinity
Returns Vector

touching

touching(other: Collider): boolean

Inherited from Collider.touching
- Defined in Collision/Colliders/Collider.ts:34
Returns a boolean indicating whether this body collided with or was in stationary contact with the body of the other Collider

Parameters
- other: Collider
Returns boolean

update

update(transform: Transform): void

Overrides Collider.update
- Defined in Collision/Colliders/CircleCollider.ts:242
Updates collider world space geometry

Parameters
- transform: Transform
Returns void