Class: Ray

physics/ray.Ray

Represents a ray that can be used for raycasting.

A Ray is really a LineCollider with a weight of Physics.G_CONF.POINT_SIZE.

Hierarchy

• LineCollider

  ↳ Ray

Constructors

constructor

• new Ray(origin, direction, length)

Create a Ray.

Parameters

Name	Type	Description
origin	vec2	The ray's starting position
direction	vec2	The direction of the ray
length	number	The length of the ray

Overrides

LineCollider.constructor

Defined in

src/physics/ray.ts:22

Properties

direction

• Private direction: vec2

Defined in

src/physics/ray.ts:12

---

length

• Private length: number

Defined in

src/physics/ray.ts:13

---

listeners

• Protected listeners: Object = {}

Index signature

▪ [index: string]: Listener[]

Inherited from

LineCollider.listeners

Defined in

src/object2d.ts:32

---

opacity

• opacity: number = 1

Opacity of the shape.

This is an opacity of the whole shape which is applied to the shape's entire texture equally.

Range is 0 (completely transparent) to 1 (completely opaque)

Inherited from

LineCollider.opacity

Defined in

src/shapes/shape.ts:28

---

texture

• texture: Texture = defaultTexture

Inherited from

LineCollider.texture

Defined in

src/shapes/shape.ts:19

Methods

addEventListener

▸ addEventListener(event, listener): boolean

Executes a function when an event is fired.

Parameters

Name	Type	Description
event	string	The event to listen for
listener	Listener	The function to execute when the event fired

Returns

boolean

Wether or not the listener was added

Inherited from

LineCollider.addEventListener

Defined in

src/object2d.ts:209

---

findFurthestNeighbours

▸ findFurthestNeighbours(direction): Object

Calculates the furthest point on the collider in a direction and it's neighbouring vertices on the collider.

Parameters

Name	Type	Description
direction	vec2	The direction in which to calculate the furthest point

Returns

Object

The furthest point on the collider in the given direction and its left and right neighbours

Name	Type
furthest	vec2
furthestIndex	number
left	vec2
leftIndex	number
right	vec2
rightIndex	number

Inherited from

LineCollider.findFurthestNeighbours

Defined in

src/physics/collider/line.ts:81

---

findFurthestPoint

▸ findFurthestPoint(direction): vec2

Calculates the furthest point on the collider in a direction.

Parameters

Name	Type	Description
direction	vec2	The direction in which to calculate the furthest point

Returns

vec2

The furthest point on the collider in the given direction

Inherited from

LineCollider.findFurthestPoint

Defined in

src/physics/collider/line.ts:59

---

fireEvent

▸ fireEvent(event, ...e): void

Executes all listeners attached to a given event.

Parameters

Name	Type	Description
event	string	The event to fire
...e	any	The data to pass to each event listener

Returns

void

Inherited from

LineCollider.fireEvent

Defined in

src/object2d.ts:185

---

getBaseVertices

▸ getBaseVertices(): vec2[]

Calculates the base vertices of the rectangle.

These vertices are the base vertices for a quad, scaled to the width and height of the {@link Rectangle} instance.

Returns

vec2[]

The rectangles base vertices

Inherited from

LineCollider.getBaseVertices

Defined in

src/shapes/rect.ts:84

---

getDirection

▸ getDirection(): vec2

Gets the direction of the ray.

Returns

vec2

The direction of the ray

Defined in

src/physics/ray.ts:36

---

getEnd

▸ getEnd(): vec2

Gets the point at which the line ends.

Returns

vec2

The end point of the line

Inherited from

LineCollider.getEnd

Defined in

src/shapes/line.ts:127

---

getEventListeners

▸ getEventListeners(event): Listener[]

Gets the listeners attached to an event.

Parameters

Name	Type
event	string

Returns

Listener[]

An array of listeners attached to the given event

Inherited from

LineCollider.getEventListeners

Defined in

src/object2d.ts:198

---

getEvents

▸ getEvents(): string[]

Gets the events that can be listened to on the object.

Returns

string[]

The events the object supports

Inherited from

LineCollider.getEvents

Defined in

src/object2d.ts:175

---

getHeight

▸ getHeight(): number

Gets the rectangle's height in world space units.

Returns

number

The rectangle's height in world space

Inherited from

LineCollider.getHeight

Defined in

src/shapes/rect.ts:162

---

getIndices

▸ getIndices(offset?): Uint16Array

