CircleCollider

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

Hierarchy

• Collider
  • CircleCollider

Index

Constructors

• constructor

Properties

• composite
• 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

• Overrides Collider.constructor

  Parameters

  • options: CircleColliderOptions

  Returns CircleCollider

Properties

publiccomposite

composite: CompositeCollider = null

Inherited from Collider.composite

Composite collider if any this collider is attached to

WARNING do not tamper with this property

publicevents

events: EventEmitter<any> = ...

Inherited from Collider.events

publicreadonlyid

id: Id<collider> = ...

Inherited from Collider.id

publicoffset

offset: Vector = Vector.Zero

Overrides Collider.offset

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

publicowner

owner: Entity<any>

Inherited from Collider.owner

Accessors

publicaxes

• get axes(): Vector[]

• Overrides Collider.axes

  Get axis not implemented on circles, since there are infinite axis in a circle

  ---

  Returns Vector[]

publicbounds

• get bounds(): BoundingBox

• Overrides Collider.bounds

  Get the axis aligned bounding box for the circle collider in world coordinates

  ---

  Returns BoundingBox

publiccenter

• get center(): Vector

• Overrides Collider.center

  Get the center of the collider in world coordinates

  ---

  Returns Vector

publiclocalBounds

• get localBounds(): BoundingBox

• Overrides Collider.localBounds

  Get the axis aligned bounding box for the circle collider in local coordinates

  ---

  Returns BoundingBox

publicradius

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

• Get the radius of the circle

  ---

  Returns number

• Set the radius of the circle

  ---

  Parameters

  • val: number

  Returns void

publicworldPos

• get worldPos(): Vector

• Overrides Collider.worldPos

  Position of the collision collider in world coordinates

  ---

  Returns Vector

Methods

publicclone

• clone(): CircleCollider

• Overrides Collider.clone

  Returns a clone of this shape, not associated with any collider

  ---

  Returns CircleCollider

publiccollide

• collide(collider: Collider): CollisionContact[]

• Overrides Collider.collide

  @inheritDoc

  ---

  Parameters

  • collider: Collider

  Returns CollisionContact[]

publiccontains

• contains(point: Vector): boolean

• Overrides Collider.contains

  Tests if a point is contained in this collider

  ---

  Parameters

  • point: Vector

  Returns boolean

publicdebug

• debug(ex: ExcaliburGraphicsContext, color: Color, options?: { lineWidth: number }): void

• Overrides Collider.debug

  Parameters

  • ex: ExcaliburGraphicsContext

  • color: Color

  • optionaloptions: { lineWidth: number }

  • lineWidth: number

  Returns void

publicgetClosestLineBetween

• getClosestLineBetween(shape: Collider): LineSegment

• Overrides Collider.getClosestLineBetween

  Returns the closest line between the surfaces this collider and another

  ---

  Parameters

  • shape: Collider

  Returns LineSegment

publicgetFurthestLocalPoint

• getFurthestLocalPoint(direction: Vector): Vector

• Find the local point on the shape in the direction specified

  ---

  Parameters

  • direction: Vector

  Returns Vector

publicgetFurthestPoint

• getFurthestPoint(direction: Vector): Vector

• Overrides Collider.getFurthestPoint

  Find the point on the collider furthest in the direction specified

  ---

  Parameters

  • direction: Vector

  Returns Vector

publicgetInertia

• getInertia(mass: number): number

• Overrides Collider.getInertia

  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

publicproject

• project(axis: Vector): Projection

• Overrides Collider.project

  Project the circle along a specified axis

  ---

  Parameters

  • axis: Vector

  Returns Projection

publicrayCast

• rayCast(ray: Ray, max?: number): RayCastHit

• Overrides Collider.rayCast

  Casts a ray at the Circle collider and returns the nearest point of collision

  ---

  Parameters

  • ray: Ray

  • max: number = Infinity

  Returns RayCastHit

publictouching

• touching(other: Collider): boolean

• Inherited from Collider.touching

  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

publicupdate

• update(transform: Transform): void

• Overrides Collider.update

  Updates collider world space geometry

  ---

  Parameters

  • transform: Transform

  Returns void