Class YVector3

Hierarchy

YVector3

Index

Constructors

constructor

Accessors

Constructors

constructor

new YVector3(): YVector3

Returns YVector3

Accessors

cloned

get cloned(): YVector3

Returns a clone of the specified vector.

Returns YVector3

magnitude

get magnitude(): number

Allows to get the magnitude (length) of a vector.

Returns number

sqrMagnitude

get sqrMagnitude(): number

Allows to get the square magnitude (or a dot product of itself) of a vector.

Returns number

x

get x(): number
set x(value: number): any

Allows to get / set the X component of a vector.

Returns number
Allows to get / set the X component of a vector.

Parameters
- value: number
Returns any

y

get y(): number
set y(value: number): any

Allows to get / set the Y component of a vector.

Returns number
Allows to get / set the Y component of a vector.

Parameters
- value: number
Returns any

z

get z(): number
set z(value: number): any

Allows to get / set the ** Z component** of a vector.

Returns number
Allows to get / set the ** Z component** of a vector.

Parameters
- value: number
Returns any

Methods

Static angle

angle(a: YVector3, b: YVector3): number

Returns angle between two vectors.

Parameters
- a: YVector3
- b: YVector3
Returns number

Static create

create(x: number, y: number, z: number): YVector3

Returns new vector composed from input values.

Parameters
- x: number
- y: number
- z: number
Returns YVector3

Static cross

cross(a: YVector3, b: YVector3): YVector3

Returns cross product of two vectors.

Parameters
- a: YVector3
- b: YVector3
Returns YVector3

Static distance

distance(a: YVector3, b: YVector3): number

Returns distance between two points.

Parameters
- a: YVector3
- b: YVector3
Returns number

Static dot

dot(a: YVector3, b: YVector3): number

Returns dot product of two vectors.

Parameters
- a: YVector3
- b: YVector3
Returns number

Static fromToRotation

fromToRotation(vectorA: YVector3, vectorB: YVector3): YVector3

Creates a rotation from direction Vector A to direction Vector B.

Parameters
- vectorA: YVector3
- vectorB: YVector3
Returns YVector3

Static getLookRotation

getLookRotation(from: YVector3, to: YVector3): YVector3

Returns the rotation vector that points from the first entity to the second one.

Parameters
- from: YVector3
- to: YVector3
Returns YVector3

Static inverseRotation

inverseRotation(rotation: YVector3): YVector3

Returns the inverse rotation of the selected rotation.

Parameters
- rotation: YVector3
Returns YVector3

Static lerp

lerp(a: YVector3, b: YVector3, t: number): YVector3

Linear interpolation between two vectors by the interpolant.

Parameters
- a: YVector3
- b: YVector3
- t: number
Returns YVector3

Static lerpRotation

lerpRotation(rotationA: YVector3, rotationB: YVector3, t: number): YVector3

Linear interpolation between two rotation vectors by the interpolant.

Parameters
- rotationA: YVector3
- rotationB: YVector3
- t: number
Returns YVector3

Static max

max(a: YVector3, b: YVector3): YVector3

Returns the vector made from largest components of two vectors.

Parameters
- a: YVector3
- b: YVector3
Returns YVector3

Static min

min(a: YVector3, b: YVector3): YVector3

Returns the vector made from smallest components of two vectors.

Parameters
- a: YVector3
- b: YVector3
Returns YVector3

Static moveTowards

moveTowards(a: YVector3, b: YVector3, maxDistance: number): YVector3

Moves point A in a straight line towards target point B, limited by maximum distance (meters).

Parameters
- a: YVector3
- b: YVector3
- maxDistance: number
Returns YVector3

Static normalize

normalize(a: YVector3): YVector3

Returns normalized variant of input vector*.

Parameters
- a: YVector3
Returns YVector3

Static project

project(a: YVector3, b: YVector3): YVector3

Returns projection of vector A onto vector B.

Parameters
- a: YVector3
- b: YVector3
Returns YVector3

Static randomPointInUnitCircle

randomPointInUnitCircle(): YVector3

Returns random vector positioned on a unit circle.

Returns YVector3

Static randomPointInUnitSphere

randomPointInUnitSphere(): YVector3

Returns random vector positioned inside a unit sphere.

Returns YVector3

Static randomPointOnUnitSphere

randomPointOnUnitSphere(): YVector3

Returns random vector positioned on a unit sphere.

Returns YVector3

Static randomRotation

randomRotation(): YVector3

Returns random rotation vector.

Returns YVector3

Static rotateRotation

rotateRotation(rotationA: YVector3, rotationB: YVector3): YVector3

Allows to transform rotation vector by specified rotation.

Parameters
- rotationA: YVector3
- rotationB: YVector3
Returns YVector3

Static rotateVector

rotateVector(rotation: YVector3, point: YVector3): YVector3

Allows to transform vector by specified rotation.

Parameters
- rotation: YVector3
- point: YVector3
Returns YVector3

Static rotationAngle

rotationAngle(rotationA: YVector3, rotationB: YVector3): number

Returns the angle in degrees between two rotation vectors.

Parameters
- rotationA: YVector3
- rotationB: YVector3
Returns number

Static rotationAngleAxis

rotationAngleAxis(angle: number, axis: YVector3): YVector3

Returns vector of angle rotation around selected axis.

Parameters
- angle: number
- axis: YVector3
Returns YVector3

Static rotationTowards

rotationTowards(rotationA: YVector3, rotationB: YVector3, maxDegrees: number): YVector3

Transforms rotation vector A towards vector B by provided angle step.

Parameters
- rotationA: YVector3
- rotationB: YVector3
- maxDegrees: number
Returns YVector3

Static scale

scale(a: YVector3, b: YVector3): YVector3

Multiplies two vectors* component-wise.

Parameters
- a: YVector3
- b: YVector3
Returns YVector3

Static slerpRotation

slerpRotation(rotationA: YVector3, rotationB: YVector3, t: number): YVector3

Spherical interpolation between two rotation vectors by the interpolant.

Parameters
- rotationA: YVector3
- rotationB: YVector3
- t: number
Returns YVector3

Generated using TypeDoc