Gets the rect's vertex indices for drawing using element arrays.

Parameters

Name	Type	Default value	Description
offset	number	0	An offset to apply to each index

Returns

Uint16Array

The rect's vertex indices with the given offset added to each index

Inherited from

LineCollider.getIndices

Defined in

src/shapes/rect.ts:109

---

getLength

▸ getLength(): number

Gets the length of the ray.

Returns

number

The length of the ray

Defined in

src/physics/ray.ts:45

---

getPoints

▸ getPoints(): vec2[]

Calculates the bounding points of the Shape instance.

NOTE: The shape's vertices are recalculated every time this function is called.

Returns

vec2[]

The bounding points of the box

Inherited from

LineCollider.getPoints

Defined in

src/shapes/shape.ts:136

---

getPosition

▸ getPosition(): vec2

Gets the object's position.

Returns

vec2

The object's position as a vec2

Inherited from

LineCollider.getPosition

Defined in

src/object2d.ts:82

---

getRotation

▸ getRotation(): number

Gets the object's rotation as a number in radians relative to y+.

Returns

number

The object's rotation

Inherited from

LineCollider.getRotation

Defined in

src/object2d.ts:139

---

getStart

▸ getStart(): vec2

Gets the point at which the line begins.

Returns

vec2

The start point of the line

Inherited from

LineCollider.getStart

Defined in

src/shapes/line.ts:109

---

getUVCoords

▸ getUVCoords(): Float32Array

Calculates the rects's UV coords to be used for texture rendering.

Returns

Float32Array

the rect's UV coords

Inherited from

LineCollider.getUVCoords

Defined in

src/shapes/rect.ts:118

---

getVertices

▸ getVertices(): number[]

Calculates the shape's vertices in local space.

Returns

number[]

The shape's vertices

Inherited from

LineCollider.getVertices

Defined in

src/shapes/shape.ts:57

---

getVerticesClipSpace

▸ getVerticesClipSpace(origin, scale, rotation?, camera?): number[]

Calculates the shape's vertices relative to the provided origin in world space.

Parameters

Name	Type	Description
origin	vec2	The origin to calculate the vertices relative to, should be a world position
scale	vec2	The vector to scale the world space vertices by to obtain clip space values
rotation?	number	An optional rotation to apply to the vertices
camera?	Camera	An optional camera to get vertices relative to

Returns

number[]

The shape's vertices relative to the provided origin in clip space

Inherited from

LineCollider.getVerticesClipSpace

Defined in

src/shapes/shape.ts:87

---

getVerticesWorld

▸ getVerticesWorld(origin, rotation?, returnVecs?): number[] | vec2[]

Calculates the rect's vertices relative to the provided origin in world space.

Parameters

Name	Type	Default value	Description
origin	vec2	undefined	The origin to calculate the vertices relative to, should be a world position
rotation?	number	undefined	An optional world space rotation to apply to the vertices
returnVecs	boolean	false	Wether or not to return the vertices as vec2s or raw numbers

Returns

number[] | vec2[]

The rect's vertices relative to the provided origin in world space

Inherited from

LineCollider.getVerticesWorld

Defined in

src/shapes/rect.ts:51

---

getWeight

▸ getWeight(): number

Gets the weight of the line (thickness).

Returns

number

The stroke weight of the line

Inherited from

LineCollider.getWeight

Defined in

src/shapes/line.ts:91

---

getWidth

▸ getWidth(): number

Gets the rectangle's width in world space units.

Returns

number

The rectangle's width in world space

Inherited from

LineCollider.getWidth

Defined in

src/shapes/rect.ts:140

---

moveRight

▸ moveRight(dist): void

Moves the object's position right (x+) relative to it's rotation.

Parameters

Name	Type	Description
dist	number	The distance to move right, can be + or -

Returns

void

Inherited from

LineCollider.moveRight

Defined in

src/object2d.ts:100

---

moveUp

▸ moveUp(dist): void

Moves the object's position up (y+) relative to it's rotation.

Parameters

Name	Type	Description
dist	number	The distance to move up, can be + or -

Returns

void

Inherited from

LineCollider.moveUp

Defined in

src/object2d.ts:114

---

removeEventListener

▸ removeEventListener(event, listener): boolean

Removes a listener from an event.

Parameters

Name	Type	Description
event	string	The event the listener is attached to
listener	Listener	The listener to remove

Returns

boolean

