Class vec3

A three dimensional vector. Vectors can only store finite numbers in the range Number.MIN_VALUE to Number.MAX_VALUE.

Example

// Check the distance between two objects
//@input SceneObject objectA
//@input SceneObject objectB
//@input float distCheck

var pointA = script.objectA.getTransform().getWorldPosition();
var pointB = script.objectB.getTransform().getWorldPosition();
var distance = pointA.distance(pointB);
if(distance > script.distCheck)
{
    print("Too Far.");
}

Constructors

constructor

new vec3(x: number, y: number, z: number): vec3
Creates a new instance of a vec3.
Parameters
- x: number
- y: number
- z: number
Returns vec3

Properties

b

b: number

Alternate name for the z component.

g

g: number

Alternate name for the y component.

length

length: number

Returns the length of the vector.

lengthSquared

lengthSquared: number

Returns the squared length of the vector.

r

r: number

Alternate name for the x component.

x

x: number

x component of the vec3.

y

y: number

y component of the vec3.

z

z: number

z component of the vec3.

Methods

add

add(vec: vec3): vec3
Returns the vector plus vec.
Parameters
- vec: vec3
Returns vec3

addInPlace

addInPlace(vec: vec3): void
Adds vec to this vector in place.
Parameters
- vec: vec3
Returns void

angleTo

angleTo(vec: vec3): number
Returns the angle between the vector and vec.
Parameters
- vec: vec3
Returns number

`Static`back

back(): vec3
Returns the vector (0, 0, -1).

Returns vec3

clampLength

clampLength(length: number): vec3
Returns a copy of the vector with its length clamped to length.
Parameters
- length: number
Returns vec3

clampLengthInPlace

clampLengthInPlace(length: number): void
Clamps this vector's length to length in place.
Parameters
- length: number
Returns void

clone

clone(): vec3
Returns a copy of this vector.

Returns vec3

copyFrom

copyFrom(source: vec4 | vec3 | vec2): void
Copies matching components from the source vector, leaving other destination components untouched and ignoring extra source components. For example, copying a vec2 leaves z unchanged, while copying a vec4 ignores w.
Parameters
- source: vec4 | vec3 | vec2
Returns void

cross

cross(vec: vec3): vec3
Returns the cross product of the vector and vec
Parameters
- vec: vec3
Returns vec3

crossInPlace

crossInPlace(vec: vec3): void
Sets this vector to the cross product of this vector and vec in place.
Parameters
- vec: vec3
Returns void

distance

distance(vec: vec3): number
Returns the distance between the vector and the vector vec.
Parameters
- vec: vec3
Returns number

distanceSquared

distanceSquared(vec: vec3): number
Like distance(), but returns the squared distance between vectors.
Parameters
- vec: vec3
Returns number

div

div(vec: vec3): vec3
Returns the division of the vector by the vector vec.
Parameters
- vec: vec3
Returns vec3

divInPlace

divInPlace(vec: vec3): void
Divides this vector by vec component-wise in place.
Parameters
- vec: vec3
Returns void

dot

dot(vec: vec3): number
Returns the dot product of the vector and vec.
Parameters
- vec: vec3
Returns number

`Static`down

down(): vec3
Returns the vector (0, -1, 0).

Returns vec3

equal

equal(vec: vec3): boolean
Returns whether this is equal to vec.
Parameters
- vec: vec3
Returns boolean

fill

fill(scalar: number): void
Sets the x, y, and z components of this vector to scalar.
Parameters
- scalar: number
Returns void

`Static`forward

forward(): vec3
Returns the vector (0, 0, 1).

Returns vec3

`Static`left

left(): vec3
Returns the vector (-1, 0, 0).

Returns vec3

`Static`lerp

lerp(vecA: vec3, vecB: vec3, t: number): vec3
Linearly interpolates between the two vectors from and to by the factor t.
Parameters
- vecA: vec3
- vecB: vec3
- t: number
Returns vec3

lerpInPlace

