Class Vec3

Contains a description of a vector.

Implements

Vector3

Index

Constructors

Properties

Accessors

Methods

step step withY withY abs abs add add subtract subtract multiply multiply equals equals scale scale normal normal mag mag magSqr magSqr distance distance dot dot cross cross lerp lerp floor rotateY rotateY round round floor min min max max center center flip reflect clone toString toString unwrap convert fromAngles fromDirection addX addY addZ setX setY setZ length normalize clean isValid isValidRaw subtractV3 asVector3 random asRotation asYawPitch rotateYaw asString toGrid toGridSelf asVolume asVolumeSized offset addVolume addSelf multiplyY map mapSelf subtractSelf scaleSelf multiplySelf normalizeSelf addYSelf setYSelf setSelf setXYZSelf lerpSelf getCenterOf getCenterOfVolume getCenterOfXY asString fromString volumeAsString splat flat x y z isGreater isGreater isLess isLess isGreaterOrEqual isGreaterOrEqual isLessOrEqual isLessOrEqual isInside isInside

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/wrappers/vec3.ts:15
new Vec3(x: number, y: number, z: number): Vec3
Parameters
- x: number
- y: number
- z: number
Returns Vec3
- Defined in src/wrappers/vec3.ts:16
new Vec3(v: number[]): Vec3
Parameters
- v: number[]
Returns Vec3
- Defined in src/wrappers/vec3.ts:17

Properties

x

x: number

Remarks

X component of this vector.

y

y: number

Remarks

Y component of this vector.

z

z: number

Remarks

Z component of this vector.

`Static`zero

zero: Vec3 = ...

Accessors

`Static`down

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

Methods

`Static`step

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

step

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

`Static`withY

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

withY

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

`Static`abs

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

abs

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

`Static`add

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

add

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

`Static`subtract

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

subtract

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

`Static`multiply

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

multiply

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

`Static`equals

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

equals

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

`Static`scale

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

scale

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

`Static`normal

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

normal

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

`Static`mag

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

mag

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

`Static`magSqr

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

magSqr

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

`Static`distance

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

distance

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

`Static`dot

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

dot

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

`Static`cross

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

cross

cross(v: Vector3): Vec3
Parameters
- v: Vector3
Returns Vec3
- Defined in src/wrappers/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/wrappers/vec3.ts:215

lerp

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

`Static`floor

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

`Static`rotateY

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

rotateY

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

round

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

`Static`round

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

floor

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

`Static`min

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

min

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

`Static`max

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

max

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

center

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

`Static`center

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

flip

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

reflect

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

clone

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

`Static`toString

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

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in src/wrappers/vec3.ts:291

unwrap

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

`Static`convert

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

`Static`fromAngles

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

`Static`fromDirection

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

addX

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

addY

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

addZ

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

setX

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

setY

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

setZ

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

length

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

normalize

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

clean

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

isValid

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

`Static`isValidRaw

isValidRaw(vec: any): boolean
Parameters
- vec: any
Returns boolean
- Defined in src/wrappers/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/wrappers/vec3.ts:379

asVector3

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

`Static`random

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

asRotation

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

asYawPitch

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

rotateYaw

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

asString

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

toGrid

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

toGridSelf

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

asVolume

asVolume(size: number): { min: Vec3; max: Vec3 }
Parameters
- size: number
Returns { min: Vec3; max: Vec3 }
- Defined in src/wrappers/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/wrappers/vec3.ts:447

offset

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

addVolume

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

addSelf

addSelf(v: Vector3): this
Parameters
- v: Vector3
Returns this
- Defined in src/wrappers/vec3.ts:462
addSelf(x: number, y: number, z: number): this
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in src/wrappers/vec3.ts:463

multiplyY

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

map

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

mapSelf

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

subtractSelf

subtractSelf(v: Vector3): this
Parameters
- v: Vector3
Returns this
- Defined in src/wrappers/vec3.ts:492

scaleSelf

scaleSelf(s: number): this
Parameters
- s: number
Returns this
- Defined in src/wrappers/vec3.ts:499

multiplySelf

multiplySelf(v: Vector3): this
Parameters
- v: Vector3
Returns this
- Defined in src/wrappers/vec3.ts:506
multiplySelf(s: number): this
Parameters
- s: number
Returns this
- Defined in src/wrappers/vec3.ts:507

normalizeSelf

normalizeSelf(): this
Returns this
- Defined in src/wrappers/vec3.ts:521

addYSelf

addYSelf(y: number): this
Parameters
- y: number
Returns this
- Defined in src/wrappers/vec3.ts:535

setYSelf

setYSelf(y: number): this
Parameters
- y: number
Returns this
- Defined in src/wrappers/vec3.ts:540

setSelf

setSelf(v: Vector3): this
Parameters
- v: Vector3
Returns this
- Defined in src/wrappers/vec3.ts:545

setXYZSelf

setXYZSelf(x: number, y: number, z: number): this
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in src/wrappers/vec3.ts:552

lerpSelf

lerpSelf(v: Vec3, alpha: number): this
Parameters
- v: Vec3
- alpha: number
Returns this
- Defined in src/wrappers/vec3.ts:559

`Static`getCenterOf

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

`Static`getCenterOfVolume

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

`Static`getCenterOfXY

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

`Static`asString

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

`Static`fromString

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

`Static`volumeAsString

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

`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/wrappers/vec3.ts:596

`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/wrappers/vec3.ts:605

`Static`x

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

`Static`y

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

`Static`z

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

`Static`isGreater

isGreater(lhs: Vector3, rhs: Vector3): boolean
Parameters
- lhs: Vector3
- rhs: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:621

isGreater

isGreater(other: Vector3): boolean
Parameters
- other: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:625

`Static`isLess

isLess(lhs: Vector3, rhs: Vector3): boolean
Parameters
- lhs: Vector3
- rhs: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:629

isLess

isLess(other: Vector3): boolean
Parameters
- other: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:633

`Static`isGreaterOrEqual

isGreaterOrEqual(lhs: Vector3, rhs: Vector3): boolean
Parameters
- lhs: Vector3
- rhs: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:637

isGreaterOrEqual

isGreaterOrEqual(other: Vector3): boolean
Parameters
- other: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:641

`Static`isLessOrEqual

isLessOrEqual(lhs: Vector3, rhs: Vector3): boolean
Parameters
- lhs: Vector3
- rhs: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:645

isLessOrEqual

isLessOrEqual(other: Vector3): boolean
Parameters
- other: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:649

`Static`isInside

isInside(vec: Vector3, from: Vector3, to: Vector3): boolean
Parameters
- vec: Vector3
- from: Vector3
- to: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:653

isInside

isInside(from: Vector3, to: Vector3): boolean
Parameters
- from: Vector3
- to: Vector3
Returns boolean
- Defined in src/wrappers/vec3.ts:660