Class Scale3D

Hierarchy (View Summary)

Vector3
- Scale3D

Constructors

constructor

new Scale3D(x?: number, y?: number, z?: number): Scale3D
Parameters
- x: number = 1
- y: number = 1
- z: number = 1
Returns Scale3D
Overrides Vector3.constructor
- Defined in src/transform/components/3d/scale.js:4

Properties

x

x: number

y

y: number

z

z: number

`Static` `Readonly`NegX

NegX: Vector3 = ...

Unit vector pointing in the negative x-axis.

`Static` `Readonly`NegY

NegY: Vector3 = ...

Unit vector pointing in the negative y-axis.

`Static` `Readonly`NegZ

NegZ: Vector3 = ...

Unit vector pointing in the negative z-axis.

`Static` `Readonly`X

X: Vector3 = ...

Unit vector pointing in the x-axis.

`Static` `Readonly`Y

Y: Vector3 = ...

Unit vector pointing in the y-axis.

`Static` `Readonly`Z

Z: Vector3 = ...

Unit vector pointing in the z-axis.

`Static` `Readonly`Zero

Zero: Vector3 = ...

A vector whose x and y values will remain 0.

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
Yields
Inherited from Vector3.[iterator]
- Defined in src/math/core/vectors/float/vector3.js:581

add

add(v: Vector3): Scale3D
Adds a given vector into this.
Parameters
- v: Vector3
Returns Scale3D
Inherited from Vector3.add
- Defined in src/math/core/vectors/float/vector3.js:117

addScalar

addScalar(n: number): Scale3D
Adds a scalar value into this vector's component values.
Parameters
- n: number
Returns Scale3D
Inherited from Vector3.addScalar
- Defined in src/math/core/vectors/float/vector3.js:128

clone

clone(): Vector3
Returns a copy of this.

Returns Vector3
Inherited from Vector3.clone
- Defined in src/math/core/vectors/float/vector3.js:39

copy

copy(v: Vector3): Scale3D
Copies values of another vector to this vector.
Parameters
- v: Vector3
Returns Scale3D
Inherited from Vector3.copy
- Defined in src/math/core/vectors/float/vector3.js:29

cross

cross(v: Vector3): Vector3
Calculates the cross product of this with another vector.
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.cross
- Defined in src/math/core/vectors/float/vector3.js:218

distanceTo

distanceTo(v: Vector3): number
Returns the distance between this vector and another vector.
Parameters
- v: Vector3
  The other vector.
Returns number
Inherited from Vector3.distanceTo
- Defined in src/math/core/vectors/float/vector3.js:76

distanceToSquared

distanceToSquared(v: Vector3): number
Returns the squared distance between this vector and another vector.
Parameters
- v: Vector3
  The other vector.
Returns number
Inherited from Vector3.distanceToSquared
- Defined in src/math/core/vectors/float/vector3.js:86

divide

divide(v: Vector3): Scale3D
Divides this vector with a scalar.
Parameters
- v: Vector3
Returns Scale3D
Inherited from Vector3.divide
- Defined in src/math/core/vectors/float/vector3.js:186

divideScalar

divideScalar(s: number): Scale3D
Parameters
- s: number
Returns Scale3D
Inherited from Vector3.divideScalar
- Defined in src/math/core/vectors/float/vector3.js:196

dot

dot(v: Vector3): number
Calculates the dot product of this with another vector.
Parameters
- v: Vector3
Returns number
Inherited from Vector3.dot
- Defined in src/math/core/vectors/float/vector3.js:208

equals

equals(v: Vector3): boolean
Checks to see if this vector is equal to another vector.
Parameters
- v: Vector3
Returns boolean
Inherited from Vector3.equals
- Defined in src/math/core/vectors/float/vector3.js:250

invert

invert(): Scale3D
Returns Scale3D
Inherited from Vector3.invert
- Defined in src/math/core/vectors/float/vector3.js:238

magnitude

magnitude(): number
Returns length of this vector.

