org.djutils.draw.Directed3d 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;

/**
 * Directed3d.java.
 * 
 * Copyright (c) 2023-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
 * for project information  https://djutils.org. The DJUTILS project is
 * distributed under a three-clause BSD-style license, which can be found at
 *  https://djutils.org/docs/license.html.
 * 

 * There are two naming conventions for phi and theta. Djutils draw uses neither to stay clear of this confusion. The angle from
 * the positive z-axis to the projection of the direction on the x-y-plane is named dirY. The angle from the
 * positive x-axis to the projection of the direction in the x-y-plane is named dirZ.
 * 
 * @author Alexander Verbraeck
 * @author Peter Knoppers
 * @param  the Directed type
 */
public interface Directed3d> extends Directed
{
    /**
     * Retrieve the angle from the positive x-axis to the projection of the direction in the x-y-plane. Positive values rotate
     * towards the positive y-axis (and beyond).
     * @return double; dirZ
     */
    double getDirZ();

    /**
     * Retrieve the angle from the positive z axis to the direction. Normally these are values between [0:π]. Angles less
     * than π/2 indicate above the x-y-plane; positive slope, angles > π/2 indicate angles below this plane; negative
     * slope.
     * @return double; dirY
     */
    double getDirY();

}