Class Vector2

Hierarchy

Vector2

Implements

IPoint

Index

Constructors

constructor

Properties

_values

Accessors

x
xy
y
zero

Methods

Constructors

constructor

new Vector2(): Vector2
new Vector2(points: IPointData): Vector2
new Vector2(x: number, y: number): Vector2
new Vector2(xy: XY): Vector2

- Defined in source/src/maths/Vector2.ts:7
Returns Vector2
- Defined in source/src/maths/Vector2.ts:9
Parameters
- points: IPointData
Returns Vector2
- Defined in source/src/maths/Vector2.ts:10
Parameters
- x: number
- y: number
Returns Vector2
- Defined in source/src/maths/Vector2.ts:11
Parameters
- xy: XY
Returns Vector2

Properties

Protected _values

_values: Float32Array = ...

Accessors

x

get x(): number
set x(value: number): void

Implementation of IPoint.x
- Defined in source/src/maths/Vector2.ts:43
Returns number
- The x-component of the vector
Implementation of IPoint.x
- Defined in source/src/maths/Vector2.ts:50
Parameters
- value: number
  
  The new x-component of the vector
Returns void
- The x-component of the vector

xy

get xy(): XY
set xy(values: XY): void

- Defined in source/src/maths/Vector2.ts:71
Returns XY
- An array containing the x-component and y-component of the vector
- Defined in source/src/maths/Vector2.ts:78
Parameters
- values: XY
  
  An array containing the new x-component and y-component of the vector
Returns void
- An array containing the x-component and y-component of the vector

y

get y(): number
set y(value: number): void

Implementation of IPoint.y
- Defined in source/src/maths/Vector2.ts:57
Returns number
- The y-component of the vector
Implementation of IPoint.y
- Defined in source/src/maths/Vector2.ts:64
Parameters
- value: number
  
  The new y-component of the vector
Returns void
- The y-component of the vector

Static zero

get zero(): Vector2

- Defined in source/src/maths/Vector2.ts:36
Retrieves a new instance of the vector (0, 0)

Returns Vector2
- The zero vector

Methods

abs

