org.djutils.draw.Oriented Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of djutils-draw Show documentation

DJUTILS - Delft Java Utilities Drawing and animation primitives

The newest version!

package org.djutils.draw;

/**
 * Oriented is an interface to indicate an object has a direction.
 * 
 * Copyright (c) 2020-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. 

 * BSD-style license. See DJUTILS License.
 * 
 * @author Alexander Verbraeck
 * @author Peter Knoppers
 * @param  The Oriented type (2d or 3d)
 */
public interface Oriented>
{
    /**
     * Return a new Oriented with negated coordinate values. Adds 180 degrees (pi radians) to the rotation(s).
     * @return D; a new Oriented with negated coordinate values and a rotation in the opposite direction
     */
    O neg();

    /**
     * Return the rotation around the z-axis in radians.
     * @return double; the rotation around the z-axis in radians
     */
    double getDirZ();

    /**
     * Compare this Oriented with another Oriented with specified tolerances in the coordinates and the angles.
     * @param other O; the Oriented to compare with
     * @param epsilonCoordinate double; the upper bound of difference for one of the coordinates; use Double.POSITIVE_INFINITY
     *            if you do not want to check the coordinates
     * @param epsilonDirection double; the upper bound of difference for the direction(s); use Double.POSITIVE_INFINITY if you
     *            do not want to check the angles
     * @return boolean; 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
     * @throws IllegalArgumentException epsilonCoordinate or epsilonRotation is NaN or negative
     */
    boolean epsilonEquals(O other, double epsilonCoordinate, double epsilonDirection)
            throws NullPointerException, IllegalArgumentException;

}