Interface IVector3

Interface for immutable 3D vectors. Provides operations specific to 3-component vectors with homogeneous coordinate support.

interface IVector3 {
    _v: TypedArray;
    bytesPerComponent: number;
    className: string;
    glslStrAsFloat: string;
    glslStrAsInt: string;
    w: number;
    wgslStrAsFloat: string;
    wgslStrAsInt: string;
    x: number;
    y: number;
    z: number;
    at(i: number): number;
    clone(): IVector3;
    dot(vec: IVector3): number;
    flattenAsArray(): number[];
    isDummy(): boolean;
    isEqual(vec: IVector3, delta?: number): boolean;
    isStrictEqual(vec: IVector3): boolean;
    isTheSourceSame(arrayBuffer: ArrayBuffer): boolean;
    length(): number;
    lengthSquared(): number;
    lengthTo(vec: IVector3): number;
    toString(): string;
    toStringApproximately(): string;
    v(i: number): number;
}

Hierarchy (view full)

IVector
- IVector3

Implemented by

Properties

`Readonly`_v

_v: TypedArray

The underlying typed array containing vector components

`Readonly`bytesPerComponent

bytesPerComponent: number

Number of bytes per component in the underlying array

`Readonly`className

className: string

The class name identifier

`Readonly`glslStrAsFloat

glslStrAsFloat: string

GLSL string representation for float type

`Readonly`glslStrAsInt

glslStrAsInt: string

GLSL string representation for integer type

`Readonly`w

w: number

The w component (homogeneous coordinate, typically 1.0 for points, 0.0 for vectors)

`Readonly`wgslStrAsFloat

wgslStrAsFloat: string

WGSL string representation for float type

`Readonly`wgslStrAsInt

wgslStrAsInt: string

WGSL string representation for integer type

`Readonly`x

x: number

The x component

`Readonly`y

y: number

The y component

`Readonly`z

z: number

The z component

Methods

at

at(i): number
Gets component at index.
Parameters
- i: number
  Component index (0=x, 1=y, 2=z)
Returns number
Component value
Overrides IVector.at
- Defined in foundation/math/IVector.ts:566

clone

clone(): IVector3
Creates a copy of this vector.

Returns IVector3
New Vector3 instance
- Defined in foundation/math/IVector.ts:598

dot

dot(vec): number
Calculates dot product with another Vector3.
Parameters
- vec: IVector3
  Other vector
Returns number
Dot product
Overrides IVector.dot
- Defined in foundation/math/IVector.ts:592

flattenAsArray

flattenAsArray(): number[]
Converts the vector to a flat array.

Returns number[]
Array containing [x, y, z]
Overrides IVector.flattenAsArray
- Defined in foundation/math/IVector.ts:538

isDummy

isDummy(): boolean
Checks if this is a dummy vector.

Returns boolean
True if dummy
Overrides IVector.isDummy
- Defined in foundation/math/IVector.ts:544

isEqual

isEqual(vec, delta?): boolean
Checks equality with another Vector3 within tolerance.
Parameters
- vec: IVector3
  Vector to compare with
- Optionaldelta: number
  Optional tolerance
Returns boolean
True if approximately equal
Overrides IVector.isEqual
- Defined in foundation/math/IVector.ts:552

isStrictEqual

isStrictEqual(vec): boolean
Checks strict equality with another Vector3.
Parameters
- vec: IVector3
  Vector to compare with
Returns boolean
True if exactly equal
Overrides IVector.isStrictEqual
- Defined in foundation/math/IVector.ts:559

isTheSourceSame

isTheSourceSame(arrayBuffer): boolean
Checks if this vector shares the same source array buffer.
Parameters
- arrayBuffer: ArrayBuffer
  The array buffer to check
Returns boolean
True if using the same source buffer
Inherited from IVector.isTheSourceSame
- Defined in foundation/math/IVector.ts:110

length

length(): number
Calculates vector length.

Returns number
Vector magnitude
Overrides IVector.length
- Defined in foundation/math/IVector.ts:572

lengthSquared

lengthSquared(): number
Calculates squared length.

Returns number
Squared magnitude
Overrides IVector.lengthSquared
- Defined in foundation/math/IVector.ts:578

lengthTo

lengthTo(vec): number
Calculates distance to another Vector3.
Parameters
- vec: IVector3
  Target vector
Returns number
Distance
Overrides IVector.lengthTo
- Defined in foundation/math/IVector.ts:585

toString

toString(): string
Returns a string representation of the vector.

Returns string
String representation
Overrides IVector.toString
- Defined in foundation/math/IVector.ts:526

toStringApproximately

toStringApproximately(): string
Returns an approximate string representation with rounded values.

Returns string
Approximate string representation
Overrides IVector.toStringApproximately
- Defined in foundation/math/IVector.ts:532

v

v(i): number
Gets the component value at the specified index (alias for at).
Parameters
- i: number
  The component index
Returns number
The component value
Inherited from IVector.v
- Defined in foundation/math/IVector.ts:77

Interface IVector3

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

Readonly_v

ReadonlybytesPerComponent

ReadonlyclassName

ReadonlyglslStrAsFloat

ReadonlyglslStrAsInt

Readonlyw

ReadonlywgslStrAsFloat

ReadonlywgslStrAsInt

Readonlyx

Readonlyy

Readonlyz

Methods

at

Parameters

Returns number

clone

Returns IVector3

dot

Parameters

Returns number

flattenAsArray

Returns number[]

isDummy

Returns boolean

isEqual

Parameters

Returns boolean

isStrictEqual

Parameters

Returns boolean

isTheSourceSame

Parameters

Returns boolean

length

Returns number

lengthSquared

Returns number

lengthTo

Parameters

Returns number

toString

Returns string

toStringApproximately

Returns string

v

Parameters

Returns number

Settings

On This Page

`Readonly`_v

`Readonly`bytesPerComponent

`Readonly`className

`Readonly`glslStrAsFloat

`Readonly`glslStrAsInt

`Readonly`w

`Readonly`wgslStrAsFloat

`Readonly`wgslStrAsInt

`Readonly`x

`Readonly`y

`Readonly`z