Package de.bsommerfeld.pathetic.api.wrapper

Class PathVector

java.lang.Object
de.bsommerfeld.pathetic.api.wrapper.PathVector
public class PathVector extends Object
Represents a 3D vector within a pathfinding context. This class encapsulates the x, y, and z components of a vector and provides methods for vector operations such as addition, subtraction, dot product, cross product, and normalization.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PathVector(double x, double y, double z)
    Constructs a PathVector with the specified x, y, and z components.

  • Method Summary

    Modifier and Type
    Method
    Description
    PathVector
    add(PathVector otherVector)
    Creates a new PathVector by adding another vector to this vector.
    protected boolean
    canEqual(Object other)
     
    static double
    computeDistance(PathVector A, PathVector B, PathVector C)
    Computes the perpendicular distance from point A to the infinite line defined by points B and C.
    double
    distance(PathVector otherVector)
    Calculates the Euclidean distance between this vector and another vector.
    PathVector
    divide(double value)
    Creates a new PathVector by dividing this vector by a scalar value.
    double
    dot(PathVector otherVector)
    Calculates the dot product of this vector and another vector.
    boolean
    equals(Object o)
     
    PathVector
    getCrossProduct(PathVector o)
    Calculates the cross product of this vector and another vector.
    double
    getX()
    Returns the x-component of this vector.
    double
    getY()
    Returns the y-component of this vector.
    double
    getZ()
    Returns the z-component of this vector.
    int
    hashCode()
     
    double
    length()
    Calculates the length (magnitude) of this vector.
    PathVector
    multiply(double value)
    Creates a new PathVector by multiplying this vector by a scalar value.
    PathVector
    normalize()
    Creates a new PathVector by normalizing this vector.
    static PathVector
    of(double x, double y, double z)
    Creates a new PathVector instance with the specified components.
    PathVector
    setX(double x)
    Creates a new PathVector with the same y and z components as this vector, but with the x-component set to the given value.
    PathVector
    setY(double y)
    Creates a new PathVector with the same x and z components as this vector, but with the y-component set to the given value.
    PathVector
    setZ(double z)
    Creates a new PathVector with the same x and y components as this vector, but with the z-component set to the given value.
    PathVector
    subtract(PathVector otherVector)
    Creates a new PathVector by subtracting another vector from this vector.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PathVector

      public PathVector(double x, double y, double z)
      Constructs a PathVector with the specified x, y, and z 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

    • of

      public static PathVector of(double x, double y, double z)
      Creates a new PathVector instance with the specified components.
      Parameters:
      x - The x-component of the vector.
      y - The y-component of the vector.
      z - The z-component of the vector.
      Returns:
      A new PathVector instance.

    • computeDistance

      public static double computeDistance(PathVector A, PathVector B, PathVector C)
      Computes the perpendicular distance from point A to the infinite line defined by points B and C.

      If B and C coincide (or are numerically indistinguishable), the line degenerates to a single point and the Euclidean distance from A to B is returned.

      Parameters:
      A - The point represented as a PathVector. Must not be null.
      B - The first reference point of the line represented as a PathVector. Must not be null.
      C - The second reference point of the line represented as a PathVector. Must not be null.
      Returns:
      The perpendicular distance from A to the line through B and C, or the distance from A to B if the line degenerates.
      Throws:
      NullPointerException - if any argument is null.

    • dot

      public double dot(PathVector otherVector)
      Calculates the dot product of this vector and another vector.
      Parameters:
      otherVector - The other vector to calculate the dot product with.
      Returns:
      The dot product of the two vectors.

    • length

      public double length()
      Calculates the length (magnitude) of this vector.
      Returns:
      The length of the vector.

    • distance

      public double distance(PathVector otherVector)
      Calculates the Euclidean distance between this vector and another vector.
      Parameters:
      otherVector - The other vector to calculate the distance to.
      Returns:
      The distance between the two vectors.

    • setX

      public PathVector setX(double x)
      Creates a new PathVector with the same y and z components as this vector, but with the x-component set to the given value.
      Parameters:
      x - The new x-component.
      Returns:
      A new PathVector with the updated x-component.

    • setY

      public PathVector setY(double y)
      Creates a new PathVector with the same x and z components as this vector, but with the y-component set to the given value.
      Parameters:
      y - The new y-component.
      Returns:
      A new PathVector with the updated y-component.

    • setZ

      public PathVector setZ(double z)
      Creates a new PathVector with the same x and y components as this vector, but with the z-component set to the given value.
      Parameters:
      z - The new z-component.
      Returns:
      A new PathVector with the updated z-component.

    • subtract

      public PathVector subtract(PathVector otherVector)
      Creates a new PathVector by subtracting another vector from this vector.
      Parameters:
      otherVector - The vector to subtract from this vector.
      Returns:
      A new PathVector representing the difference.

    • multiply

      public PathVector multiply(double value)
      Creates a new PathVector by multiplying this vector by a scalar value.
      Parameters:
      value - The scalar value to multiply by.
      Returns:
      A new PathVector representing the scaled vector.

    • normalize

      public PathVector normalize()
      Creates a new PathVector by normalizing this vector. Normalization divides each component of the vector by its magnitude, resulting in a unit vector (length of 1).
      Returns:
      A new PathVector representing the normalized vector.

    • divide

      public PathVector divide(double value)
      Creates a new PathVector by dividing this vector by a scalar value.
      Parameters:
      value - The scalar value to divide by.
      Returns:
      A new PathVector representing the divided vector.

    • add

      public PathVector add(PathVector otherVector)
      Creates a new PathVector by adding another vector to this vector.
      Parameters:
      otherVector - The vector to add to this vector.
      Returns:
      A new PathVector representing the sum.

    • getCrossProduct

      public PathVector getCrossProduct(PathVector o)
      Calculates the cross product of this vector and another vector.
      Parameters:
      o - The other vector to calculate the cross product with.
      Returns:
      A new PathVector representing the cross product.

    • getX

      public double getX()
      Returns the x-component of this vector.
      Returns:
      The x-component.

    • getY

      public double getY()
      Returns the y-component of this vector.
      Returns:
      The y-component.

    • getZ

      public double getZ()
      Returns the z-component of this vector.
      Returns:
      The z-component.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object