Class vec4

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

Example

// Lightens and darkens a color with vec4 methods
//@input Asset.Material material
//@input vec4 myColor = {1,0,0,1} {"widget":"color"}
//@input float value

script.material.mainColor = script.myColor.uniformScale(script.value);

Constructors

constructor

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

Properties

a

a: number

Alternate name for the w component.

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.

w

w: number

w component of the vec4.

x

x: number

x component of the vec4.

y

y: number

y component of the vec4.

z

z: number

z component of the vec4.

Methods

add

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

addInPlace

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

angleTo

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

clampLength

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

clampLengthInPlace

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

clone

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

Returns vec4

copyFrom

copyFrom(source: vec4 | vec3 | vec2): void
Copies matching components from the source vector, leaving other destination components untouched. For example, copying a vec3 into a vec4 will update x, y, and z but leave w unchanged.
Parameters
- source: vec4 | vec3 | vec2
Returns void

distance

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

distanceSquared

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

div

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

divInPlace

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

dot

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

equal

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

fill

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

`Static`lerp

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

lerpInPlace

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

`Static`max

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

`Static`min

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

moveTowards

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

moveTowardsInPlace

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

mult

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

multInPlace

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

normalize

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

Returns vec4

normalizeInPlace

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

Returns void

`Static`one

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

Returns vec4

project

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

projectInPlace

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

projectOnPlane

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

projectOnPlaneInPlace

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

reflect

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

reflectInPlace

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

scale

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

scaleInPlace

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

setRGBA

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

setXYZW

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

sub

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

subInPlace

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

toString

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

Returns string

uniformScale

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

uniformScaleInPlace

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

`Static`zero

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

Returns vec4

Class vec4

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns vec4

Properties

a

b

g

length

lengthSquared

r

w

x

y

z

Methods

add

Parameters

Returns vec4

addInPlace

Parameters

Returns void

angleTo

Parameters

Returns number

clampLength

Parameters

Returns vec4

clampLengthInPlace

Parameters

Returns void

clone

Returns vec4

copyFrom

Parameters

Returns void

distance

Parameters

Returns number

distanceSquared

Parameters

Returns number

div

Parameters

Returns vec4

divInPlace

Parameters

Returns void

dot

Parameters

Returns number

equal

Parameters

Returns boolean

fill

Parameters

Returns void

Staticlerp

Parameters

Returns vec4

lerpInPlace

Parameters

Returns void

Staticmax

Parameters

Returns vec4

Staticmin

Parameters

Returns vec4

moveTowards

Parameters

Returns vec4

moveTowardsInPlace

Parameters

`Static`lerp

`Static`max

`Static`min

`Static`one

`Static`zero