PolygonCollider

Polygon collider for detecting collisions

Hierarchy

• Collider
  • PolygonCollider

Index

Constructors

• constructor

Properties

• composite
• events
• id
• offset
• owner

Accessors

• axes
• bounds
• center
• localBounds
• points
• worldPos

Methods

• clone
• collide
• contains
• debug
• findLocalSide
• findSide
• flagDirty
• getClosestFace
• getClosestLineBetween
• getFurthestLocalPoint
• getFurthestPoint
• getInertia
• getLocalSides
• getSides
• getTransformedPoints
• isConvex
• project
• rayCast
• tessellate
• touching
• triangulate
• update

Constructors

constructor

• new PolygonCollider(options: PolygonColliderOptions): PolygonCollider

• Overrides Collider.constructor

  Parameters

  • options: PolygonColliderOptions

  Returns PolygonCollider

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

Overrides Collider.offset

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

publicowner

owner: Entity<any>

Inherited from Collider.owner

Accessors

publicaxes

• get axes(): Vector[]

• Overrides Collider.axes

  Get the axis associated with the convex polygon

  ---

  Returns Vector[]

publicbounds

• get bounds(): BoundingBox

• Overrides Collider.bounds

  Get the axis aligned bounding box for the polygon 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 polygon collider in local coordinates

  ---

  Returns BoundingBox

publicpoints

• get points(): Vector[]
• 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

  ---

  Returns 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

  ---

  Parameters

  • points: Vector[]

  Returns void

publicworldPos

• get worldPos(): Vector

• Overrides Collider.worldPos

  Returns the world position of the collider, which is the current body transform plus any defined offset

  ---

  Returns Vector

Methods

publicclone

• clone(): PolygonCollider

• Overrides Collider.clone

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

  ---

  Returns PolygonCollider

publiccollide

• collide(collider: Collider): CollisionContact[]

• Overrides Collider.collide

  Returns a collision contact if the 2 colliders collide, otherwise collide will return null.

  ---

  Parameters

  • collider: Collider

  Returns CollisionContact[]

publiccontains

• contains(point: Vector): boolean

• Overrides Collider.contains

  Tests if a point is contained in this collider in world space

  ---

  Parameters

  • point: Vector

  Returns boolean

publicdebug

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

• Overrides Collider.debug

  Parameters

  • ex: ExcaliburGraphicsContext

  • color: Color

  • optionaloptions: { lineWidth: number; pointSize: number }

  Returns void

publicfindLocalSide

• findLocalSide(direction: Vector): LineSegment

• Given a direction vector find the local space side that is most in that direction

  ---

  Parameters

  • direction: Vector

  Returns LineSegment

publicfindSide

• findSide(direction: Vector): LineSegment

• Given a direction vector find the world space side that is most in that direction

  ---

  Parameters

  • direction: Vector

  Returns LineSegment

publicflagDirty

• flagDirty(): void

• Returns void

publicgetClosestFace

• 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

publicgetClosestLineBetween

• getClosestLineBetween(collider: Collider): LineSegment

• Overrides Collider.getClosestLineBetween

  Returns the closest line between the surfaces this collider and another

  ---

  Parameters

  • collider: Collider

  Returns LineSegment

publicgetFurthestLocalPoint

• getFurthestLocalPoint(direction: Vector): Vector

• Find the local point on the collider furthest 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

  Get the moment of inertia for an arbitrary polygon https://en.wikipedia.org/wiki/List_of_moments_of_inertia

  ---

  Parameters

  • mass: number

  Returns number

publicgetLocalSides

• getLocalSides(): LineSegment[]

• Returns the local coordinate space sides

  ---

  Returns LineSegment[]

publicgetSides

• getSides(): LineSegment[]

• Gets the sides of the polygon in world space

  ---

  Returns LineSegment[]

publicgetTransformedPoints

• getTransformedPoints(): Vector[]

• Gets the points that make up the polygon in world space, from actor relative space (if specified)

  ---

  Returns Vector[]

publicisConvex

• 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

publicproject

• project(axis: Vector): Projection

• Overrides Collider.project

  Project the edges of the polygon along a specified axis

  ---

  Parameters

  • axis: Vector

  Returns Projection

publicrayCast

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

• Overrides Collider.rayCast

  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 RayCastHit

publictessellate

• tessellate(): CompositeCollider

• Tessellates the polygon into a triangle fan as a [[CompositeCollider]] of triangle polygons

  ---

  Returns CompositeCollider

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

publictriangulate

• triangulate(): CompositeCollider

• Triangulate the polygon collider using the "Ear Clipping" algorithm. Returns a new [[CompositeCollider]] made up of smaller triangles.

  ---

  Returns CompositeCollider

publicupdate

• update(transform: Transform): void

• Overrides Collider.update

  Updates the transform for the collision geometry

  Collision geometry (points/bounds) will not change until this is called.

  ---

  Parameters

  • transform: Transform

  Returns void