Package org.djutils.draw

Interface Oriented<O extends Oriented<O>>

Type Parameters:
O - The Oriented type (2d or 3d)
All Known Subinterfaces:
Oriented2d<O>, Oriented3d<O>
All Known Implementing Classes:
OrientedPoint3d
public interface Oriented<O extends Oriented<O>>
Oriented is an interface to indicate an object has a direction.

Copyright (c) 2020-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUTILS License.

Author:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    epsilonEquals(O other, double epsilonCoordinate, double epsilonDirection)
    Compare this Oriented with another Oriented with specified tolerances in the coordinates and the angles.
    double
    getDirZ()
    Return the rotation around the z-axis in radians.
    O
    neg()
    Return a new Oriented with negated coordinate values.

  • Method Details

    • neg

      O neg()
      Return a new Oriented with negated coordinate values. Adds 180 degrees (pi radians) to the rotation(s).
      Returns:
      a new Oriented with negated coordinate values and a rotation in the opposite direction

    • getDirZ

      double getDirZ()
      Return the rotation around the z-axis in radians.
      Returns:
      the rotation around the z-axis in radians

    • epsilonEquals

      boolean epsilonEquals(O other, double epsilonCoordinate, double epsilonDirection)
      Compare this Oriented with another Oriented with specified tolerances in the coordinates and the angles.
      Parameters:
      other - the Oriented to compare with
      epsilonCoordinate - the upper bound of difference for one of the coordinates; use Double.POSITIVE_INFINITY if you do not want to check the coordinates
      epsilonDirection - the upper bound of difference for the direction(s); use Double.POSITIVE_INFINITY if you do not want to check the angles
      Returns:
      true if x, y, and z are less than epsilonCoordinate apart, and rotX, rotY and rotZ are less than epsilonRotation apart, otherwise false
      Throws:
      NullPointerException - when other is null
      ArithmeticException - when epsilonCoordinate or epsilonRotation is NaN
      IllegalArgumentException - epsilonCoordinate or epsilonRotation is negative