Class PolygonCollider

Polygon collider for detecting collisions

Hierarchy

Collider
- PolygonCollider

Index

Constructors

constructor

new PolygonCollider(options: PolygonColliderOptions): PolygonCollider
Parameters
- options: PolygonColliderOptions
Returns PolygonCollider
Overrides Collider.constructor
- Defined in Collision/Colliders/PolygonCollider.ts:66

Properties

events

events: EventDispatcher<Collider> = ...

`Readonly` id

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

offset

offset: Vector

Pixel offset relative to a collider's body transform position.

owner

owner: Entity

Accessors

axes

get axes(): Vector[]
Get the axis associated with the convex polygon

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

bounds

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

Returns BoundingBox
Overrides Collider.bounds
- Defined in Collision/Colliders/PolygonCollider.ts:528

center

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

Returns Vector
Overrides Collider.center
- Defined in Collision/Colliders/PolygonCollider.ts:276

localBounds

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

Returns BoundingBox
Overrides Collider.localBounds
- Defined in Collision/Colliders/PolygonCollider.ts:537

points

get points(): Vector[]
Points in the polygon in order around the perimeter in local coordinates. These are relative from the body transform position. Excalibur stores these in counter-clockwise order

Returns Vector[]
- Defined in Collision/Colliders/PolygonCollider.ts:56
set points(points: Vector[]): void
Points in the polygon in order around the perimeter in local coordinates. These are relative from the body transform position. Excalibur stores these in counter-clockwise order
Parameters
- points: Vector[]
Returns void
- Defined in Collision/Colliders/PolygonCollider.ts:45

worldPos

get worldPos(): Vector
Returns the world position of the collider, which is the current body transform plus any defined offset

Returns Vector
Overrides Collider.worldPos
- Defined in Collision/Colliders/PolygonCollider.ts:266

Methods

clone

clone(): PolygonCollider
Returns a clone of this ConvexPolygon, not associated with any collider

Returns PolygonCollider
Overrides Collider.clone
- Defined in Collision/Colliders/PolygonCollider.ts:256

collide

collide(collider: Collider): CollisionContact[]
Returns a collision contact if the 2 colliders collide, otherwise collide will return null.
Parameters
- collider: Collider
Returns CollisionContact[]
Overrides Collider.collide
- Defined in Collision/Colliders/PolygonCollider.ts:450

contains

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

debug

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

findLocalSide

findLocalSide(direction: Vector): LineSegment
Given a direction vector find the local space side that is most in that direction
Parameters
- direction: Vector
Returns LineSegment
- Defined in Collision/Colliders/PolygonCollider.ts:369

findSide

findSide(direction: Vector): LineSegment
Given a direction vector find the world space side that is most in that direction
Parameters
- direction: Vector
Returns LineSegment
- Defined in Collision/Colliders/PolygonCollider.ts:349

getClosestFace

getClosestFace(point: Vector): {
distance: Vector;
face: LineSegment;
}
Finds the closes face to the point using perpendicular distance
Parameters
- point: Vector
  
  point to test against polygon
Returns {
distance: Vector;
face: LineSegment;
}
- distance: Vector
- face: LineSegment
- Defined in Collision/Colliders/PolygonCollider.ts:501

getClosestLineBetween

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

getFurthestLocalPoint

getFurthestLocalPoint(direction: Vector): Vector
Find the local point on the collider furthest in the direction specified
Parameters
- direction: Vector
Returns Vector
- Defined in Collision/Colliders/PolygonCollider.ts:483

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/PolygonCollider.ts:465

getInertia

getInertia(mass: number): number
Get the moment of inertia for an arbitrary polygon https://en.wikipedia.org/wiki/List_of_moments_of_inertia
Parameters
- mass: number
Returns number
Overrides Collider.getInertia
- Defined in Collision/Colliders/PolygonCollider.ts:552

getLocalSides

getLocalSides(): LineSegment[]
Returns the local coordinate space sides

Returns LineSegment[]
- Defined in Collision/Colliders/PolygonCollider.ts:329

getSides

getSides(): LineSegment[]
Gets the sides of the polygon in world space

Returns LineSegment[]
- Defined in Collision/Colliders/PolygonCollider.ts:310

getTransformedPoints

getTransformedPoints(): Vector[]
Gets the points that make up the polygon in world space, from actor relative space (if specified)

Returns Vector[]
- Defined in Collision/Colliders/PolygonCollider.ts:298

isConvex

isConvex(): boolean
Returns if the polygon collider is convex, Excalibur does not handle non-convex collision shapes. Call Polygon.triangulate to generate a CompositeCollider from this non-convex shape

Returns boolean
- Defined in Collision/Colliders/PolygonCollider.ts:98

project

project(axis: Vector): Projection
Project the edges of the polygon along a specified axis
Parameters
- axis: Vector
Returns Projection
Overrides Collider.project
- Defined in Collision/Colliders/PolygonCollider.ts:601

rayCast

rayCast(ray: Ray, max?: number): Vector
Casts a ray into the polygon and returns a vector representing the point of contact (in world space) or null if no collision.
Parameters
- ray: Ray
- max: number = Infinity
Returns Vector
Overrides Collider.rayCast
- Defined in Collision/Colliders/PolygonCollider.ts:574

tessellate

tessellate(): CompositeCollider
Tessellates the polygon into a triangle fan as a CompositeCollider of triangle polygons

Returns CompositeCollider
- Defined in Collision/Colliders/PolygonCollider.ts:141

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

triangulate

triangulate(): CompositeCollider
Triangulate the polygon collider using the "Ear Clipping" algorithm. Returns a new CompositeCollider made up of smaller triangles.

Returns CompositeCollider
- Defined in Collision/Colliders/PolygonCollider.ts:155

update

update(transform: Transform): void
Updates the transform for the collision geometry

Collision geometry (points/bounds) will not change until this is called.
Parameters
- transform: Transform
Returns void
Overrides Collider.update
- Defined in Collision/Colliders/PolygonCollider.ts:403

Class PolygonCollider

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: PolygonColliderOptions

Returns PolygonCollider

Properties

events

Readonly id

offset

owner

Accessors

axes

Returns Vector[]

bounds

Returns BoundingBox

center

Returns Vector

localBounds

Returns BoundingBox

points

Returns Vector[]

Parameters

points: Vector[]

Returns void

worldPos

Returns Vector

Methods

clone

Returns PolygonCollider

collide

Parameters

collider: Collider

Returns CollisionContact[]

contains

Parameters

point: Vector

Returns boolean

debug

Parameters

ex: ExcaliburGraphicsContext

color: Color

Returns void

findLocalSide

Parameters

direction: Vector

Returns LineSegment

findSide

Parameters

direction: Vector

Returns LineSegment

getClosestFace

Parameters

point: Vector

Returns { distance: Vector; face: LineSegment; }

distance: Vector

face: LineSegment

getClosestLineBetween

Parameters

collider: Collider

Returns LineSegment

getFurthestLocalPoint

Parameters

direction: Vector

Returns Vector

getFurthestPoint

Parameters

direction: Vector

Returns Vector

getInertia

Parameters

mass: number

Returns number

getLocalSides

`Readonly` id

Returns {
distance: Vector;
face: LineSegment;
}