Class Vec4

Hierarchy

AVec
- Vec4

Implements

IHash<number>
IVector<Vec4>

Indexable

[id: number]: number

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new Vec4(buf?: TypedArray | number[], offset?: number, stride?: number): Vec4

Inherited from AVec.constructor
- Defined in packages/vectors/src/vec4.ts:94
Parameters
- Optional buf: TypedArray | number[]
- offset: number = 0
- stride: number = 1
Returns Vec4

Properties

buf

buf: TypedArray | number[]

offset

offset: number

stride

stride: number

w

w: number

x

x: number

y

y: number

z

z: number

Readonly Static MAX

MAX: Vec4 = ...

Readonly Static MIN

MIN: Vec4 = ...

Readonly Static ONE

ONE: Vec4 = ...

Readonly Static X_AXIS

X_AXIS: Vec4 = ...

Readonly Static Y_AXIS

Y_AXIS: Vec4 = ...

Readonly Static ZERO

ZERO: Vec4 = ...

Readonly Static Z_AXIS

Z_AXIS: Vec4 = ...

Accessors

length

get length(): number

Implementation of IVector.length
- Defined in packages/vectors/src/vec4.ts:104
Returns number

Methods

[Symbol.iterator]

[Symbol.iterator](): Generator<number, void, unknown>

Implementation of IVector.[Symbol.iterator]
Overrides AVec.[Symbol.iterator]
- Defined in packages/vectors/src/vec4.ts:100
Returns Generator<number, void, unknown>

copy

copy(): Vec4

Implementation of IVector.copy
- Defined in packages/vectors/src/vec4.ts:108
Returns a copy of this instance. Shallow or deep copies are implementation specific.
Returns Vec4

copyView

copyView(): Vec4

Implementation of IVector.copyView
- Defined in packages/vectors/src/vec4.ts:112
Returns Vec4

empty

empty(): Vec4

Implementation of IVector.empty
- Defined in packages/vectors/src/vec4.ts:116
Returns an empty/blank instance of same type (with possibly same config, if any).
Returns Vec4

eqDelta

eqDelta(v: ReadonlyVec, eps?: number): boolean

- Defined in packages/vectors/src/vec4.ts:120
Parameters
- v: ReadonlyVec
- eps: number = ...
Returns boolean

hash

hash(): number

- Defined in packages/vectors/src/vec4.ts:124
Returns number

toJSON

toJSON(): number[]

- Defined in packages/vectors/src/vec4.ts:128
Returns number[]

toString

toString(): string

- Defined in packages/vectors/src/vec4.ts:132
Returns string

Static intoBuffer

intoBuffer(buf: TypedArray | number[], src: Iterable<Vec4>, start?: number, cstride?: number, estride?: number): TypedArray | number[]

- Defined in packages/vectors/src/vec4.ts:62
Merges given src iterable of Vec4s into single array buf. Vectors will be arranged according to given component and element strides, starting at start index. It's the user's responsibility to ensure the target buffer has sufficient capacity to hold the input vectors. See Vec4.mapBuffer for the inverse operation. Returns buf.
Parameters
- buf: TypedArray | number[]
  -
- src: Iterable<Vec4>
  -
- start: number = 0
  -
- cstride: number = 1
  -
- estride: number = 4
  -
Returns TypedArray | number[]

Static iterator

iterator(buf: TypedArray | number[], num: number, start?: number, cstride?: number, estride?: number): Generator<never, Generator<Vec4, void, unknown>, unknown>

- Defined in packages/vectors/src/vec4.ts:72
Parameters
- buf: TypedArray | number[]
- num: number
- start: number = 0
- cstride: number = 1
- estride: number = 4
Returns Generator<never, Generator<Vec4, void, unknown>, unknown>

Static mapBuffer

mapBuffer(buf: TypedArray | number[], num?: number, start?: number, cstride?: number, estride?: number): Vec4[]

- Defined in packages/vectors/src/vec4.ts:38
Returns array of memory mapped Vec4 instances using given backing array and stride settings: The cstride is the step size between individual XYZ vector components. estride is the step size between successive vectors. This arrangement allows for different storage approaches, incl. SOA, AOS, striped / interleaved etc.
Parameters
- buf: TypedArray | number[]
  backing array
- num: number = ...
  num vectors
- start: number = 0
  start index
- cstride: number = 1
  component stride
- estride: number = 4
  element stride
Returns Vec4[]

Generated using TypeDoc