lerpInPlace(target: vec3, t: number): void
Linearly interpolates this vector towards target by factor t in place.
Parameters
- target: vec3
- t: number
Returns void

`Static`max

max(vecA: vec3, vecB: vec3): vec3
Returns a new vector containing the largest value of each component in the two vectors.
Parameters
- vecA: vec3
- vecB: vec3
Returns vec3

`Static`min

min(vecA: vec3, vecB: vec3): vec3
Returns a new vector containing the smallest value of each component in the two vectors.
Parameters
- vecA: vec3
- vecB: vec3
Returns vec3

moveTowards

moveTowards(point: vec3, magnitude: number): vec3
Returns a copy of the vector moved towards the point point by the amount magnitude.
Parameters
- point: vec3
- magnitude: number
Returns vec3

moveTowardsInPlace

moveTowardsInPlace(point: vec3, magnitude: number): void
Moves this vector towards point by magnitude in place.
Parameters
- point: vec3
- magnitude: number
Returns void

mult

mult(vec: vec3): vec3
Returns the component-wise multiplication product of the vector and vec.
Parameters
- vec: vec3
Returns vec3

multInPlace

multInPlace(vec: vec3): void
Multiplies this vector by vec component-wise in place.
Parameters
- vec: vec3
Returns void

normalize

normalize(): vec3
Returns a copy of the vector with its length scaled to 1.

Returns vec3

normalizeInPlace

normalizeInPlace(): void
Scales this vector's length to 1 in place.

Returns void

`Static`one

one(): vec3
Returns the vector (1, 1, 1).

Returns vec3

`Static`orthonormalize

orthonormalize(vecA: vec3, vecB: vec3): void
Makes the vectors vecA and vecB normalized and orthogonal to each other.
Parameters
- vecA: vec3
- vecB: vec3
Returns void

project

project(vec: vec3): vec3
Returns a copy of the vector projected onto the vector onto.
Parameters
- vec: vec3
Returns vec3

projectInPlace

projectInPlace(onto: vec3): void
Projects this vector onto the vector onto in place.
Parameters
- onto: vec3
Returns void

projectOnPlane

projectOnPlane(planeNormal: vec3): vec3
Projects the vector onto the plane defined by planeNormal.
Parameters
- planeNormal: vec3
Returns vec3

projectOnPlaneInPlace

projectOnPlaneInPlace(planeNormal: vec3): void
Projects this vector onto the plane defined by planeNormal in place.
Parameters
- planeNormal: vec3
Returns void

`Static`randomDirection

randomDirection(): vec3
Generates a random 3D unit vector. Equivalent to a random point on a unit-radius sphere.

Returns vec3
Deprecated
Use Math.randomUnitVector or Math.setRandomUnitVector instead.

Deprecated

`Static`randomUnitVector

randomUnitVector(): vec3
Generates a random 3D unit vector. Equivalent to a random point on a unit-radius sphere.

Returns vec3

reflect

reflect(vec: vec3): vec3
Returns a copy of the vector reflected across the plane defined by planeNormal.
Parameters
- vec: vec3
Returns vec3

reflectInPlace

reflectInPlace(planeNormal: vec3): void
Reflects this vector across the plane defined by planeNormal in place.
Parameters
- planeNormal: vec3
Returns void

`Static`right

right(): vec3
Returns the vector (1, 0, 0).

Returns vec3

rotateTowards

rotateTowards(target: vec3, step: number): vec3
Returns a copy of the vector rotated towards the target vector by step radians.

The vectors may be non-normalized. The function always returns a vector with the source vector's magnitude. This prevents overshoot. If step exceeds the angle between vectors, it stops at the target direction. If step is negative, this rotates the source vector away from target. It stops when the direction is precisely opposite to target. If the vectors are in opposite directions, the result is rotated along an arbitrary (but consistent) axis. If either vector is zero magnitude, it returns the source vector.
Parameters
- target: vec3
- step: number
Returns vec3

rotateTowardsInPlace