Returns number
Inherited from Vector3.magnitude
- Defined in src/math/core/vectors/float/vector3.js:67

magnitudeSquared

magnitudeSquared(): number
Returns the length squared of this vector.

Returns number
Inherited from Vector3.magnitudeSquared
- Defined in src/math/core/vectors/float/vector3.js:58

multiply

multiply(v: Vector3): Scale3D
Multiplies this vector with a given vector.
Parameters
- v: Vector3
Returns Scale3D
Inherited from Vector3.multiply
- Defined in src/math/core/vectors/float/vector3.js:163

multiplyScalar

multiplyScalar(s: number): Scale3D
Multiplies a scalar value with this vector's component values.
Parameters
- s: number
Returns Scale3D
Inherited from Vector3.multiplyScalar
- Defined in src/math/core/vectors/float/vector3.js:174

normalize

normalize(): Scale3D
Makes this a unit vector.

Returns Scale3D
Inherited from Vector3.normalize
- Defined in src/math/core/vectors/float/vector3.js:94

reverse

reverse(): Scale3D
Negates the values of this vector.

Returns Scale3D
Inherited from Vector3.reverse
- Defined in src/math/core/vectors/float/vector3.js:229

set

set(x: number, y: number, z: number): Scale3D
Sets x,y and z values of this vector to the given parameter.
Parameters
- x: number
- y: number
- z: number
Returns Scale3D
Inherited from Vector3.set
- Defined in src/math/core/vectors/float/vector3.js:17

setMagnitude

setMagnitude(length: number): Scale3D
Sets this vector to have the given length.
Parameters
- length: number
Returns Scale3D
Inherited from Vector3.setMagnitude
- Defined in src/math/core/vectors/float/vector3.js:105

splat

splat(scalar: number): Scale3D
Parameters
- scalar: number
Returns Scale3D
Inherited from Vector3.splat
- Defined in src/math/core/vectors/float/vector3.js:47

subtract

subtract(v: Vector3): Scale3D
Subtracts a given vector from this vector.
Parameters
- v: Vector3
Returns Scale3D
Inherited from Vector3.subtract
- Defined in src/math/core/vectors/float/vector3.js:140

subtractScalar

subtractScalar(n: number): Scale3D
Subtracts a scalar value from this vector's component values.
Parameters
- n: number
Returns Scale3D
Inherited from Vector3.subtractScalar
- Defined in src/math/core/vectors/float/vector3.js:152

`Static`add

