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 packages/transform/src/components/3d/scale.js:5

Properties

x

x: number

y

y: number

z

z: number

`Static`NegX

NegX: Vector3

Unit vector pointing in the negative x-axis.

`Static`NegY

NegY: Vector3

Unit vector pointing in the negative y-axis.

`Static`NegZ

NegZ: Vector3

Unit vector pointing in the negative z-axis.

`Static`X

X: Vector3

Unit vector pointing in the x-axis.

`Static`Y

Y: Vector3

Unit vector pointing in the y-axis.

`Static`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]"(): IterableIterator<number>
Returns IterableIterator<number>
Inherited from Vector3.[iterator]
- Defined in node_modules/hisabati/dist/index.d.ts:504

add

add(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.add
- Defined in node_modules/hisabati/dist/index.d.ts:451

addScalar

addScalar(n: number): Vector3
Parameters
- n: number
Returns Vector3
Inherited from Vector3.addScalar
- Defined in node_modules/hisabati/dist/index.d.ts:452

clone

clone(): Vector3
Returns Vector3
Inherited from Vector3.clone
- Defined in node_modules/hisabati/dist/index.d.ts:439

copy

copy(v: Vector3): this
Parameters
- v: Vector3
Returns this
Inherited from Vector3.copy
- Defined in node_modules/hisabati/dist/index.d.ts:438

cross

cross(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.cross
- Defined in node_modules/hisabati/dist/index.d.ts:460

distanceTo

distanceTo(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.distanceTo
- Defined in node_modules/hisabati/dist/index.d.ts:447

distanceToSquared

distanceToSquared(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.distanceToSquared
- Defined in node_modules/hisabati/dist/index.d.ts:448

divide

divide(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.divide
- Defined in node_modules/hisabati/dist/index.d.ts:457

divideScalar

divideScalar(s: number): Vector3
Parameters
- s: number
Returns Vector3
Inherited from Vector3.divideScalar
- Defined in node_modules/hisabati/dist/index.d.ts:458

dot

dot(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.dot
- Defined in node_modules/hisabati/dist/index.d.ts:459

equals

equals(v: Vector3): boolean
Parameters
- v: Vector3
Returns boolean
Inherited from Vector3.equals
- Defined in node_modules/hisabati/dist/index.d.ts:463

invert

invert(): Vector3
Returns Vector3
Inherited from Vector3.invert
- Defined in node_modules/hisabati/dist/index.d.ts:462

magnitude

magnitude(): number
Returns number
Inherited from Vector3.magnitude
- Defined in node_modules/hisabati/dist/index.d.ts:446

magnitudeSquared

magnitudeSquared(): number
Returns number
Inherited from Vector3.magnitudeSquared
- Defined in node_modules/hisabati/dist/index.d.ts:445

multiply

multiply(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.multiply
- Defined in node_modules/hisabati/dist/index.d.ts:455

multiplyScalar

multiplyScalar(s: number): Vector3
Parameters
- s: number
Returns Vector3
Inherited from Vector3.multiplyScalar
- Defined in node_modules/hisabati/dist/index.d.ts:456

normalize

normalize(): Vector3
Returns Vector3
Inherited from Vector3.normalize
- Defined in node_modules/hisabati/dist/index.d.ts:449

reverse

reverse(): Vector3
Returns Vector3
Inherited from Vector3.reverse
- Defined in node_modules/hisabati/dist/index.d.ts:461

serialize

serialize(): Vector3Like
Serializes this vector.

Returns Vector3Like
Inherited from Vector3.serialize
- Defined in node_modules/hisabati/dist/index.d.ts:443

set

set(x: number, y: number, z: number): this
Parameters
- x: number
- y: number
- z: number
Returns this
Inherited from Vector3.set
- Defined in node_modules/hisabati/dist/index.d.ts:437

setMagnitude

setMagnitude(length: number): Vector3
Parameters
- length: number
Returns Vector3
Inherited from Vector3.setMagnitude
- Defined in node_modules/hisabati/dist/index.d.ts:450

splat

splat(scalar: number): this
Parameters
- scalar: number
Returns this
Inherited from Vector3.splat
- Defined in node_modules/hisabati/dist/index.d.ts:444

subtract

subtract(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
Inherited from Vector3.subtract
- Defined in node_modules/hisabati/dist/index.d.ts:453

subtractScalar

subtractScalar(n: number): Vector3
Parameters
- n: number
Returns Vector3
Inherited from Vector3.subtractScalar
- Defined in node_modules/hisabati/dist/index.d.ts:454

`Static`add

add(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.add
- Defined in node_modules/hisabati/dist/index.d.ts:486

`Static`addScalar

addScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.addScalar
- Defined in node_modules/hisabati/dist/index.d.ts:487

`Static`angleBetween

angleBetween(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.angleBetween
- Defined in node_modules/hisabati/dist/index.d.ts:500

`Static`clampMagnitude

clampMagnitude(v: Vector3, min: number, max: number, out?: Vector3): Vector3
Parameters
- v: Vector3
- min: number
- max: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.clampMagnitude
- Defined in node_modules/hisabati/dist/index.d.ts:485

`Static`clone

clone(target: Scale3D): Vector3
Parameters
- target: Scale3D
Returns Vector3
- Defined in packages/transform/src/components/3d/scale.js:20

`Static`copy

copy(source: Scale3D, target?: Scale3D): Vector3
Parameters
- source: Scale3D
- target: Scale3D = ...
Returns Vector3
Overrides Vector3.copy
- Defined in packages/transform/src/components/3d/scale.js:13

`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 node_modules/hisabati/dist/index.d.ts:497

`Static`deserialize

deserialize(value: Vector3Like, out?: Scale3D): Vector3
Parameters
- value: Vector3Like
- Optionalout: Scale3D = ...
Returns Vector3
Overrides Vector3.deserialize
- Defined in packages/transform/src/components/3d/scale.js:35

`Static`distanceTo

distanceTo(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.distanceTo
- Defined in node_modules/hisabati/dist/index.d.ts:482

`Static`distanceToSquared

distanceToSquared(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.distanceToSquared
- Defined in node_modules/hisabati/dist/index.d.ts:481

`Static`divide

divide(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.divide
- Defined in node_modules/hisabati/dist/index.d.ts:492

`Static`divideScalar

divideScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.divideScalar
- Defined in node_modules/hisabati/dist/index.d.ts:493

`Static`dot

dot(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
Inherited from Vector3.dot
- Defined in node_modules/hisabati/dist/index.d.ts:496

`Static`equal

equal(v1: Vector3, v2: Vector3): boolean
Parameters
- v1: Vector3
- v2: Vector3
Returns boolean
Inherited from Vector3.equal
- Defined in node_modules/hisabati/dist/index.d.ts:501

`Static`fuzzyEqual

fuzzyEqual(v1: Vector3, v2: Vector3, tolerance: number): boolean
Parameters
- v1: Vector3
- v2: Vector3
- tolerance: number
Returns boolean
Inherited from Vector3.fuzzyEqual
- Defined in node_modules/hisabati/dist/index.d.ts:502

`Static`invert

invert(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.invert
- Defined in node_modules/hisabati/dist/index.d.ts:495

`Static`lerp

lerp(from: Vector3, to: Vector3, t: number, out?: Vector3): Vector3
Parameters
- from: Vector3
- to: Vector3
- t: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.lerp
- Defined in node_modules/hisabati/dist/index.d.ts:498

`Static`magnitude

magnitude(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.magnitude
- Defined in node_modules/hisabati/dist/index.d.ts:480

`Static`magnitudeSquared

magnitudeSquared(v: Vector3): number
Parameters
- v: Vector3
Returns number
Inherited from Vector3.magnitudeSquared
- Defined in node_modules/hisabati/dist/index.d.ts:479

`Static`multiply

multiply(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.multiply
- Defined in node_modules/hisabati/dist/index.d.ts:490

`Static`multiplyScalar

multiplyScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.multiplyScalar
- Defined in node_modules/hisabati/dist/index.d.ts:491

`Static`normalize

normalize(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.normalize
- Defined in node_modules/hisabati/dist/index.d.ts:483

`Static`random

random(out?: Vector3): Vector3
Parameters
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.random
- Defined in node_modules/hisabati/dist/index.d.ts:503

`Static`reflect

reflect(v: Vector3, normal: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- normal: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.reflect
- Defined in node_modules/hisabati/dist/index.d.ts:499

`Static`reverse

reverse(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.reverse
- Defined in node_modules/hisabati/dist/index.d.ts:494

`Static`serialize

serialize(value: Scale3D): Vector3Like
Parameters
- value: Scale3D
Returns Vector3Like
Overrides Vector3.serialize
- Defined in packages/transform/src/components/3d/scale.js:27

`Static`set

set(x: number, y: number, z: number, out?: Vector3): Vector3
Parameters
- x: number
- y: number
- z: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.set
- Defined in node_modules/hisabati/dist/index.d.ts:464

`Static`setMagnitude

setMagnitude(v: Vector3, length: number, out?: Vector3): Vector3
Parameters
- v: Vector3
- length: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.setMagnitude
- Defined in node_modules/hisabati/dist/index.d.ts:484

`Static`splat

splat(scalar: number, out?: Vector3): Vector3
Parameters
- scalar: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.splat
- Defined in node_modules/hisabati/dist/index.d.ts:478

`Static`subtract

subtract(from: Vector3, to: Vector3, out?: Vector3): Vector3
Parameters
- from: Vector3
- to: Vector3
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.subtract
- Defined in node_modules/hisabati/dist/index.d.ts:488

`Static`subtractScalar

subtractScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- Optionalout: Vector3
Returns Vector3
Inherited from Vector3.subtractScalar
- Defined in node_modules/hisabati/dist/index.d.ts:489

`Static`validateSerial

validateSerial(value: unknown): value is Vector3Like
Checks whether a value is a valid vector serial.
Parameters
- value: unknown
Returns value is Vector3Like
Inherited from Vector3.validateSerial
- Defined in node_modules/hisabati/dist/index.d.ts:477

Class Scale3D

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Scale3D

Properties

x

y

z

StaticNegX

StaticNegY

StaticNegZ

StaticX

StaticY

StaticZ

Static ReadonlyZero

Methods

[iterator]

Returns IterableIterator<number>

add

Parameters

Returns Vector3

addScalar

Parameters

Returns Vector3

clone

Returns Vector3

copy

Parameters

Returns this

cross

Parameters

Returns Vector3

distanceTo

Parameters

Returns number

distanceToSquared

Parameters

Returns number

divide

Parameters

Returns Vector3

divideScalar

Parameters

Returns Vector3

dot

Parameters

Returns number

equals

Parameters

Returns boolean

invert

Returns Vector3

magnitude

Returns number

magnitudeSquared

Returns number

multiply

Parameters

Returns Vector3

multiplyScalar

Parameters

Returns Vector3

normalize

Returns Vector3

reverse

Returns Vector3

serialize

Returns Vector3Like

set

Parameters

Returns this

setMagnitude

Parameters

Returns Vector3

`Static`NegX

`Static`NegY

`Static`NegZ

`Static`X

`Static`Y

`Static`Z

`Static` `Readonly`Zero

`Static`add

`Static`addScalar

`Static`angleBetween

`Static`clampMagnitude

`Static`clone

`Static`copy

`Static`cross

`Static`deserialize

`Static`distanceTo

`Static`distanceToSquared

`Static`divide

`Static`divideScalar

`Static`dot

`Static`equal

`Static`fuzzyEqual

`Static`invert

`Static`lerp

`Static`magnitude

`Static`magnitudeSquared

`Static`multiply

`Static`multiplyScalar