rotateTowardsInPlace(target: vec3, step: number): void
Rotates this vector towards the target vector by step radians in place.

The vectors may be non-normalized. The function preserves this vector's magnitude. This prevents overshoot. If step exceeds the angle between vectors, it stops at the target direction. If step is negative, this rotates this vector away from target. It stops when the direction is precisely opposite to target. If the vectors are in opposite directions, this vector is rotated along an arbitrary (but consistent) axis. If either vector is zero magnitude, this vector is not modified.
Parameters
- target: vec3
- step: number
Returns void

scale

scale(vec: vec3): vec3
Returns the component-wise multiplication product of the vector and vec.
Parameters
- vec: vec3
Returns vec3

scaleInPlace

scaleInPlace(vec: vec3): void
Multiplies this vector by vec component-wise in place.
Parameters
- vec: vec3
Returns void

setRandomUnitVector

setRandomUnitVector(): void
Sets this vector to a random unit vector in place. Equivalent to a random point on a unit-radius sphere.

Returns void

setRGB

setRGB(r?: number, g?: number, b?: number): void
Alternative to setXYZ. Sets the x, y, and z components of this vector. Omit parameters or pass null or undefined to leave a component unchanged.
Parameters
- Optionalr: number
- Optionalg: number
- Optionalb: number
Returns void

setXYZ

setXYZ(x?: number, y?: number, z?: number): void
Sets the x, y, and z components of this vector. Omit parameters or pass null or undefined to leave a component unchanged.
Parameters
- Optionalx: number
- Optionaly: number
- Optionalz: number
Returns void

`Static`slerp

slerp(vecA: vec3, vecB: vec3, t: number): vec3
Spherically interpolates between the two vectors from and to by the factor t.
Parameters
- vecA: vec3
- vecB: vec3
- t: number
Returns vec3

slerpInPlace

slerpInPlace(target: vec3, t: number): void
Spherically interpolates this vector towards target by factor t in place. Preserves vector magnitude by interpolating both direction and length.
Parameters
- target: vec3
- t: number
Returns void

sub

sub(vec: vec3): vec3
Returns the vector minus vec.
Parameters
- vec: vec3
Returns vec3

subInPlace

subInPlace(vec: vec3): void
Subtracts vec from this vector in place.
Parameters
- vec: vec3
Returns void

toString

toString(): string
Returns a string representation of the vector.

Returns string

uniformScale

uniformScale(scale: number): vec3
Multiplies the components of this vector by scale.
Parameters
- scale: number
Returns vec3

uniformScaleInPlace

uniformScaleInPlace(scale: number): void
Multiplies the components of this vector by scale in place.
Parameters
- scale: number
Returns void

`Static`up

up(): vec3
Returns the vector (0, 1, 0).

Returns vec3

`Static`zero

zero(): vec3
Returns the vector (0, 0, 0).

Returns vec3

Class vec3

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns vec3

Properties

b

g

length

lengthSquared

r

x

y

z

Methods

add

Parameters

Returns vec3

addInPlace

Parameters

Returns void

angleTo

Parameters

Returns number

Staticback

Returns vec3

clampLength

Parameters

Returns vec3

clampLengthInPlace

Parameters

Returns void

clone

Returns vec3

copyFrom

Parameters

Returns void

cross

Parameters

Returns vec3

crossInPlace

Parameters

Returns void

distance

Parameters

Returns number

distanceSquared

Parameters

Returns number

div

Parameters

Returns vec3

divInPlace

Parameters

Returns void

dot

Parameters

Returns number

Staticdown

Returns vec3

equal

Parameters

Returns boolean

fill

Parameters

Returns void

Staticforward

Returns vec3

Staticleft

Returns vec3

Staticlerp

Parameters

Returns vec3

lerpInPlace

Parameters

`Static`back

`Static`down

`Static`forward

`Static`left

`Static`lerp

`Static`max

`Static`min

`Static`one

`Static`orthonormalize

`Static`randomDirection

`Static`randomUnitVector

`Static`right