EdgeCollider

Edge is a single line collider to create collisions with a single line.

Hierarchy

• Collider
  • EdgeCollider

Index

Constructors

• constructor

Properties

• begin
• composite
• end
• events
• id
• offset
• owner

Accessors

• axes
• bounds
• center
• localBounds
• worldPos

Methods

• asLine
• asLocalLine
• clone
• collide
• contains
• debug
• getClosestLineBetween
• getFurthestPoint
• getInertia
• getLength
• getSlope
• project
• rayCast
• touching
• update

Constructors

constructor

• new EdgeCollider(options: EdgeColliderOptions): EdgeCollider

• Overrides Collider.constructor

  Parameters

  • options: EdgeColliderOptions

  Returns EdgeCollider

Properties

begin

begin: Vector

publiccomposite

composite: CompositeCollider = null

Inherited from Collider.composite

Composite collider if any this collider is attached to

WARNING do not tamper with this property

end

end: Vector

publicevents

events: EventEmitter<any> = ...

Inherited from Collider.events

publicreadonlyid

id: Id<collider> = ...

Inherited from Collider.id

offset

offset: Vector

Overrides Collider.offset

Pixel offset of the collision collider relative to the collider, by default (0, 0) meaning the collider is positioned on top of the collider.

publicowner

owner: Entity<any>

Inherited from Collider.owner

Accessors

publicaxes

• get axes(): Vector[]

• Overrides Collider.axes

  Get the axis associated with the edge

  ---

  Returns Vector[]

publicbounds

• get bounds(): BoundingBox

• Overrides Collider.bounds

  Get the axis aligned bounding box for the edge collider in world space

  ---

  Returns BoundingBox

publiccenter

• get center(): Vector

• Overrides Collider.center

  Get the center of the collision area in world coordinates

  ---

  Returns Vector

publiclocalBounds

• get localBounds(): BoundingBox

• Overrides Collider.localBounds

  Get the axis aligned bounding box for the edge collider in local space

  ---

  Returns BoundingBox

publicworldPos

• get worldPos(): Vector

• Overrides Collider.worldPos

  Position of the collision collider in world coordinates

  ---

  Returns Vector

Methods

publicasLine

• asLine(): LineSegment

• Returns this edge represented as a line in world coordinates

  ---

  Returns LineSegment

publicasLocalLine

• asLocalLine(): LineSegment

• Return this edge as a line in local line coordinates (relative to the position)

  ---

  Returns LineSegment

publicclone

• clone(): EdgeCollider

• Overrides Collider.clone

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

  ---

  Returns EdgeCollider

publiccollide

• collide(shape: Collider): CollisionContact[]

• Overrides Collider.collide

  @inheritDoc

  ---

  Parameters

  • shape: Collider

  Returns CollisionContact[]

publiccontains

• contains(): boolean

• Overrides Collider.contains

  Tests if a point is contained in this collision area

  ---

  Returns boolean

publicdebug

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

• Overrides Collider.debug

  Parameters

  • ex: ExcaliburGraphicsContext

  • color: Color

  Returns void

publicgetClosestLineBetween

• getClosestLineBetween(shape: Collider): LineSegment

• Overrides Collider.getClosestLineBetween

  Returns the closes line between this and another collider, from this -> collider

  ---

  Parameters

  • shape: Collider

  Returns LineSegment

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 edge https://en.wikipedia.org/wiki/List_of_moments_of_inertia

  ---

  Parameters

  • mass: number

  Returns number

publicgetLength

• getLength(): number

• Returns the length of the line segment in pixels

  ---

  Returns number

publicgetSlope

• getSlope(): Vector

• Returns the slope of the line in the form of a vector

  ---

  Returns Vector

publicproject

• project(axis: Vector): Projection

• Overrides Collider.project

  Project the edge along a specified axis

  ---

  Parameters

  • axis: Vector

  Returns Projection

publicrayCast

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

• Overrides Collider.rayCast

  Return the point on the border of the collision collider that intersects with a ray (if any).

  ---

  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