Class DimVec3

x

y

z

Staticzero

Staticdown

• get down(): Vec3

  Returns Vec3

Staticstep

• step(v: Vector3, dir: Direction, amount?: number): Vec3

  Parameters

  • v: Vector3
  • dir: Direction
  • amount: number = 1

  Returns Vec3

step

• step(dir: Direction, amount?: number): Vec3

  Parameters

  • dir: Direction
  • amount: number = 1

  Returns Vec3

StaticwithY

• withY(v33: Vector3, value: number): Vec3

  Parameters

  • v33: Vector3
  • value: number

  Returns Vec3

withY

• withY(value: number): Vec3

  Parameters

  • value: number

  Returns Vec3

Staticabs

• abs(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

abs

• abs(): Vec3

  Returns Vec3

Staticadd

• add(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

add

• add(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

Staticsubtract

• subtract(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

subtract

• subtract(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

Staticmultiply

• multiply(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

Staticdivide

• divide(lhs: Vector3, rhs: Vector3): Vec3

  Parameters

  • lhs: Vector3
  • rhs: Vector3

  Returns Vec3

multiply

• multiply(v: number): Vec3

  Parameters

  • v: number

  Returns Vec3

• multiply(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

Staticscale

• scale(v: Vector3, scalar: number): Vec3

  Parameters

  • v: Vector3
  • scalar: number

  Returns Vec3

scale

• scale(scalar: number): Vec3

  Parameters

  • scalar: number

  Returns Vec3

Staticnormal

• normal(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

normal

• normal(): Vec3

  Returns Vec3

Staticmag

• mag(v: Vector3): number

  Parameters

  • v: Vector3

  Returns number

mag

• mag(): number

  Returns number

StaticmagSqr

• magSqr(v: Vector3): number

  Parameters

  • v: Vector3

  Returns number

magSqr

• magSqr(): number

  Returns number

Staticdistance

• distance(v1: Vector3, v2: Vector3): number

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns number

distance

• distance(v: Vector3): number

  Parameters

  • v: Vector3

  Returns number

Staticdot

• dot(v1: Vector3, v2: Vector3): number

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns number

dot

• dot(v: Vector3): number

  Parameters

  • v: Vector3

  Returns number

Staticcross

• cross(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

cross

• cross(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

Staticlerp

• lerp(v1: Vec3, v2: Vec3, alpha: number): Vec3

  Parameters

  • v1: Vec3
  • v2: Vec3
  • alpha: number

  Returns Vec3

lerp

• lerp(v: Vec3, alpha: number): Vec3

  Parameters

  • v: Vec3
  • alpha: number

  Returns Vec3

Staticfloor

• floor(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

StaticrotateY

• rotateY(v: Vector3, angle: number): Vec3

  Parameters

  • v: Vector3
  • angle: number

  Returns Vec3

rotateY

• rotateY(angle: number): Vec3

  Parameters

  • angle: number

  Returns Vec3

round

• round(): Vec3

  Returns Vec3

Staticround

• round(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

floor

• floor(): Vec3

  Returns Vec3

Staticmin

• min(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

min

• min(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

Staticmax

• max(v1: Vector3, v2: Vector3): Vec3

  Parameters

  • v1: Vector3
  • v2: Vector3

  Returns Vec3

max

• max(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

center

• center(): Vec3

  Returns Vec3

Staticcenter

• center(v: Vector3): Vec3

  Parameters

  • v: Vector3

  Returns Vec3

flip

• flip(): Vec3

  Returns Vec3

reflect

• reflect(): Vec3

  Returns Vec3

clone

• clone(): Vec3

  Returns Vec3

StatictoString

• toString(vec: Vec3 | Vector3): string

  Parameters

  • vec: Vec3 | Vector3

  Returns string

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

unwrap

• unwrap(): { x: number; y: number; z: number }

  Returns { x: number; y: number; z: number }

Staticconvert

• convert(vec: Vector3): Vec3

  Parameters

  • vec: Vector3

  Returns Vec3

StaticfromAngles

• fromAngles(pitch: number, yaw: number): Vec3

  Parameters

  • pitch: number
  • yaw: number

  Returns Vec3

StaticfromDirection

• fromDirection(direction: Direction): Vec3

  Parameters

  • direction: Direction

  Returns Vec3

addX

• addX(x: number): Vec3

  Parameters

  • x: number

  Returns Vec3

addY

• addY(y: number): Vec3

  Parameters

  • y: number

  Returns Vec3

addZ

• addZ(z: number): Vec3

  Parameters

  • z: number

  Returns Vec3

setX

• setX(x: number): Vec3

  Parameters

  • x: number

  Returns Vec3

setY

• setY(y: number): Vec3

  Parameters

  • y: number

  Returns Vec3

setZ

• setZ(z: number): Vec3

  Parameters

  • z: number

  Returns Vec3

length

• length(): number

  Returns number

normalize

• normalize(): Vec3

  Returns Vec3

clean

• clean(): Vec3

  Returns Vec3

isValid

• isValid(): boolean

  Returns boolean

StaticisValidRaw

• isValidRaw(vec: any): boolean

  Parameters

  • vec: any

  Returns boolean

subtractV3

• subtractV3(other: { x: number; y: number; z: number }): Vec3

  Parameters

  • other: { x: number; y: number; z: number }

  Returns Vec3

asVector3

• asVector3(): { x: number; y: number; z: number }

  Returns { x: number; y: number; z: number }

Staticrandom

• random(min: number, max: number): Vec3

  Parameters

  • min: number
  • max: number

  Returns Vec3

asRotation

• asRotation(): { pitch: number; yaw: number }

  Returns { pitch: number; yaw: number }

asYawPitch

• asYawPitch(): { yaw: number; pitch: number }

  Returns { yaw: number; pitch: number }

rotateYaw

• rotateYaw(theta: number): Vec3

  Parameters

  • theta: number

  Returns Vec3

asString

• asString(): string

  Returns string

toGrid

• toGrid(): Vec3

  Returns Vec3

toGridSelf

• toGridSelf(): Vec3

  Returns Vec3

asVolume

• asVolume(size: number): { min: Vec3; max: Vec3 }

  Parameters

  • size: number

  Returns { min: Vec3; max: Vec3 }

asVolumeSized

• asVolumeSized(
      xSize: number,
      ySize: number,
      zSize: number,
  ): { min: Vec3; max: Vec3 }

  Parameters

  • xSize: number
  • ySize: number
  • zSize: number

  Returns { min: Vec3; max: Vec3 }

offset

• offset(n: number): Vec3

  Parameters

  • n: number

  Returns Vec3

addVolume

• addVolume(x: number, y: number, z: number): Vec3

  Parameters

  • x: number
  • y: number
  • z: number

  Returns Vec3

addSelf

• addSelf(v: Vector3): this

  Parameters

  • v: Vector3

  Returns this

• addSelf(x: number, y: number, z: number): this

  Parameters

  • x: number
  • y: number
  • z: number

  Returns this

multiplyY

• multiplyY(y: number): Vec3

  Parameters

  • y: number

  Returns Vec3

map

• map(fn: (n: number, i: number) => number): Vec3

  Parameters

  • fn: (n: number, i: number) => number

  Returns Vec3

mapSelf

• mapSelf(fn: (n: number, i: number) => number): Vec3

  Parameters

  • fn: (n: number, i: number) => number

  Returns Vec3

subtractSelf

• subtractSelf(v: Vector3): this

  Parameters

  • v: Vector3

  Returns this

scaleSelf

• scaleSelf(s: number): this

  Parameters

  • s: number

  Returns this

multiplySelf

• multiplySelf(v: Vector3): this

  Parameters

  • v: Vector3

  Returns this

• multiplySelf(s: number): this

  Parameters

  • s: number

  Returns this

normalizeSelf

• normalizeSelf(): this

  Returns this

addYSelf

• addYSelf(y: number): this

  Parameters

  • y: number

  Returns this

setYSelf

• setYSelf(y: number): this

  Parameters

  • y: number

  Returns this

setSelf

• setSelf(v: Vector3): this

  Parameters

  • v: Vector3

  Returns this

setXYZSelf

• setXYZSelf(x: number, y: number, z: number): this

  Parameters

  • x: number
  • y: number
  • z: number

  Returns this

lerpSelf

• lerpSelf(v: Vec3, alpha: number): this

  Parameters

  • v: Vec3
  • alpha: number

  Returns this

StaticgetCenterOf

• getCenterOf(a: Vec3, b: Vec3): Vec3

  Parameters

  • a: Vec3
  • b: Vec3

  Returns Vec3

StaticgetCenterOfVolume

• getCenterOfVolume(volume: { min: Vec3; max: Vec3 }): Vec3

  Parameters

  • volume: { min: Vec3; max: Vec3 }

  Returns Vec3

StaticgetCenterOfXY

• getCenterOfXY(a: Vec3, b: Vec3): Vec3

  Parameters

  • a: Vec3
  • b: Vec3

  Returns Vec3

StaticasString

• asString(vec: Vec3): string

  Parameters

  • vec: Vec3

  Returns string

StaticfromString

• fromString(str: string): Vec3

  Parameters

  • str: string

  Returns Vec3

StaticvolumeAsString

• volumeAsString(volume: { min: Vec3; max: Vec3 }): string

  Parameters

  • volume: { min: Vec3; max: Vec3 }

  Returns string

Staticsplat

• 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

Staticflat

• 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

Staticx

• x(x: number): Vec3

  Parameters

  • x: number

  Returns Vec3

Staticy

• y(y: number): Vec3

  Parameters

  • y: number

  Returns Vec3

Staticz

• z(z: number): Vec3

  Parameters

  • z: number

  Returns Vec3

StaticisGreater

• isGreater(lhs: Vector3, rhs: Vector3): boolean

  Parameters

  • lhs: Vector3
  • rhs: Vector3

  Returns boolean

isGreater

• isGreater(other: Vector3): boolean

  Parameters

  • other: Vector3

  Returns boolean

StaticisLess

• isLess(lhs: Vector3, rhs: Vector3): boolean

  Parameters

  • lhs: Vector3
  • rhs: Vector3

  Returns boolean

isLess

• isLess(other: Vector3): boolean

  Parameters

  • other: Vector3

  Returns boolean

StaticisGreaterOrEqual

• isGreaterOrEqual(lhs: Vector3, rhs: Vector3): boolean

  Parameters

  • lhs: Vector3
  • rhs: Vector3

  Returns boolean

isGreaterOrEqual

• isGreaterOrEqual(other: Vector3): boolean

  Parameters

  • other: Vector3

  Returns boolean

StaticisLessOrEqual

• isLessOrEqual(lhs: Vector3, rhs: Vector3): boolean

  Parameters

  • lhs: Vector3
  • rhs: Vector3

  Returns boolean

isLessOrEqual

• isLessOrEqual(other: Vector3): boolean

  Parameters

  • other: Vector3

  Returns boolean

StaticisInside

• isInside(vec: Vector3, from: Vector3, to: Vector3): boolean

  Parameters

  • vec: Vector3
  • from: Vector3
  • to: Vector3

  Returns boolean

isInside

• isInside(from: Vector3, to: Vector3): boolean

  Parameters

  • from: Vector3
  • to: Vector3

  Returns boolean