org.djutils.draw.line.Ray3d 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
Show all versions of djutils-draw Show documentation
DJUTILS - Delft Java Utilities Drawing and animation primitives
The newest version!
package org.djutils.draw.line;
import java.util.Arrays;
import java.util.Iterator;
import java.util.Locale;
import org.djutils.base.AngleUtil;
import org.djutils.draw.DrawRuntimeException;
import org.djutils.draw.Drawable3d;
import org.djutils.draw.bounds.Bounds3d;
import org.djutils.draw.point.DirectedPoint3d;
import org.djutils.draw.point.Point3d;
import org.djutils.exceptions.Throw;
/**
* Ray3d is a half-line; it has one end point with non-infinite coordinates; the other end point is infinitely far away.
*
* 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
*/
public class Ray3d extends DirectedPoint3d implements Drawable3d, Ray
{
/** */
private static final long serialVersionUID = 20210119L;
/**
* Construct a new Ray3d.
* @param x double; the x coordinate of the finite end point of the ray
* @param y double; the y coordinate of the finite end point of the ray
* @param z double; the z coordinate of the finite end point of the ray
* @param dirY double; the angle from the positive Z axis direction in radians (the complement of the slope)
* @param dirZ double; the angle from the positive X axis direction in radians
* @throws IllegalArgumentException when dirY, or dirZ is NaN (should be impossible)
*/
public Ray3d(final double x, final double y, final double z, final double dirY, final double dirZ)
throws IllegalArgumentException
{
super(x, y, z, dirY, dirZ);
}
/**
* Create a new Ray3d from x, y, and z coordinates packed in a double array of three elements and direction dirY,dirZ.
* @param xyz double[]; the x, y and z coordinates in that order
* @param dirY double; the angle from the positive Z axis direction in radians (the complement of the slope)
* @param dirZ double; the angle from the positive X axis direction in radians
* @throws NullPointerException when xyx is null
* @throws IllegalArgumentException when the length of the xyz array is not 3, or contains a NaN value, or
* dirY, or dirZ is NaN
*/
public Ray3d(final double[] xyz, final double dirY, final double dirZ) throws NullPointerException, IllegalArgumentException
{
super(xyz, dirY, dirZ);
}
/**
* Construct a new Ray3d.
* @param point Point3d; the finite end point of the ray
* @param dirY double; the angle from the positive Z axis direction in radians (the complement of the slope)
* @param dirZ double; the angle from the positive X axis direction in radians
* @throws NullPointerException when point is null
* @throws IllegalArgumentException when dirY, or dirZ is NaN
*/
public Ray3d(final Point3d point, final double dirY, final double dirZ)
throws NullPointerException, IllegalArgumentException
{
super(point, dirY, dirZ);
}
/**
* Construct a new Ray3d.
* @param x double; the x coordinate of the finite end point of the ray
* @param y double; the y coordinate of the finite end point of the ray
* @param z double; the z coordinate of the finite end point of the ray
* @param throughX double; the x coordinate of another point on the ray
* @param throughY double; the y coordinate of another point on the ray
* @param throughZ double; the z coordinate of another point on the ray
* @throws DrawRuntimeException when throughX == x and throughY == y and throughZ == z, or any through-value is NaN
*/
public Ray3d(final double x, final double y, final double z, final double throughX, final double throughY,
final double throughZ) throws DrawRuntimeException
{
super(x, y, z, throughX, throughY, throughZ);
}
/**
* Construct a new Ray3d.
* @param point Point3d; the finite end point of the ray
* @param throughX double; the x coordinate of another point on the ray
* @param throughY double; the y coordinate of another point on the ray
* @param throughZ double; the z coordinate of another point on the ray
* @throws NullPointerException when point is null
* @throws DrawRuntimeException when throughX == point.x and throughY == point.y and point.z == throughZ, or any
* through-value is NaN
*/
public Ray3d(final Point3d point, final double throughX, final double throughY, final double throughZ)
throws NullPointerException, DrawRuntimeException
{
super(point, throughX, throughY, throughZ);
}
/**
* Create a new Ray3d with x, y, and z coordinates and orientation specified using a double array of three elements
* (containing dirX,dirY,dirZ in that order).
* @param x double; the x coordinate
* @param y double; the y coordinate
* @param z double; the z coordinate
* @param orientation double[]; the two direction values in a double array containing dirY and dirZ in that order. DirY is
* the rotation from the positive z-axis to the direction. DirZ is the angle from the positive x-axis to the
* projection of the direction in the x-y-plane.
* @throws NullPointerException when orientation is null
* @throws IllegalArgumentException when the length of the direction array is not 2, or contains a NaN value
*/
public Ray3d(final double x, final double y, final double z, final double[] orientation)
throws NullPointerException, IllegalArgumentException
{
super(x, y, z, orientation);
}
/**
* Create a new Rayt3d from x, y, and z coordinates packed in a double array of three elements and a direction specified
* using a double array of two elements.
* @param xyz double[]; the x, y and z coordinates in that order
* @param orientation double[]; the two orientation angles dirY and dirZ in that order
* @throws NullPointerException when xyx or orientation is null
* @throws IllegalArgumentException when the length of the xyx array is not 3 or the length of the
* orientation array is not 2
*/
public Ray3d(final double[] xyz, final double[] orientation) throws NullPointerException, IllegalArgumentException
{
super(xyz, orientation);
}
/**
* Construct a new Ray3d.
* @param x double; the x coordinate of the finite end point of the ray
* @param y double; the y coordinate of the finite end point of the ray
* @param z double; the z coordinate of the finite end point of the ray
* @param throughPoint Point3d; another point on the ray
* @throws NullPointerException when throughPoint is null
* @throws DrawRuntimeException when throughPoint is exactly at (x, y)
*/
public Ray3d(final double x, final double y, final double z, final Point3d throughPoint)
throws NullPointerException, DrawRuntimeException
{
super(x, y, z, throughPoint);
}
/**
* Construct a new Ray3d.
* @param point Point3d; the finite end point of the ray
* @param throughPoint Point3d; another point on the ray
* @throws NullPointerException when point is null or throughPoint is null
* @throws DrawRuntimeException when throughPoint is exactly at point
*/
public Ray3d(final Point3d point, final Point3d throughPoint) throws NullPointerException, DrawRuntimeException
{
super(point, throughPoint);
}
/**
* Construct a new Ray3d.
* @param directedPoint DirectedPoint3d; point and direction of the new Ray3d
*/
public Ray3d(final DirectedPoint3d directedPoint)
{
this(directedPoint, directedPoint.dirY, directedPoint.dirZ);
}
@Override
public final double getDirY()
{
return this.dirY;
}
@Override
public final double getDirZ()
{
return this.dirZ;
}
@Override
public DirectedPoint3d getEndPoint()
{
return this;
}
@Override
public int size()
{
return 2;
}
@Override
public Iterator getPoints()
{
double sinDirZ = Math.sin(this.dirZ);
double cosDirZ = Math.cos(this.dirZ);
double sinDirY = Math.sin(this.dirY);
double cosDirY = Math.cos(this.dirY);
DirectedPoint3d[] array = new DirectedPoint3d[] {this,
new DirectedPoint3d(cosDirZ * sinDirY == 0 ? this.x : cosDirZ * sinDirY * Double.POSITIVE_INFINITY,
cosDirZ * sinDirZ == 0 ? this.y : cosDirZ * sinDirZ * Double.POSITIVE_INFINITY,
cosDirY == 0 ? this.z : cosDirY * Double.POSITIVE_INFINITY, this.dirZ, this.dirY)};
return Arrays.stream(array).iterator();
}
@Override
public Bounds3d getBounds()
{
double sinDirZ = Math.sin(this.dirZ);
double cosDirZ = Math.cos(this.dirZ);
double sinDirY = Math.sin(this.dirY);
double cosDirY = Math.cos(this.dirY);
return new Bounds3d(cosDirZ * sinDirY >= 0 ? this.x : Double.NEGATIVE_INFINITY,
cosDirZ * sinDirY <= 0 ? this.x : Double.POSITIVE_INFINITY,
sinDirZ * sinDirY >= 0 ? this.y : Double.NEGATIVE_INFINITY,
sinDirZ * sinDirY <= 0 ? this.y : Double.POSITIVE_INFINITY, cosDirY >= 0 ? this.z : Double.NEGATIVE_INFINITY,
cosDirY <= 0 ? this.z : Double.POSITIVE_INFINITY);
}
@Override
public Ray3d neg()
{
return new Ray3d(-this.x, -this.y, -this.z, AngleUtil.normalizeAroundZero(this.dirY + Math.PI),
AngleUtil.normalizeAroundZero(this.dirZ + Math.PI));
}
@Override
public Ray3d flip()
{
return new Ray3d(this.x, this.y, this.z, AngleUtil.normalizeAroundZero(Math.PI - this.dirY),
AngleUtil.normalizeAroundZero(this.dirZ + Math.PI));
}
@Override
public Ray3d getLocationExtended(final double position) throws DrawRuntimeException
{
Throw.when(Double.isNaN(position) || Double.isInfinite(position), DrawRuntimeException.class,
"position must be finite");
double sinDirY = Math.sin(this.dirY);
double dX = Math.cos(this.dirZ) * sinDirY;
double dY = Math.sin(this.dirZ) * sinDirY;
double dZ = Math.cos(this.dirY);
return new Ray3d(this.x + dX * position, this.y + dY * position, this.z + dZ * position, this.dirY, this.dirZ);
}
@Override
public Point3d closestPointOnRay(final Point3d point) throws NullPointerException
{
Throw.whenNull(point, "point");
double sinDirY = Math.sin(this.dirY);
return point.closestPointOnLine(this.x, this.y, this.z, this.x + Math.cos(this.dirZ) * sinDirY,
this.y + Math.sin(this.dirZ) * sinDirY, this.z + Math.cos(this.dirY), true, false);
}
@Override
public Point3d projectOrthogonal(final Point3d point) throws NullPointerException
{
Throw.whenNull(point, "point");
double sinDirY = Math.sin(this.dirY);
return point.closestPointOnLine(this.x, this.y, this.z, this.x + Math.cos(this.dirZ) * sinDirY,
this.y + Math.sin(this.dirZ) * sinDirY, this.z + Math.cos(this.dirY), null, false);
}
@Override
public Point3d projectOrthogonalExtended(final Point3d point)
{
Throw.whenNull(point, "point");
double sinDirY = Math.sin(this.dirY);
return point.closestPointOnLine(getX(), getY(), getZ(), getX() + Math.cos(this.dirZ) * sinDirY,
getY() + Math.sin(this.dirZ) * sinDirY, getZ() + Math.cos(this.dirY), false, false);
}
@Override
public double projectOrthogonalFractional(final Point3d point) throws NullPointerException
{
Throw.whenNull(point, "point");
double sinDirY = Math.sin(this.dirY);
return point.fractionalPositionOnLine(this.x, this.y, this.z, this.x + Math.cos(this.dirZ) * sinDirY,
this.y + Math.sin(this.dirZ) * sinDirY, this.z + Math.cos(this.dirY), null, false);
}
@Override
public double projectOrthogonalFractionalExtended(final Point3d point) throws NullPointerException
{
Throw.whenNull(point, "point");
double sinDirY = Math.sin(this.dirY);
return point.fractionalPositionOnLine(getX(), getY(), getZ(), getX() + Math.cos(this.dirZ) * sinDirY,
getY() + Math.sin(this.dirZ) * sinDirY, getZ() + Math.cos(this.dirY), false, false);
}
@Override
public String toString()
{
return toString("%f", false);
}
@Override
public String toString(final String doubleFormat, final boolean doNotIncludeClassName)
{
String format = String.format("%1$s[x=%2$s, y=%2$s, z=%2$s, dirY=%2$s, dirZ=%2$s]",
doNotIncludeClassName ? "" : "Ray3d ", doubleFormat);
return String.format(Locale.US, format, this.x, this.y, this.z, this.dirY, this.dirZ);
}
@Override
public int hashCode()
{
return super.hashCode();
}
@Override
@SuppressWarnings("checkstyle:needbraces")
public boolean equals(final Object obj)
{
if (this == obj)
return true;
if (!super.equals(obj))
return false;
if (getClass() != obj.getClass())
return false;
return true;
}
}