Wether or not the listener was removed

Inherited from

LineCollider.removeEventListener

Defined in

src/object2d.ts:223

---

render

▸ render(position?, rotation?, zIndex?): void

Renders the shape using the Renderer.

Parameters

Name	Type	Description
position?	vec2	The x and y position to render the shape at
rotation?	number	The rotation to apply to the rendered shape
zIndex?	number	The z position of the rendered shape

Returns

void

Inherited from

LineCollider.render

Defined in

src/shapes/shape.ts:41

---

rotate

▸ rotate(angle): void

Increments the object's rotation by an angle in radians.

Parameters

Name	Type	Description
angle	number	The angle to rotate by in radians

Returns

void

Inherited from

LineCollider.rotate

Defined in

src/object2d.ts:148

---

setEnd

▸ setEnd(end): void

Sets the end point of the line.

Parameters

Name	Type	Description
end	vec2	The new end point of the line

Returns

void

Inherited from

LineCollider.setEnd

Defined in

src/shapes/line.ts:118

---

setHeight

▸ setHeight(height): void

Sets the rectangle's height.

throws When the the provided height is < 0

Parameters

Name	Type	Description
height	number	The rectangle's new height

Returns

void

Inherited from

LineCollider.setHeight

Defined in

src/shapes/rect.ts:151

---

setPosition

▸ setPosition(pos): void

Sets the object's position.

Parameters

Name	Type	Description
pos	vec2	The object's new position

Returns

void

Inherited from

LineCollider.setPosition

Defined in

src/object2d.ts:43

---

setPositionX

▸ setPositionX(x): void

Sets the x component of the object's position.

Parameters

Name	Type	Description
x	number	The object's new x coordinate

Returns

void

Inherited from

LineCollider.setPositionX

Defined in

src/object2d.ts:56

---

setPositionY

▸ setPositionY(y): void

Sets the y component of the object's position.

Parameters

Name	Type	Description
y	number	The object's new y coordinate

Returns

void

Inherited from

LineCollider.setPositionY

Defined in

src/object2d.ts:69

---

setRotation

▸ setRotation(angle): void

Sets the object's rotation.

Parameters

Name	Type	Description
angle	number	The object's new rotation

Returns

void

Inherited from

LineCollider.setRotation

Defined in

src/object2d.ts:128

---

setStart

▸ setStart(start): void

Sets the starting point of the line.

Parameters

Name	Type	Description
start	vec2	The new starting point of the line

Returns

void

Inherited from

LineCollider.setStart

Defined in

src/shapes/line.ts:100

---

setWeight

▸ setWeight(weight): void

Sets the weight of the line (thickness).

Parameters

Name	Type	Description
weight	number	The new weight of the line

Returns

void

Inherited from

LineCollider.setWeight

Defined in

src/shapes/line.ts:79

---

setWidth

▸ setWidth(width): void

Sets the rectangle's width.

throws When the the provided width is < 0

Parameters

Name	Type	Description
width	number	The rectangle's new width

Returns

void

Inherited from

LineCollider.setWidth

Defined in

src/shapes/rect.ts:129

---

setupEvents

▸ Protected setupEvents(): void

Sets all the events that can be used in listeners.

Listeners can be added for an event using:

   this.listeners.eventName = [];

example Setup listeners for "position" and "rotate" events. this.listeners.position = []; this.listeners.rotate = [];

Returns

void

Inherited from

LineCollider.setupEvents

Defined in

src/object2d.ts:165

---

supportPoint

▸ supportPoint(c, direction): vec2

Calculates a support point on the minkowski difference in a given direction.

Parameters

Name	Type	Description
c	Collider	The collider to test against
direction	vec2	The direction to use when calculating furthest points

Returns

vec2

The support point in the given direction for the Minkowski difference

Inherited from

LineCollider.supportPoint

Defined in

src/physics/collider/line.ts:44

---

testCollision

▸ testCollision(c): CollisionResult

Checks if this line is colliding with another collider.

Parameters

Name	Type	Description
c	Collider	Collider to test collisions against

Returns

CollisionResult

CollisionResult with the results of the test

Inherited from

LineCollider.testCollision

Defined in

src/physics/collider/line.ts:18

---

translate

▸ translate(v): void

Translates the object by the provided vector.

Parameters

Name	Type	Description
v	vec2	The vector to translate by

Returns

void

Inherited from

LineCollider.translate

Defined in

src/object2d.ts:91