Class Vec3

Constructors

constructor

new Vec3(v: { x: number; y: number; z: number }): Vec3
Parameters
- v: { x: number; y: number; z: number }
Returns Vec3
- Defined in src/vec3.ts:15
new Vec3(x: number, y: number, z: number): Vec3
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in src/vec3.ts:16
new Vec3(v: number[]): Vec3
Parameters
- v: number[]
Returns Vec3
- Defined in src/vec3.ts:17

Properties

x

x: number

y

y: number

z

z: number

`Static`zero

zero: Vec3 = ...

Accessors

`Static`down

get down(): Vec3
Returns Vec3
- Defined in src/vec3.ts:303

Methods

`Static`step

step(v: Vec3 | Vector3, dir: Direction, amount?: number): Vec3
Parameters
- v: Vec3 | Vector3
- dir: Direction
- amount: number = 1
Returns Vec3
- Defined in src/vec3.ts:68

step

step(dir: Direction, amount?: number): Vec3
Parameters
- dir: Direction
- amount: number = 1
Returns Vec3
- Defined in src/vec3.ts:85

`Static`withY

withY(v33: Vec3 | Vector3, value: number): Vec3
Parameters
- v33: Vec3 | Vector3
- value: number
Returns Vec3
- Defined in src/vec3.ts:102

withY

withY(value: number): Vec3
Parameters
- value: number
Returns Vec3
- Defined in src/vec3.ts:106

`Static`abs

