Class Vec2_EX

Hierarchy

  • Vec2
    • Vec2_EX

Constructors

  • Create a new Vec2 instance.

    Example

    var v = new pc.Vec2(1, 2);
    

    Parameters

    • Optional x: number | number[]

      The x value. Defaults to 0. If x is an array of length 2, the array will be used to populate all components.

    • Optional y: number

      The y value. Defaults to 0.

    Returns Vec2_EX

Properties

_shaderData: Float32Array
x: number

The first component of the vector.

y: number

The second component of the vector.

DOWN: Vec2

A constant vector set to [0, -1].

LEFT: Vec2

A constant vector set to [-1, 0].

ONE: Vec2

A constant vector set to [1, 1].

RIGHT: Vec2

A constant vector set to [1, 0].

UP: Vec2

A constant vector set to [0, 1].

ZERO: Vec2

A constant vector set to [0, 0].

Accessors

Methods

  • Adds a 2-dimensional vector to another in place.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(10, 10);
    var b = new pc.Vec2(20, 20);

    a.add(b);

    // Outputs [30, 30]
    console.log("The result of the addition is: " + a.toString());

    Parameters

    • rhs: Vec2

      The vector to add to the specified vector.

    Returns Vec2

  • Adds two 2-dimensional vectors together and returns the result.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(10, 10);
    var b = new pc.Vec2(20, 20);
    var r = new pc.Vec2();

    r.add2(a, b);
    // Outputs [30, 30]

    console.log("The result of the addition is: " + r.toString());

    Parameters

    • lhs: Vec2

      The first vector operand for the addition.

    • rhs: Vec2

      The second vector operand for the addition.

    Returns Vec2

  • Adds a number to each element of a vector.

    Returns

    Self for chaining.

    Example

    var vec = new pc.Vec2(3, 4);

    vec.addScalar(2);

    // Outputs [5, 6]
    console.log("The result of the addition is: " + vec.toString());

    Parameters

    • scalar: number

      The number to add.

    Returns Vec2

  • Each element is rounded up to the next largest integer.

    Returns

    Self for chaining.

    Returns Vec2

  • Returns an identical copy of the specified 2-dimensional vector.

    Returns

    A 2-dimensional vector containing the result of the cloning.

    Example

    var v = new pc.Vec2(10, 20);
    var vclone = v.clone();
    console.log("The result of the cloning is: " + vclone.toString());

    Returns Vec2_EX

  • Copies the contents of a source 2-dimensional vector to a destination 2-dimensional vector.

    Returns

    Self for chaining.

    Example

    var src = new pc.Vec2(10, 20);
    var dst = new pc.Vec2();

    dst.copy(src);

    console.log("The two vectors are " + (dst.equals(src) ? "equal" : "different"));

    Parameters

    • rhs: Vec2

      A vector to copy to the specified vector.

    Returns Vec2

  • Returns the result of a cross product operation performed on the two specified 2-dimensional vectors.

    Returns

    The cross product of the two vectors.

    Example

    var right = new pc.Vec2(1, 0);
    var up = new pc.Vec2(0, 1);
    var crossProduct = right.cross(up);

    // Prints 1
    console.log("The result of the cross product is: " + crossProduct);

    Parameters

    • rhs: Vec2

      The second 2-dimensional vector operand of the cross product.

    Returns number

  • Returns the distance between the two specified 2-dimensional vectors.

    Returns

    The distance between the two vectors.

    Example

    var v1 = new pc.Vec2(5, 10);
    var v2 = new pc.Vec2(10, 20);
    var d = v1.distance(v2);
    console.log("The distance between v1 and v2 is: " + d);

    Parameters

    • rhs: Vec2

      The second 2-dimensional vector to test.

    Returns number

  • Divides a 2-dimensional vector by another in place.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(4, 9);
    var b = new pc.Vec2(2, 3);

    a.div(b);

    // Outputs [2, 3]
    console.log("The result of the division is: " + a.toString());

    Parameters

    • rhs: Vec2

      The vector to divide the specified vector by.

    Returns Vec2

  • Divides one 2-dimensional vector by another and writes the result to the specified vector.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(4, 9);
    var b = new pc.Vec2(2, 3);
    var r = new pc.Vec2();

    r.div2(a, b);
    // Outputs [2, 3]

    console.log("The result of the division is: " + r.toString());

    Parameters

    • lhs: Vec2

      The dividend vector (the vector being divided).

    • rhs: Vec2

      The divisor vector (the vector dividing the dividend).

    Returns Vec2

  • Divides each element of a vector by a number.

    Returns

    Self for chaining.

    Example

    var vec = new pc.Vec2(3, 6);

    vec.divScalar(3);

    // Outputs [1, 2]
    console.log("The result of the division is: " + vec.toString());

    Parameters

    • scalar: number

      The number to divide by.

    Returns Vec2

  • Returns the result of a dot product operation performed on the two specified 2-dimensional vectors.

    Returns

    The result of the dot product operation.

    Example

    var v1 = new pc.Vec2(5, 10);
    var v2 = new pc.Vec2(10, 20);
    var v1dotv2 = v1.dot(v2);
    console.log("The result of the dot product is: " + v1dotv2);

    Parameters

    • rhs: Vec2

      The second 2-dimensional vector operand of the dot product.

    Returns number

  • Reports whether two vectors are equal.

    Returns

    True if the vectors are equal and false otherwise.

    Example

    var a = new pc.Vec2(1, 2);
    var b = new pc.Vec2(4, 5);
    console.log("The two vectors are " + (a.equals(b) ? "equal" : "different"));

    Parameters

    • rhs: Vec2

      The vector to compare to the specified vector.

    Returns boolean

  • Each element is set to the largest integer less than or equal to its value.

    Returns

    Self for chaining.

    Returns Vec2

  • Returns the magnitude of the specified 2-dimensional vector.

    Returns

    The magnitude of the specified 2-dimensional vector.

    Example

    var vec = new pc.Vec2(3, 4);
    var len = vec.length();
    // Outputs 5
    console.log("The length of the vector is: " + len);

    Returns number

  • Returns the magnitude squared of the specified 2-dimensional vector.

    Returns

    The magnitude of the specified 2-dimensional vector.

    Example

    var vec = new pc.Vec2(3, 4);
    var len = vec.lengthSq();
    // Outputs 25
    console.log("The length squared of the vector is: " + len);

    Returns number

  • Returns the result of a linear interpolation between two specified 2-dimensional vectors.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(0, 0);
    var b = new pc.Vec2(10, 10);
    var r = new pc.Vec2();

    r.lerp(a, b, 0); // r is equal to a
    r.lerp(a, b, 0.5); // r is 5, 5
    r.lerp(a, b, 1); // r is equal to b

    Parameters

    • lhs: Vec2

      The 2-dimensional to interpolate from.

    • rhs: Vec2

      The 2-dimensional to interpolate to.

    • alpha: number

      The value controlling the point of interpolation. Between 0 and 1, the linear interpolant will occur on a straight line between lhs and rhs. Outside of this range, the linear interpolant will occur on a ray extrapolated from this line.

    Returns Vec2

  • Each element is assigned a value from rhs parameter if it is larger.

    Returns

    Self for chaining.

    Parameters

    • rhs: Vec2

      The 2-dimensional vector used as the source of elements to compare to.

    Returns Vec2

  • Each element is assigned a value from rhs parameter if it is smaller.

    Returns

    Self for chaining.

    Parameters

    • rhs: Vec2

      The 2-dimensional vector used as the source of elements to compare to.

    Returns Vec2

  • Multiplies a 2-dimensional vector to another in place.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(2, 3);
    var b = new pc.Vec2(4, 5);

    a.mul(b);

    // Outputs 8, 15
    console.log("The result of the multiplication is: " + a.toString());

    Parameters

    • rhs: Vec2

      The 2-dimensional vector used as the second multiplicand of the operation.

    Returns Vec2

  • Returns the result of multiplying the specified 2-dimensional vectors together.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(2, 3);
    var b = new pc.Vec2(4, 5);
    var r = new pc.Vec2();

    r.mul2(a, b);

    // Outputs 8, 15
    console.log("The result of the multiplication is: " + r.toString());

    Parameters

    • lhs: Vec2

      The 2-dimensional vector used as the first multiplicand of the operation.

    • rhs: Vec2

      The 2-dimensional vector used as the second multiplicand of the operation.

    Returns Vec2

  • Multiplies each element of a vector by a number.

    Returns

    Self for chaining.

    Example

    var vec = new pc.Vec2(3, 6);

    vec.mulScalar(3);

    // Outputs [9, 18]
    console.log("The result of the multiplication is: " + vec.toString());

    Parameters

    • scalar: number

      The number to multiply by.

    Returns Vec2

  • Returns this 2-dimensional vector converted to a unit vector in place. If the vector has a length of zero, the vector's elements will be set to zero.

    Returns

    Self for chaining.

    Example

    var v = new pc.Vec2(25, 0);

    v.normalize();

    // Outputs 1, 0
    console.log("The result of the vector normalization is: " + v.toString());

    Returns Vec2

  • Each element is rounded up or down to the nearest integer.

    Returns

    Self for chaining.

    Returns Vec2

  • Sets the specified 2-dimensional vector to the supplied numerical values.

    Returns

    Self for chaining.

    Example

    var v = new pc.Vec2();
    v.set(5, 10);

    // Outputs 5, 10
    console.log("The result of the vector set is: " + v.toString());

    Parameters

    • x: number

      The value to set on the first component of the vector.

    • y: number

      The value to set on the second component of the vector.

    Returns Vec2

  • Subtracts a 2-dimensional vector from another in place.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(10, 10);
    var b = new pc.Vec2(20, 20);

    a.sub(b);

    // Outputs [-10, -10]
    console.log("The result of the subtraction is: " + a.toString());

    Parameters

    • rhs: Vec2

      The vector to add to the specified vector.

    Returns Vec2

  • Subtracts two 2-dimensional vectors from one another and returns the result.

    Returns

    Self for chaining.

    Example

    var a = new pc.Vec2(10, 10);
    var b = new pc.Vec2(20, 20);
    var r = new pc.Vec2();

    r.sub2(a, b);

    // Outputs [-10, -10]
    console.log("The result of the subtraction is: " + r.toString());

    Parameters

    • lhs: Vec2

      The first vector operand for the addition.

    • rhs: Vec2

      The second vector operand for the addition.

    Returns Vec2

  • Subtracts a number from each element of a vector.

    Returns

    Self for chaining.

    Example

    var vec = new pc.Vec2(3, 4);

    vec.subScalar(2);

    // Outputs [1, 2]
    console.log("The result of the subtraction is: " + vec.toString());

    Parameters

    • scalar: number

      The number to subtract.

    Returns Vec2

  • Converts the vector to string form.

    Returns

    The vector in string form.

    Example

    var v = new pc.Vec2(20, 10);
    // Outputs [20, 10]
    console.log(v.toString());

    Returns string