abs(dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:271
Return the absolute values of X and Y.

Parameters
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

add

add(vector: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:347
Adds two vectors together. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

at

at(index: number): number

- Defined in source/src/maths/Vector2.ts:282
Retrieves the x-component or y-component of the vector.

Parameters
- index: number
Returns number

copyFrom

copyFrom(src: IPointData): Vector2

Implementation of IPoint.copyFrom
- Defined in source/src/maths/Vector2.ts:236
Copies the x and y components from the source to the destination. The source and destination must be of the same type.

Parameters
- src: IPointData
  
  The source point.
Returns Vector2

copyTo

copyTo<T>(p: T): T

Implementation of IPoint.copyTo
- Defined in source/src/maths/Vector2.ts:247
Copies the x and y components from the source to the destination. The source and destination must be of the same type.

Type parameters
- T: IPointData
  
  The type of your source, can also be a Vector2.
Parameters
- p: T
  
  The source point.
Returns T

deepClone

deepClone(dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:431
Returns a deep clone this Vector. If no dest vector is specified, the operation is performed in-place.

Parameters
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2
- The resulting deep clone.

divide

divide(vector: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:385
Divides two vectors piecewise.

Parameters
- vector: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

equals

equals(other: Vector2, threshold?: number): boolean

Implementation of IPoint.equals
- Defined in source/src/maths/Vector2.ts:311
Checks if two vectors are equal, using a threshold to avoid floating-point precision errors.

Parameters
- other: Vector2
- threshold: number = 0.00001
Returns boolean

greaterThan

greaterThan(other: Vector2): boolean

- Defined in source/src/maths/Vector2.ts:320
Returns true if both X & Y are greater than the other Vector2.

Parameters
- other: Vector2
Returns boolean

length

length(): number

- Defined in source/src/maths/Vector2.ts:328
Returns the distance from the vector to the origin.

Returns number

multiply

multiply(vector: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:373
Multiplies two vectors together piecewise. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

negate

negate(dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:299
Multiplies both the x- and y-components of a vector by -1. If no dest vector is specified, the operation is performed in-place.

Parameters
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

normalize

normalize(dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:410
Normalizes a vector. If no dest vector is specified, the operation is performed in-place.

Parameters
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

reset

reset(): void

- Defined in source/src/maths/Vector2.ts:289
Sets both the x- and y-components of the vector to 0.

Returns void

scale

scale(value: number, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:398
Scales a vector by a scalar parameter. If no dest vector is specified, the operation is performed in-place.

Parameters
- value: number
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

set

set(x: number, y: number): Vector2
set(value?: number): Vector2

Implementation of IPoint.set
- Defined in source/src/maths/Vector2.ts:259
Set the x and y values.

Parameters
- x: number
- y: number
Returns Vector2
Implementation of PIXI.IPoint.set
- Defined in source/src/maths/Vector2.ts:260
Parameters
- Optional value: number
Returns Vector2

squaredLength

squaredLength(): number

- Defined in source/src/maths/Vector2.ts:336
Returns the distance from the vector to the origin, squared.

Returns number

subtract

subtract(vector: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:360
Subtracts one vector from another. If no dest vector is specified, the operation is performed in-place.

Parameters
- vector: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

toJSON

toJSON(): { x: number; y: number }

- Defined in source/src/maths/Vector2.ts:437
Returns { x: number; y: number }
- x: number
- y: number

toObservable

toObservable<T>(callback: () => any, scope: T): ObservableVector2<T>

- Defined in source/src/maths/Vector2.ts:454
Convert this Vector to an ObservableVector2.

Type parameters
- T = any
Parameters
- callback: () => any
  
  Callback of the observableVector2.
  - - (): any
    - Returns any
- scope: T
  
  Scope of the ObservableVector2.
Returns ObservableVector2<T>
- An ObservableVector2.

toString

toString(): string

- Defined in source/src/maths/Vector2.ts:444
Returns string

Static difference

difference(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:195
Subtracts two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Static direction

direction(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:143
Calculates a normalized vector representing the direction from one vector to another. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Static distance

distance(vector: Vector2, vector2: IPointData): number

- Defined in source/src/maths/Vector2.ts:119
Calculates the distance between two vectors.

Parameters
- vector: Vector2
- vector2: IPointData
Returns number
- The distance between the two vectors.

Static dot

dot(vector: Vector2, vector2: Vector2): number

- Defined in source/src/maths/Vector2.ts:109
Calculates the dot product of two vectors.

Parameters
- vector: Vector2
- vector2: Vector2
Returns number
- The dot product of the two vectors.

Static lerp

lerp(a: Vector2, b: Vector2, t: number, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:166
Performs a linear interpolation over two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- a: Vector2
- b: Vector2
- t: number
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Static max

max(vector: Vector2, ...vectors: Vector2[]): Vector2

- Defined in source/src/maths/Vector2.ts:89
Retrieves the maximum vector values between two or more vectors.

Parameters
- vector: Vector2
- Rest ...vectors: Vector2[]
Returns Vector2
- The result of the maximum vector values.

Static min

min(vector: Vector2, ...vectors: Vector2[]): Vector2

- Defined in source/src/maths/Vector2.ts:99
Retrieves the minimum vector values between two or more vectors.

Parameters
- vector: Vector2
- Rest ...vectors: Vector2[]
Returns Vector2
- The result of the minimum vector values.

Static product

product(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:210
Multiplies two vectors piecewise. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Static quotient

quotient(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:225
Divides two vectors piecewise. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Static squaredDistance

squaredDistance(vector: Vector2, vector2: IPointData): number

- Defined in source/src/maths/Vector2.ts:129
Calculates the distance between two vectors squared.

Parameters
- vector: Vector2
- vector2: IPointData
Returns number
- The distance between the two vectors.

Static sum

sum(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2

- Defined in source/src/maths/Vector2.ts:181
Adds two vectors. If no dest vector is specified, a new vector is instantiated.

Parameters
- vector: Vector2
- vector2: Vector2
- Optional dest: Vector2
  
  An optional destination Vector2.
Returns Vector2

Generated using TypeDoc