org.jeometry.geom3D.SpatialLocalization3D Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jeometry-api Show documentation

Jeometry, a Mathematic and Geometry library for Java

There is a newer version: 1.0.5

package org.jeometry.geom3D;

import org.jeometry.Jeometry;

/**
 * A spatial localization within a 3D space. Such an item is represented by a set of coordinates and a set of bounds.
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Jeometry#version}
 * @since 1.0.0
 */
public interface SpatialLocalization3D {

    /**
     * Get the X coordinate of this localization.
     * @return the X coordinate of this localization.
     */
    public double getX();

    /**
     * Get the Y coordinate of this localization.
     * @return the Y coordinate of this localization.
     */
    public double getY();

    /**
     * Get the Z coordinate of this localization.
     * @return the Z coordinate of this localization.
     */
    public double getZ();

    /**
     * Get the minimal X coordinate of this spatial item.
     * @return the minimal X coordinate of this spatial item.
     */
    public double getXMin();

    /**
     * Get the minimal Y coordinate of this spatial item.
     * @return the minimal Y coordinate of this spatial item.
     */
    public double getYMin();

    /**
     * Get the minimal Z coordinate of this spatial item.
     * @return the minimal Z coordinate of this spatial item.
     */
    public double getZMin();

    /**
     * Get the maximal X coordinate of this spatial item.
     * @return the maximal X coordinate of this spatial item.
     */
    public double getXMax();

    /**
     * Get the maximal Y coordinate of this spatial item.
     * @return the maximal Y coordinate of this spatial item.
     */
    public double getYMax();

    /**
     * Get the maximal Z coordinate of this spatial item.
     * @return the maximal Z coordinate of this spatial item.
     */
    public double getZMax();
    
    /**
     * Compute the distance between this spatial localization and the given one.
     * @param spatial the spatial localization.
     * @return the distance between this spatial localization and the given one or Double.Nan if the given spatial is null or if this localization is not known.
     */
    public double distance(SpatialLocalization3D spatial);
    
    /**
     * Update the localization values. It is implied that after a call to this method, all the informations given
     * by the spatial localization are consistent.
     */
    public void updateLocalization();
    
}