Class Vector3

No description provided.

Hierarchy (View Summary)

Observable
- Vector3

Implements

IReadonlyVector3

Index

Constructors

Properties

Accessors

x y z

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
No description provided.
Parameters
- x: number
- y: number
- z: number
Returns Vector3

Overrides Observable.constructor

Properties

`Protected`internal

internal: Vector3InternalBuffer

No description provided.

Accessors

x

get x(): number

No description provided.

Returns number

Implementation of IReadonlyVector3.x
set x(value: number): void
No description provided.
Parameters
- value: number
Returns void

Implementation of IReadonlyVector3.x

y

get y(): number

The Y component of this vector.

Returns number

Implementation of IReadonlyVector3.y
set y(value: number): void
No description provided.
Parameters
- value: number
Returns void

Implementation of IReadonlyVector3.y

z

get z(): number

No description provided.

Returns number

Implementation of IReadonlyVector3.z
set z(value: number): void
No description provided.
Parameters
- value: number
Returns void

Implementation of IReadonlyVector3.z

Methods

add

add(value: AnyVectorLike): Vector3
No description provided.
Parameters
- value: AnyVectorLike
Returns Vector3

Implementation of IReadonlyVector3.add

addSelf

addSelf(value: AnyVectorLike): this
No description provided.
Parameters
- value: AnyVectorLike
Returns this

clone

clone(): Vector3

No description provided.

Returns Vector3

Implementation of IReadonlyVector3.clone

cross

cross(other: Vector3Like): Vector3
No description provided.
Parameters
- other: Vector3Like
Returns Vector3

Implementation of IReadonlyVector3.cross

crossSelf

crossSelf(other: Vector3Like): this
No description provided.
Parameters
- other: Vector3Like
Returns this

dot

dot(other: Vector3Like): number
No description provided.
Parameters
- other: Vector3Like
Returns number

Implementation of IReadonlyVector3.dot

isNormalized

isNormalized(): boolean

No description provided.

Returns boolean

Implementation of IReadonlyVector3.isNormalized

length

length(): number

No description provided.

Returns number

Implementation of IReadonlyVector3.length

lengthSquared

lengthSquared(): number

No description provided.

Returns number

Implementation of IReadonlyVector3.lengthSquared

normalize

normalize(): Vector3

No description provided.

Returns Vector3

Implementation of IReadonlyVector3.normalize

normalizeSelf

normalizeSelf(): this
Scale this vector such that it has length 1. It's efficient to call this if you aren't sure whether a vector is normalized i.e. there is no performance benefit to checking first:
```
// Unnecessary, `normalizeSelf()` already checks this
if (vector.isNormalized()) {
  vector.normalizeSelf();
}
```
Returns this

`Protected`notifyOnChange

notifyOnChange(): void

No description provided.

Returns void

Inherited from Observable.notifyOnChange

onChange

onChange(callback: OnChangeCallback): StopObservingFn
No description provided.
Parameters
- callback: OnChangeCallback
Returns StopObservingFn

Inherited from Observable.onChange

scale

scale(scalar: number): Vector3
No description provided.
Parameters
- scalar: number
Returns Vector3

Implementation of IReadonlyVector3.scale
scale(other: Vector3): Vector3
No description provided.
Parameters
- other: Vector3
Returns Vector3

Implementation of IReadonlyVector3.scale

scaleSelf

scaleSelf(scalar: number): this
No description provided.
Parameters
- scalar: number
Returns this
scaleSelf(other: Vector3Like): this
No description provided.
Parameters
- other: Vector3Like
Returns this

setValue

setValue(x: number, y: number, z: number): this
No description provided.
Parameters
- x: number
- y: number
- z: number
Returns this
setValue(value: Vector3Like): this
No description provided.
Parameters
- value: Vector3Like
Returns this

setX

setX(value: number): this
No description provided.
Parameters
- value: number
Returns this

setY

setY(value: number): this
No description provided.
Parameters
- value: number
Returns this

setZ

setZ(value: number): this
No description provided.
Parameters
- value: number
Returns this

subtract

subtract(value: AnyVectorLike): Vector3
No description provided.
Parameters
- value: AnyVectorLike
Returns Vector3

Implementation of IReadonlyVector3.subtract

subtractSelf

subtractSelf(value: AnyVectorLike): this
No description provided.
Parameters
- value: AnyVectorLike
Returns this

toString

toString(): string

Returns a string representation of an object.

Returns string

Implementation of IReadonlyVector3.toString

withX

withX(value: number): Vector3
No description provided.
Parameters
- value: number
Returns Vector3

Implementation of IReadonlyVector3.withX

withY

withY(value: number): Vector3
No description provided.
Parameters
- value: number
Returns Vector3

Implementation of IReadonlyVector3.withY

withZ

withZ(value: number): Vector3
No description provided.
Parameters
- value: number
Returns Vector3

Implementation of IReadonlyVector3.withZ

`Static`back

back(): Vector3

No description provided.

Returns Vector3

`Static`down

down(): Vector3

No description provided.

Returns Vector3

`Static`forward

forward(): Vector3

No description provided.

Returns Vector3

`Static`left

left(): Vector3

No description provided.

Returns Vector3

`Static`one

one(): Vector3

No description provided.

Returns Vector3

`Static`right

right(): Vector3

No description provided.

Returns Vector3

`Static`up

up(): Vector3

No description provided.

Returns Vector3

`Static`zero

zero(): Vector3

No description provided.

Returns Vector3