Class CircleCollider

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

Hierarchy

Collider
- CircleCollider

Index

Constructors

Properties

events id offset owner

Accessors

axes bounds center localBounds radius worldPos

Methods

clone collide contains debug getClosestLineBetween getFurthestLocalPoint getFurthestPoint getInertia project rayCast touching update

Constructors

constructor

new CircleCollider(options: CircleColliderOptions): CircleCollider
Parameters
- options: CircleColliderOptions
Returns CircleCollider
Overrides Collider.constructor
- Defined in Collision/Colliders/CircleCollider.ts:68

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[]
Get axis not implemented on circles, since there are infinite axis in a circle

Returns Vector[]
Overrides Collider.axes
- Defined in Collision/Colliders/CircleCollider.ts:223

bounds

get bounds(): BoundingBox
Get the axis aligned bounding box for the circle collider in world coordinates

Returns BoundingBox
Overrides Collider.bounds
- Defined in Collision/Colliders/CircleCollider.ts:195

center

get center(): Vector
Get the center of the collider in world coordinates

Returns Vector
Overrides Collider.center
- Defined in Collision/Colliders/CircleCollider.ts:88

localBounds

get localBounds(): BoundingBox
Get the axis aligned bounding box for the circle collider in local coordinates

Returns BoundingBox
Overrides Collider.localBounds
- Defined in Collision/Colliders/CircleCollider.ts:211

radius

get radius(): number
Get the radius of the circle

Returns number
- Defined in Collision/Colliders/CircleCollider.ts:49
set radius(val: number): void
Set the radius of the circle
Parameters
- val: number
Returns void
- Defined in Collision/Colliders/CircleCollider.ts:59

worldPos

get worldPos(): Vector
Position of the collision collider in world coordinates

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

Methods

clone

clone(): CircleCollider
Returns a clone of this shape, not associated with any collider

Returns CircleCollider
Overrides Collider.clone
- Defined in Collision/Colliders/CircleCollider.ts:78

collide

collide(collider: Collider): CollisionContact[]
Inherit Doc
Parameters
- collider: Collider
Returns CollisionContact[]
Overrides Collider.collide
- Defined in Collision/Colliders/CircleCollider.ts:164

contains

contains(point: Vector): boolean
Tests if a point is contained in this collider
Parameters
- point: Vector
Returns boolean
Overrides Collider.contains
- Defined in Collision/Colliders/CircleCollider.ts:95

debug

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

getClosestLineBetween

getClosestLineBetween(shape: Collider): LineSegment
Returns the closest line between the surfaces this collider and another
Parameters
- shape: Collider
Returns LineSegment
Overrides Collider.getClosestLineBetween
- Defined in Collision/Colliders/CircleCollider.ts:149

getFurthestLocalPoint

getFurthestLocalPoint(direction: Vector): Vector
Find the local point on the shape in the direction specified
Parameters
- direction: Vector
Returns Vector
- Defined in Collision/Colliders/CircleCollider.ts:187

getFurthestPoint

getFurthestPoint(direction: Vector): Vector
Find the point on the collider furthest in the direction specified
Parameters
- direction: Vector
Returns Vector
Overrides Collider.getFurthestPoint
- Defined in Collision/Colliders/CircleCollider.ts:179

getInertia

getInertia(mass: number): number
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
Overrides Collider.getInertia
- Defined in Collision/Colliders/CircleCollider.ts:231

project

project(axis: Vector): Projection
Project the circle along a specified axis
Parameters
- axis: Vector
Returns Projection
Overrides Collider.project
- Defined in Collision/Colliders/CircleCollider.ts:246

rayCast

rayCast(ray: Ray, max?: number): Vector
Casts a ray at the Circle collider and returns the nearest point of collision
Parameters
- ray: Ray
- max: number = Infinity
Returns Vector
Overrides Collider.rayCast
- Defined in Collision/Colliders/CircleCollider.ts:108

touching

touching(other: Collider): boolean
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
Inherited from Collider.touching
- Defined in Collision/Colliders/Collider.ts:35

update

update(transform: Transform): void
Updates collider world space geometry
Parameters
- transform: Transform
Returns void
Overrides Collider.update
- Defined in Collision/Colliders/CircleCollider.ts:236