Lens Scripting API

    Class vec4

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

    // 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);
    Index

    Constructors

    • Creates a new instance of a vec4.

      Parameters

      • x: number
      • y: number
      • z: number
      • w: number

      Returns vec4

    Properties

    a: number

    Alternate name for the w component.

    b: number

    Alternate name for the z component.

    g: number

    Alternate name for the y component.

    length: number

    Returns the length of the vector.

    lengthSquared: number

    Returns the squared length of the vector.

    r: number

    Alternate name for the x component.

    w: number

    w component of the vec4.

    x: number

    x component of the vec4.

    y: number

    y component of the vec4.

    z: number

    z component of the vec4.

    Methods

    • Returns the vector plus vec.

      Parameters

      Returns vec4

    • Returns the angle between the vector and vec.

      Parameters

      Returns number

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

      Parameters

      • length: number

      Returns vec4

    • Returns the distance between the vector and the vector vec.

      Parameters

      Returns number

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

      Parameters

      Returns number

    • Returns the division of the vector by the vector vec.

      Parameters

      Returns vec4

    • Returns the dot product of the vector and vec.

      Parameters

      Returns number

    • Returns whether this is equal to vec.

      Parameters

      Returns boolean

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

      Parameters

      Returns vec4

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

      Parameters

      Returns vec4

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

      Parameters

      Returns vec4

    • Returns a copy of the vector moved towards the point point by the amount magnitude.

      Parameters

      • point: vec4
      • magnitude: number

      Returns vec4

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

      Parameters

      Returns vec4

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

      Returns vec4

    • Returns the vector (1, 1, 1, 1).

      Returns vec4

    • Returns a copy of the vector projected onto the vector vec.

      Parameters

      Returns vec4

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

      Parameters

      Returns vec4

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

      Parameters

      Returns vec4

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

      Parameters

      Returns vec4

    • Returns the vector minus vec.

      Parameters

      Returns vec4

    • Returns a string representation of the vector.

      Returns string

    • Multiplies the components by the number scale.

      Parameters

      • scale: number

      Returns vec4

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

      Returns vec4

    MMNEPVFCICPMFPCPTTAAATR