Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Vector

Index

Constructors

constructor

  • new Vector(context: Context): Vector
  • Parameters

    • context: Context

    Returns Vector

Methods

add

  • Adds two vectors together

    group

    sum

    shortname

    add

    drawable

    false

    Parameters

    Returns number[]

    Number array representing vector

addAll

  • Adds all vector xyz values together and create a new vector

    group

    sum

    shortname

    add all

    drawable

    false

    Parameters

    Returns number[]

    New vector that has xyz values as sums of all the vectors

all

  • Checks if the boolean array contains only true values, if there's a single false it will return false.

    group

    sum

    shortname

    all

    drawable

    false

    Parameters

    Returns boolean

    Boolean indicating if vector contains only true values

angleBetween

  • Measures the angle between two vectors in degrees

    group

    angles

    shortname

    angle

    drawable

    false

    Parameters

    • inputs: TwoVectorsDto

      Contains two vectors represented as number arrays

    Returns number

    Number in degrees

angleBetweenNormalized2d

  • Measures the normalized 2d angle between two vectors in degrees

    group

    angles

    shortname

    angle normalized 2d

    drawable

    false

    Parameters

    • inputs: TwoVectorsDto

      Contains two vectors represented as number arrays

    Returns number

    Number in degrees

cross

  • Cross two vectors

    group

    base

    shortname

    all

    drawable

    false

    Parameters

    Returns number[]

    Crossed vector

dist

  • Distance between two vectors

    group

    distance

    shortname

    dist

    drawable

    false

    Parameters

    Returns number

    Number representing distance between two vectors

distSquared

  • Squared distance between two vectors

    group

    distance

    shortname

    dist squared

    drawable

    false

    Parameters

    Returns number

    Number representing squared distance between two vectors

div

  • Divide the vector by a scalar value

    group

    base

    shortname

    div

    drawable

    false

    Parameters

    Returns number[]

    Vector that is a result of division by a scalar

domain

  • Computes the domain between minimum and maximum values of the vector

    group

    base

    shortname

    domain

    drawable

    false

    Parameters

    Returns number

    Number representing distance between two vectors

dot

  • Dot product between two vectors

    group

    base

    shortname

    dot

    drawable

    false

    Parameters

    Returns number

    Number representing dot product of the vector

finite

  • Checks if vector is finite for each number and returns a boolean array

    group

    validate

    shortname

    finite

    drawable

    false

    Parameters

    • inputs: VectorDto

      Vector with possibly infinite values

    Returns boolean[]

    Vector array that contains boolean values for each number in the input vector that identifies if value is finite (true) or infinite (false)

isZero

  • Checks if the vector is zero length

    group

    validate

    shortname

    isZero

    drawable

    false

    Parameters

    Returns boolean

    Boolean that identifies if vector is zero length

lerp

  • Finds in between vector between two vectors by providing a fracture

    group

    distance

    shortname

    lerp

    drawable

    false

    Parameters

    Returns number[]

    Vector that is in between two vectors

max

  • Finds the maximum value in the vector

    group

    extract

    shortname

    max

    drawable

    false

    Parameters

    Returns number

    Largest number in the vector

min

  • Finds the minimum value in the vector

    group

    extract

    shortname

    min

    drawable

    false

    Parameters

    Returns number

    Lowest number in the vector

mul

  • Multiple vector with the scalar

    group

    base

    shortname

    mul

    drawable

    false

    Parameters

    Returns number[]

    Vector that results from multiplication

neg

  • Negates the vector

    group

    base

    shortname

    neg

    drawable

    false

    Parameters

    Returns number[]

    Negative vector

norm

  • Norm of the vector

    group

    base

    shortname

    norm

    drawable

    false

    Parameters

    • inputs: VectorDto

      Vector to compute the norm

    Returns number

    Number that is norm of the vector

normSquared

  • Compute squared norm

    group

    base

    shortname

    norm squared

    drawable

    false

    Parameters

    Returns number

    Number that is squared norm

normalized

  • Normalize the vector into a unit vector, that has a length of 1

    group

    base

    shortname

    normalized

    drawable

    false

    Parameters

    Returns number[]

    Unit vector that has length of 1

onRay

  • Finds a point coordinates on the given distance ray that spans between the point along the direction vector

    group

    base

    shortname

    on ray

    drawable

    false

    Parameters

    • inputs: RayPointDto

      Provide a point, vector and a distance for finding a point

    Returns number[]

    Vector representing point on the ray

positiveAngleBetween

  • Measures a positive angle between two vectors given the reference vector in degrees

    group

    angles

    shortname

    positive angle

    drawable

    false

    Parameters

    Returns number

    Number in degrees

range

  • Creates a vector of integers between 0 and maximum ceiling integer

    group

    create

    shortname

    range

    drawable

    false

    Parameters

    Returns number[]

    Vector containing items from 0 to max

signedAngleBetween

  • Computes signed angle between two vectors and a reference. This will always return a smaller angle between two possible angles.

    group

    angles

    shortname

    signed angle

    drawable

    false

    Parameters

    Returns number

    Signed angle in degrees

span

  • Creates a vector that contains numbers spanning between minimum and maximum values at a given step

    group

    create

    shortname

    span

    drawable

    false

    Parameters

    • inputs: SpanDto

      Span information containing min, max and step values

    Returns number[]

    Vector containing number between min, max and increasing at a given step

sub

  • Subtract two vectors

    group

    base

    shortname

    sub

    drawable

    false

    Parameters

    Returns number[]

    Vector that result by subtraction two vectors

sum

  • Sums the values of the vector

    group

    base

    shortname

    sum

    drawable

    false

    Parameters

    Returns number

    Number that results by adding up all values in the vector

vectorXY

  • Create 2d xy vector

    group

    create

    shortname

    vector XY

    drawable

    true

    Parameters

    Returns Vector2

    Create a vector of xy values

vectorXYZ

  • Create a xyz vector

    group

    create

    shortname

    vector XYZ

    drawable

    true

    Parameters

    Returns Vector3

    Create a vector of xyz values

Generated using TypeDoc