org.apache.commons.math3.geometry.euclidean.threed
Class InfiniteRightCircularCone

java.lang.Object
  org.apache.commons.math3.geometry.euclidean.threed.InfiniteRightCircularCone

All Implemented Interfaces:

Serializable, InfiniteCone, InfiniteShape, Shape

public final class InfiniteRightCircularCone
extends Object
implements InfiniteCone, Serializable

This is a describing class for a 3D infinite cone, with some algorithm to compute intersections and distances to some other objects.

Since:

1.0

Version:

$Id: InfiniteRightCircularCone.java 17583 2017-05-10 13:05:10Z bignon $

Author:

Thomas Trapier

See Also:

Shape.distanceTo(Line), Shape.intersects(Line), Serialized Form

Use sample :

Creation with an angle and two Vector3D : Vector3D origin = new Vector3D(1.0, 6.0, -2.0); Vector3D axis = new Vector3D(6.0, -3.0, -1.0); InfiniteEllipticCone cone = new InfiniteEllipticCone(origin, axis; FastMath.PI / 4.0); Intersection with a line : boolean intersects = cone(line);

Concurrency :

immutable

Constructor Summary

InfiniteRightCircularCone(Vector3D inOrigin, Vector3D inDirection, double inAngle)
Build an infinite elliptic cone from its angle, the position of its origin and its axis

Method Summary

Vector3D[]	closestPointTo(Line line) Computes the points of the shape and the line realizing the shortest distance.
double	distanceTo(Line line) Computes the distance to a line.
double	getAngle()
Vector3D	getAxis()
Vector3D[]	getIntersectionPoints(Line line) Compute the intersection points with a line.
Vector3D	getOrigin()
boolean	intersects(Line line) Tests the intersection with a line.
String	toString() Get a representation for this infinite elliptic cone.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InfiniteRightCircularCone

public InfiniteRightCircularCone(Vector3D inOrigin,
                                 Vector3D inDirection,
                                 double inAngle)

Build an infinite elliptic cone from its angle, the position of its origin and its axis

Parameters:

inOrigin - the origin of the cone

inDirection - the direction : axis of the cone

inAngle - the angle of the cone

Throws:

IllegalArgumentException - if the angle is not between 0.0 and PI/4 or if the axis has a null norm

Method Detail

getOrigin

public Vector3D getOrigin()

Specified by:

getOrigin in interface InfiniteCone

Returns:

the origin

getAxis

public Vector3D getAxis()

Returns:

the axis

getAngle

public double getAngle()

Returns:

the angle

intersects

public boolean intersects(Line line)

Tests the intersection with a line.

Specified by:

intersects in interface Shape

Parameters:

line - the line

Returns:

true if the line intersects the shape

getIntersectionPoints

public Vector3D[] getIntersectionPoints(Line line)

Compute the intersection points with a line.

Specified by:

getIntersectionPoints in interface Shape

Parameters:

line - the line

Returns:

the intersection points if they exist. If no intersection is found, the dimension is zero

distanceTo

public double distanceTo(Line line)

Computes the distance to a line.

Specified by:

distanceTo in interface Shape

Parameters:

line - the line

Returns:

the shortest distance between the the line and the shape

closestPointTo

public Vector3D[] closestPointTo(Line line)

Computes the points of the shape and the line realizing the shortest distance. If the line intersects the shape, the returned points are identical : this point is the first common point found.

Specified by:

closestPointTo in interface Shape

Parameters:

line - the line

Returns:

the two points : first the one from the line, and the one from the shape.

toString

public String toString()

Get a representation for this infinite elliptic cone. The given parameters are in the same order as in the constructor.

Overrides:

toString in class Object

Returns:

a representation for this infinite elliptic cone