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

Properties

a b g length lengthSquared r w x y z

Methods

add angleTo clampLength distance distanceSquared div dot equal lerp max min moveTowards mult normalize one project projectOnPlane reflect scale sub toString uniformScale zero

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

    Returns vec4

angleTo

  • angleTo(vec: vec4): number

    Returns the angle between the vector and vec.

    Parameters

    Returns number

clampLength

  • clampLength(length: number): vec4

    Returns a copy of the vector with its length clamped to length.

    Parameters

    • length: number

    Returns vec4

distance

  • distance(vec: vec4): number

    Returns the distance between the vector and the vector vec.

    Parameters

    Returns number

distanceSquared

  • distanceSquared(vec: vec4): number

    Like distance(), but returns the squared distance between vectors.

    Parameters

    Returns number

div

  • div(vec: vec4): vec4

    Returns the division of the vector by the vector vec.

    Parameters

    Returns vec4

dot

  • dot(vec: vec4): number

    Returns the dot product of the vector and vec.

    Parameters

    Returns number

equal

  • equal(vec: vec4): boolean

    Returns whether this is equal to vec.

    Parameters

    Returns boolean

Staticlerp

  • lerp(vecA: vec4, vecB: vec4, t: number): vec4

    Linearly interpolates between the two vectors vecA and vecB by the factor t.

    Parameters

    Returns vec4

Staticmax

  • max(vecA: vec4, vecB: vec4): vec4

    Returns a new vector containing the largest value of each component in the two vectors.

    Parameters

    Returns vec4

Staticmin

  • min(vecA: vec4, vecB: vec4): vec4

    Returns a new vector containing the smallest value of each component in the two vectors.

    Parameters

    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

mult

  • mult(vec: vec4): vec4

    Returns the component-wise multiplication product of the vector and vec.

    Parameters

    Returns vec4

normalize

  • normalize(): vec4

    Returns a copy of the vector with its length scaled to 1.

    Returns vec4

Staticone

  • 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 vec.

    Parameters

    Returns vec4

projectOnPlane

  • projectOnPlane(normal: vec4): vec4

    Projects the vector onto the plane represented by the normal normal.

    Parameters

    Returns vec4

reflect

  • reflect(vec: vec4): vec4

    Returns a copy of the vector reflected across the plane defined by the normal vec.

    Parameters

    Returns vec4

scale

  • scale(vec: vec4): vec4

    Returns the component-wise multiplication product of the vector and vec.

    Parameters

    Returns vec4

sub

  • sub(vec: vec4): vec4

    Returns the vector minus vec.

    Parameters

    Returns vec4

toString

  • toString(): string

    Returns a string representation of the vector.

    Returns string

uniformScale

  • uniformScale(scale: number): vec4

    Multiplies the components by the number scale.

    Parameters

    • scale: number

    Returns vec4

Staticzero

  • zero(): vec4

    Returns the vector (0, 0, 0, 0).

    Returns vec4

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR