Package icyllis.arc3d.core

Class Vector3

java.lang.Object
icyllis.arc3d.core.Vector3
public class Vector3 extends Object
Represents a three-dimensional vector.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    x
     
    float
    y
     
    float
    z
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Vector3()
    Create a zero vector
    Vector3(float x, float y, float z)
    Create a vector with given components.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(@NonNull Vector3 v)
    Add each component of a vector to this vector.
    @NonNull Vector3
    copy()
     
    void
    cross(float x, float y, float z)
    Cross product of this vector with the given x, y and z components.
    void
    cross(@NonNull Vector3 v)
    Cross product of this vector with the given vector.
    float
    dot(float x, float y, float z)
    Returns the dot product of this vector with the given x, y and z components.
    float
    dot(@NonNull Vector3 v)
    Returns the dot product of this vector with the given vector.
    boolean
    equals(Object o)
     
    boolean
    equivalent(@NonNull Vector3 v)
    Returns whether this vector is equivalent to given vector.
    int
    hashCode()
     
    boolean
    isNormalized()
    Returns whether this vector is normalized.
    float
    length()
    Returns the magnitude of this vector, namely the 2-norm (euclidean norm) or the length.
    float
    lengthSq()
     
    void
    maxComponent(@NonNull Vector3 v)
    Calculate component-wise maximum of this and the given vector.
    void
    minComponent(@NonNull Vector3 v)
    Calculate component-wise minimum of this and the given vector.
    void
    multiply(float s)
    Multiply this vector by a factor.
    void
    multiply(float mx, float my, float mz)
    Multiply each component of the vector by given multipliers
    void
    multiply(@NonNull Vector3 v)
    Multiply each component of the vector by the given vector.
    void
    negate()
    Negate this vector [-x, -y, -z].
    void
    normalize()
    Normalize this vector to unit length, or [1, 0, 0] if this is zero.
    void
    perpendicular()
    Calculate an arbitrary unit vector perpendicular to this, this vector must be normalized.
    void
    preTransform(@NonNull Matrix4 mat)
    Pre-transform this vector by a 4x4 transformation matrix.
    float
    product()
    Returns the product of all the vector components.
    void
    projection(@NonNull Vector3 v)
    Calculate the projection of the vector on the given vector.
    void
    reverse()
    Reverse the order of components.
    @NonNull Quaternion
    rotation(float angle)
    Create a rotational quaternion clockwise about this axis with given angle in radians.
    void
    set(float x, float y, float z)
    Set all values of this vector using the given components.
    void
    set(@NonNull Vector3 v)
    Set all values of this vector using the given vector.
    void
    setZero()
    Set all values of this vector to zero.
    void
    sort()
    Sort components of this in ascending order.
    void
    subtract(@NonNull Vector3 v)
    Subtract each component of a vector from this vector.
    float
    sum()
    Returns the sum of all the vector components.
    String
    toString()
     
    void
    transform(@NonNull Matrix4 mat)
    Transform this vector by a 4x4 transformation matrix.
    void
    transform(@NonNull Quaternion q)
    Transform this vector by a quaternion rotation.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • x

      public float x

    • y

      public float y

    • z

      public float z

  • Constructor Details

    • Vector3

      public Vector3()
      Create a zero vector

    • Vector3

      public Vector3(float x, float y, float z)
      Create a vector with given components.
      Parameters:
      x - the x-component of the vector
      y - the y-component of the vector
      z - the z-component of the vector

  • Method Details

    • set

      public void set(float x, float y, float z)
      Set all values of this vector using the given components.
      Parameters:
      x - the x-component to set
      y - the y-component to set
      z - the z-component to set

    • set

      public void set(@NonNull Vector3 v)
      Set all values of this vector using the given vector.
      Parameters:
      v - the vector to copy from

    • add

      public void add(@NonNull Vector3 v)
      Add each component of a vector to this vector.
      Parameters:
      v - the vector to add

    • subtract

      public void subtract(@NonNull Vector3 v)
      Subtract each component of a vector from this vector.
      Parameters:
      v - the vector to subtract

    • multiply

      public void multiply(float s)
      Multiply this vector by a factor.
      Parameters:
      s - the factor to multiply.

    • multiply

      public void multiply(float mx, float my, float mz)
      Multiply each component of the vector by given multipliers
      Parameters:
      mx - the x-component multiplier
      my - the y-component multiplier
      mz - the z-component multiplier

    • multiply

      public void multiply(@NonNull Vector3 v)
      Multiply each component of the vector by the given vector.
      Parameters:
      v - the vector to multiply with

    • length

      public float length()
      Returns the magnitude of this vector, namely the 2-norm (euclidean norm) or the length.
      Returns:
      the magnitude of this quaternion

    • lengthSq

      public float lengthSq()

    • dot

      public float dot(float x, float y, float z)
      Returns the dot product of this vector with the given x, y and z components.

    • dot

      public float dot(@NonNull Vector3 v)
      Returns the dot product of this vector with the given vector.
      Parameters:
      v - the vector to dot product with.

    • cross

      public void cross(float x, float y, float z)
      Cross product of this vector with the given x, y and z components.

    • cross

      public void cross(@NonNull Vector3 v)
      Cross product of this vector with the given vector.
      Parameters:
      v - the vector to cross product with.

    • minComponent

      public void minComponent(@NonNull Vector3 v)
      Calculate component-wise minimum of this and the given vector.

    • maxComponent

      public void maxComponent(@NonNull Vector3 v)
      Calculate component-wise maximum of this and the given vector.

    • isNormalized

      public boolean isNormalized()
      Returns whether this vector is normalized.
      Returns:
      true if is normalized, false otherwise

    • normalize

      public void normalize()
      Normalize this vector to unit length, or [1, 0, 0] if this is zero.

    • setZero

      public void setZero()
      Set all values of this vector to zero.

    • negate

      public void negate()
      Negate this vector [-x, -y, -z].

    • sum

      public float sum()
      Returns the sum of all the vector components.
      Returns:
      the sum of all the vector components

    • product

      public float product()
      Returns the product of all the vector components.
      Returns:
      the product of all the vector components

    • perpendicular

      public void perpendicular()
      Calculate an arbitrary unit vector perpendicular to this, this vector must be normalized.

    • projection

      public void projection(@NonNull Vector3 v)
      Calculate the projection of the vector on the given vector.
      Parameters:
      v - the vector to project on

    • rotation

      public @NonNull Quaternion rotation(float angle)
      Create a rotational quaternion clockwise about this axis with given angle in radians. This vector must be normalized.
      Parameters:
      angle - rotation angle in radians
      Returns:
      a quaternion represents the rotation

    • transform

      public void transform(@NonNull Matrix4 mat)
      Transform this vector by a 4x4 transformation matrix.
      Parameters:
      mat - the matrix to transform from

    • preTransform

      public void preTransform(@NonNull Matrix4 mat)
      Pre-transform this vector by a 4x4 transformation matrix.
      Parameters:
      mat - the matrix to transform from

    • transform

      public void transform(@NonNull Quaternion q)
      Transform this vector by a quaternion rotation.
      Parameters:
      q - the quaternion to rotate the vector by

    • sort

      public void sort()
      Sort components of this in ascending order.

    • reverse

      public void reverse()
      Reverse the order of components. [z,y,x]

    • equivalent

      public boolean equivalent(@NonNull Vector3 v)
      Returns whether this vector is equivalent to given vector.
      Parameters:
      v - the quaternion to compare.
      Returns:
      true if this vector is equivalent to other.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • copy

      public @NonNull Vector3 copy()