Class Vec2

A 2D vector.

Hierarchy (view full)

ManagedFloat64Array<2>
- Vec2

Implements

Vec<2>

Index

Constructors

Properties

Accessors

buffer byteLength length valid

Methods

[dispose] [iterator] add at copy dot free lerp mul mulMat3 normalize scale set setAt sub

Constructors

constructor

new Vec2(x?, y?): Vec2
Parameters
- x: number = 0
- y: number = 0
Returns Vec2
Overrides ManagedFloat64Array.constructor
- Defined in js/wasm/vec.ts:13

Properties

byteOffset

byteOffset: number

The offset in bytes of the array.

Accessors

buffer

get buffer(): ArrayBufferLike
The ArrayBuffer instance referenced by the array.

Returns ArrayBufferLike
Inherited from ManagedFloat64Array.buffer
- Defined in js/memory.ts:111

byteLength

get byteLength(): number
The length in bytes of the array.

Returns number
Inherited from ManagedFloat64Array.byteLength
- Defined in js/memory.ts:115

length

get length(): 2
Returns the length of Vec.

Returns 2
Implementation of Vec.length
Overrides ManagedFloat64Array.length
- Defined in js/wasm/vec.ts:18

valid

get valid(): boolean
Whether the array is still valid.

Returns boolean
Inherited from ManagedFloat64Array.valid
- Defined in js/memory.ts:119

Methods

[dispose]

[dispose](): void
Returns void
Inherited from ManagedFloat64Array.[dispose]
- Defined in js/memory.ts:73

[iterator]

[iterator](): Iterator<number, any, undefined>
Returns Iterator<number, any, undefined>
Inherited from ManagedFloat64Array.[iterator]
- Defined in js/memory.ts:64

add

add(rhs): this
Adds RHS to this vector.
Parameters
- rhs: Vec2
Returns this
Implementation of Vec.add
- Defined in js/wasm/vec.ts:22

at

at(index): undefined | number
Gets the value at given index.
Parameters
- index: number
Returns undefined | number
Inherited from ManagedFloat64Array.at
- Defined in js/memory.ts:78

copy

copy(from, dstOffset?, srcOffset?, length?): void
Copies a managed array to this.
Parameters
- from: ManagedFloat64Array<number>
- dstOffset: number = 0
- srcOffset: number = 0
- length: number = ...
Returns void
Inherited from ManagedFloat64Array.copy
- Defined in js/memory.ts:90

dot

dot(rhs): number
Computes the dot product of this vector with RHS.
Parameters
- rhs: Vec2
Returns number
Implementation of Vec.dot
- Defined in js/wasm/vec.ts:43

free

free(): void
Frees the array.

Returns void
Inherited from ManagedFloat64Array.free
- Defined in js/memory.ts:103

lerp

lerp(rhs, t): this
Computes the linear interpolation between this vector and RHS.
Parameters
- rhs: Vec2
- t: number
Returns this
Implementation of Vec.lerp
- Defined in js/wasm/vec.ts:47

mul

mul(m): this
Premultiplies matrix to this vector.
Parameters
- m: Mat2
Returns this
Implementation of Vec.mul
- Defined in js/wasm/vec.ts:32

mulMat3

mulMat3(m): this
Premultiplies 3x3 matrix to this.
Parameters
- m: Mat3
Returns this
- Defined in js/wasm/vec.ts:38

normalize

normalize(): boolean
Normalizes this vector.

Returns boolean
Implementation of Vec.normalize
- Defined in js/wasm/vec.ts:57

scale

scale(factor): this
Scales this vector by given factor.
Parameters
- factor: number
Returns this
Implementation of Vec.scale
- Defined in js/wasm/vec.ts:52

set

set(array, offset?): void
Copies an array to this.
Parameters
- array: ArrayLike<number>
- offset: number = 0
Returns void
Inherited from ManagedFloat64Array.set
- Defined in js/memory.ts:99

setAt

setAt(index, value): void
Sets the value at given index.
Parameters
- index: number
- value: number
Returns void
Inherited from ManagedFloat64Array.setAt
- Defined in js/memory.ts:84

sub

sub(rhs): this
Subtracts RHS from this vector.
Parameters
- rhs: Vec2
Returns this
Implementation of Vec.sub
- Defined in js/wasm/vec.ts:27

Generated using TypeDoc