abs(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:110

abs

abs(): Vec3
Returns Vec3
- Defined in src/vec3.ts:114

`Static`add

add(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:118

add

add(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:122

`Static`subtract

subtract(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:126

subtract

subtract(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:130

`Static`multiply

multiply(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:134

multiply

multiply(v: number): Vec3
Parameters
- v: number
Returns Vec3
- Defined in src/vec3.ts:138
multiply(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:139

`Static`equals

equals(v1: Vec3 | Vector3, v2: Vec3 | Vector3): boolean
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns boolean
- Defined in src/vec3.ts:149

equals

equals(v: Vec3 | Vector3): boolean
Parameters
- v: Vec3 | Vector3
Returns boolean
- Defined in src/vec3.ts:153

`Static`scale

scale(v: Vec3 | Vector3, scalar: number): Vec3
Parameters
- v: Vec3 | Vector3
- scalar: number
Returns Vec3
- Defined in src/vec3.ts:157

scale

scale(scalar: number): Vec3
Parameters
- scalar: number
Returns Vec3
- Defined in src/vec3.ts:161

`Static`normal

normal(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:165

normal

normal(): Vec3
Returns Vec3
- Defined in src/vec3.ts:170

`Static`mag

mag(v: Vec3 | Vector3): number
Parameters
- v: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:175

mag

mag(): number
Returns number
- Defined in src/vec3.ts:179

`Static`magSqr

magSqr(v: Vec3 | Vector3): number
Parameters
- v: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:183

magSqr

magSqr(): number
Returns number
- Defined in src/vec3.ts:187

`Static`distance

distance(v1: Vec3 | Vector3, v2: Vec3 | Vector3): number
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:191

distance

distance(v: Vec3 | Vector3): number
Parameters
- v: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:195

`Static`dot

dot(v1: Vec3 | Vector3, v2: Vec3 | Vector3): number
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:199

dot

dot(v: Vec3 | Vector3): number
Parameters
- v: Vec3 | Vector3
Returns number
- Defined in src/vec3.ts:203

`Static`cross

cross(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:207

cross

cross(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:211

`Static`lerp

lerp(v1: Vec3, v2: Vec3, alpha: number): Vec3
Parameters
- v1: Vec3
- v2: Vec3
- alpha: number
Returns Vec3
- Defined in src/vec3.ts:215

lerp

lerp(v: Vec3, alpha: number): Vec3
Parameters
- v: Vec3
- alpha: number
Returns Vec3
- Defined in src/vec3.ts:219

`Static`floor

floor(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:223

`Static`rotateY

rotateY(v: Vec3 | Vector3, angle: number): Vec3
Parameters
- v: Vec3 | Vector3
- angle: number
Returns Vec3
- Defined in src/vec3.ts:227

rotateY

rotateY(angle: number): Vec3
Parameters
- angle: number
Returns Vec3
- Defined in src/vec3.ts:233

round

round(): Vec3
Returns Vec3
- Defined in src/vec3.ts:239

`Static`round

round(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:243

floor

floor(): Vec3
Returns Vec3
- Defined in src/vec3.ts:247

`Static`min

min(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:251

min

min(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:255

`Static`max

max(v1: Vec3 | Vector3, v2: Vec3 | Vector3): Vec3
Parameters
- v1: Vec3 | Vector3
- v2: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:259

max

max(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:263

center

center(): Vec3
Returns Vec3
- Defined in src/vec3.ts:267

`Static`center

center(v: Vec3 | Vector3): Vec3
Parameters
- v: Vec3 | Vector3
Returns Vec3
- Defined in src/vec3.ts:271

flip

flip(): Vec3
Returns Vec3
- Defined in src/vec3.ts:275

reflect

reflect(): Vec3
Returns Vec3
- Defined in src/vec3.ts:279

clone

clone(): Vec3
Returns Vec3
- Defined in src/vec3.ts:283

`Static`toString

toString(vec: Vec3 | Vector3): string
Parameters
- vec: Vec3 | Vector3
Returns string
- Defined in src/vec3.ts:287

toString

toString(): string
Returns string
- Defined in src/vec3.ts:291

unwrap

unwrap(): { x: number; y: number; z: number }
Returns { x: number; y: number; z: number }
- Defined in src/vec3.ts:295

`Static`convert

convert(vec: Vector3): Vec3
Parameters
- vec: Vector3
Returns Vec3
- Defined in src/vec3.ts:299

`Static`fromAngles

fromAngles(pitch: number, yaw: number): Vec3
Parameters
- pitch: number
- yaw: number
Returns Vec3
- Defined in src/vec3.ts:307

`Static`fromDirection

fromDirection(direction: Direction): Vec3
Parameters
- direction: Direction
Returns Vec3
- Defined in src/vec3.ts:311

addX

addX(x: number): Vec3
Parameters
- x: number
Returns Vec3
- Defined in src/vec3.ts:330

addY

addY(y: number): Vec3
Parameters
- y: number
Returns Vec3
- Defined in src/vec3.ts:334

addZ

addZ(z: number): Vec3
Parameters
- z: number
Returns Vec3
- Defined in src/vec3.ts:338

setX

setX(x: number): Vec3
Parameters
- x: number
Returns Vec3
- Defined in src/vec3.ts:342

setY

setY(y: number): Vec3
Parameters
- y: number
Returns Vec3
- Defined in src/vec3.ts:346

setZ

setZ(z: number): Vec3
Parameters
- z: number
Returns Vec3
- Defined in src/vec3.ts:350

length

length(): number
Returns number
- Defined in src/vec3.ts:354

normalize

normalize(): Vec3
Returns Vec3
- Defined in src/vec3.ts:358

clean

clean(): Vec3
Returns Vec3
- Defined in src/vec3.ts:364

isValid

isValid(): boolean
Returns boolean
- Defined in src/vec3.ts:371

`Static`isValidRaw

isValidRaw(vec: any): boolean
Parameters
- vec: any
Returns boolean
- Defined in src/vec3.ts:375

subtractV3

subtractV3(other: { x: number; y: number; z: number }): Vec3
Parameters
- other: { x: number; y: number; z: number }
Returns Vec3
- Defined in src/vec3.ts:379

asVector3

asVector3(): { x: number; y: number; z: number }
Returns { x: number; y: number; z: number }
- Defined in src/vec3.ts:383

`Static`random

random(min: number, max: number): Vec3
Parameters
- min: number
- max: number
Returns Vec3
- Defined in src/vec3.ts:391

asRotation

asRotation(): { pitch: number; yaw: number }
Returns { pitch: number; yaw: number }
- Defined in src/vec3.ts:398

asYawPitch

asYawPitch(): { yaw: number; pitch: number }
Returns { yaw: number; pitch: number }
- Defined in src/vec3.ts:408

rotateYaw

rotateYaw(theta: number): Vec3
Parameters
- theta: number
Returns Vec3
- Defined in src/vec3.ts:417

asString

asString(): string
Returns string
- Defined in src/vec3.ts:425

toGrid

toGrid(): Vec3
Returns Vec3
- Defined in src/vec3.ts:429

toGridSelf

toGridSelf(): Vec3
Returns Vec3
- Defined in src/vec3.ts:433

asVolume

asVolume(size: number): { min: Vec3; max: Vec3 }
Parameters
- size: number
Returns { min: Vec3; max: Vec3 }
- Defined in src/vec3.ts:440

asVolumeSized

asVolumeSized(
    xSize: number,
    ySize: number,
    zSize: number,
): { min: Vec3; max: Vec3 }
Parameters
- xSize: number
- ySize: number
- zSize: number
Returns { min: Vec3; max: Vec3 }
- Defined in src/vec3.ts:447

offset

offset(n: number): Vec3
Parameters
- n: number
Returns Vec3
- Defined in src/vec3.ts:454

addVolume

addVolume(x: number, y: number, z: number): Vec3
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in src/vec3.ts:458

addSelf

addSelf(x: number, y: number, z: number): Vec3
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in src/vec3.ts:462

multiplyY

multiplyY(y: number): Vec3
Parameters
- y: number
Returns Vec3
- Defined in src/vec3.ts:469

map

map(fn: (n: number, i: number) => number): Vec3
Parameters
- fn: (n: number, i: number) => number
Returns Vec3
- Defined in src/vec3.ts:473

mapSelf

mapSelf(fn: (n: number, i: number) => number): Vec3
Parameters
- fn: (n: number, i: number) => number
Returns Vec3
- Defined in src/vec3.ts:477

`Static`getCenterOf

getCenterOf(a: Vec3, b: Vec3): Vec3
Parameters
- a: Vec3
- b: Vec3
Returns Vec3
- Defined in src/vec3.ts:484

`Static`getCenterOfVolume

getCenterOfVolume(volume: { min: Vec3; max: Vec3 }): Vec3
Parameters
- volume: { min: Vec3; max: Vec3 }
Returns Vec3
- Defined in src/vec3.ts:488

`Static`getCenterOfXY

getCenterOfXY(a: Vec3, b: Vec3): Vec3
Parameters
- a: Vec3
- b: Vec3
Returns Vec3
- Defined in src/vec3.ts:492

`Static`asString

asString(vec: Vec3): string
Parameters
- vec: Vec3
Returns string
- Defined in src/vec3.ts:496

`Static`fromString

fromString(str: string): Vec3
Parameters
- str: string
Returns Vec3
- Defined in src/vec3.ts:500

`Static`volumeAsString

volumeAsString(volume: { min: Vec3; max: Vec3 }): string
Parameters
- volume: { min: Vec3; max: Vec3 }
Returns string
- Defined in src/vec3.ts:505

`Static`splat

splat(v: number): Vec3
Creates a Vec3 with all components set to the input value.

Equivalent to new Vec3(v, v, v)
Parameters
- v: number
Returns Vec3
- Defined in src/vec3.ts:514

`Static`flat

flat(v: number): Vec3
Creates a new Vec3 with the horizontal components set to the input value, and the vertical component to 0.

Equivalent to new Vec3(v, 0, v)
Parameters
- v: number
Returns Vec3
- Defined in src/vec3.ts:523

`Static`x

x(x: number): Vec3
Parameters
- x: number
Returns Vec3
- Defined in src/vec3.ts:527

`Static`y

y(y: number): Vec3
Parameters
- y: number
Returns Vec3
- Defined in src/vec3.ts:531

`Static`z

z(z: number): Vec3
Parameters
- z: number
Returns Vec3
- Defined in src/vec3.ts:535