add(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.add
- Defined in src/math/core/vectors/float/vector3.js:370

`Static`addScalar

addScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.addScalar
- Defined in src/math/core/vectors/float/vector3.js:383

`Static`angleBetween

angleBetween(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.angleBetween
- Defined in src/math/core/vectors/float/vector3.js:550

`Static`clampMagnitude

clampMagnitude(v: Vector3, min: number, max: number, out?: Vector3): Vector3
Parameters
- v: Vector3
- min: number
- max: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.clampMagnitude
- Defined in src/math/core/vectors/float/vector3.js:356

`Static`copy

copy(v1: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.copy
- Defined in src/math/core/vectors/float/vector3.js:272

`Static`cross

cross(a: Vector3, b: Vector3, out?: Vector3): Vector3
Parameters
- a: Vector3
- b: Vector3
- Optionalout: Vector3 = ...
Returns Vector3
Inherited from Vector3.cross
- Defined in src/math/core/vectors/float/vector3.js:502

`Static`distanceTo

distanceTo(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.distanceTo
- Defined in src/math/core/vectors/float/vector3.js:322

`Static`distanceToSquared

distanceToSquared(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.distanceToSquared
- Defined in src/math/core/vectors/float/vector3.js:310

`Static`divide

divide(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.divide
- Defined in src/math/core/vectors/float/vector3.js:448

`Static`divideScalar

divideScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.divideScalar
- Defined in src/math/core/vectors/float/vector3.js:461

`Static`dot

dot(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.dot
- Defined in src/math/core/vectors/float/vector3.js:493

`Static`equal

equal(v1: Vector3, v2: Vector3): boolean
Parameters
- v1: Vector3
- v2: Vector3
Returns boolean
Inherited from Vector3.equal
- Defined in src/math/core/vectors/float/vector3.js:558

`Static`invert

invert(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.invert
- Defined in src/math/core/vectors/float/vector3.js:481

`Static`lerp

lerp(from: Vector3, to: Vector3, t: number, out?: Vector3): Vector3
Parameters
- from: Vector3
- to: Vector3
- t: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.lerp
- Defined in src/math/core/vectors/float/vector3.js:523

`Static`magnitude

magnitude(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.magnitude
- Defined in src/math/core/vectors/float/vector3.js:302

`Static`magnitudeSquared

magnitudeSquared(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.magnitudeSquared
- Defined in src/math/core/vectors/float/vector3.js:295

`Static`multiply

multiply(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.multiply
- Defined in src/math/core/vectors/float/vector3.js:422

`Static`multiplyScalar

multiplyScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.multiplyScalar
- Defined in src/math/core/vectors/float/vector3.js:435

`Static`set

set(x: number, y: number, z: number, out?: Vector3): Vector3
Parameters
- x: number
- y: number
- z: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.set
- Defined in src/math/core/vectors/float/vector3.js:260

`Static`setMagnitude

setMagnitude(v: Vector3, length: number, out?: Vector3): Vector3
Parameters
- v: Vector3
- length: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.setMagnitude
- Defined in src/math/core/vectors/float/vector3.js:343

`Static`splat

splat(scalar: number, out?: Vector3): Vector3
Parameters
- scalar: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.splat
- Defined in src/math/core/vectors/float/vector3.js:284

`Static`subtract

subtract(from: Vector3, to: Vector3, out?: Vector3): Vector3
Parameters
- from: Vector3
- to: Vector3
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.subtract
- Defined in src/math/core/vectors/float/vector3.js:396

`Static`subtractScalar

subtractScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
Inherited from Vector3.subtractScalar
- Defined in src/math/core/vectors/float/vector3.js:409

Class Scale3D

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Scale3D

Properties

x

y

z

Static ReadonlyNegX

Static ReadonlyNegY

Static ReadonlyNegZ

Static ReadonlyX

Static ReadonlyY

Static ReadonlyZ

Static ReadonlyZero

Methods

[iterator]

Returns Generator<number, void, unknown>

Yields

add

Parameters

Returns Scale3D

addScalar

Parameters

Returns Scale3D

clone

Returns Vector3

copy

Parameters

Returns Scale3D

cross

Parameters

Returns Vector3

distanceTo

Parameters

Returns number

distanceToSquared

Parameters

Returns number

divide

Parameters

Returns Scale3D

divideScalar

Parameters

Returns Scale3D

dot

Parameters

Returns number

equals

Parameters

Returns boolean

invert

Returns Scale3D

magnitude

Returns number

magnitudeSquared

Returns number

multiply

Parameters

Returns Scale3D

multiplyScalar

Parameters

Returns Scale3D

normalize

Returns Scale3D

reverse

Returns Scale3D

set

Parameters

Returns Scale3D

setMagnitude

Parameters

Returns Scale3D

splat

`Static` `Readonly`NegX

`Static` `Readonly`NegY

`Static` `Readonly`NegZ

`Static` `Readonly`X

`Static` `Readonly`Y

`Static` `Readonly`Z

`Static` `Readonly`Zero

`Static`add

`Static`addScalar

`Static`angleBetween

`Static`clampMagnitude

`Static`copy

`Static`cross

`Static`distanceTo

`Static`distanceToSquared

`Static`divide

`Static`divideScalar

`Static`dot

`Static`equal

`Static`invert

`Static`lerp

`Static`magnitude

`Static`magnitudeSquared

`Static`multiply

`Static`multiplyScalar

`Static`normalize

`Static`random

`Static`reflect