fr.cnes.sirius.patrius.math.geometry.euclidean.threed

Class RightCircularCone

java.lang.Object

fr.cnes.sirius.patrius.math.geometry.euclidean.threed.RightCircularCone

All Implemented Interfaces:

Cone, Shape, SolidShape, Serializable

public final class RightCircularCone
extends Object
implements Cone, Serializable

This is a describing class for a 3D right circular cone ended by a plane normal to its axis, with some algorithm to compute intersections and distances to some other objects.

Since:

1.0

Version:

$Id: RightCircularCone.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, a height and two Vector3D : Vector3D origin = new Vector3D(1.0, 6.0, -2.0); Vector3D direction = new Vector3D(6.0, -3.0, -1.0); double angle = 2.0; double height = 5.0; EllipticCone cone = new EllipticCone(origin, direction, angle, height); Intersection with a line : boolean intersects = cone(line);

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
RightCircularCone(Vector3D inOrigin, Vector3D inDirection, double inAngle, double inLength) Build a elliptic cone from its radius, the height, the origin (apex) and direction of its axis

Method Summary

Modifier and Type	Method and Description
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	getDirection()
Vector3D[]	getIntersectionPoints(Line line) Compute the intersection points with a line.
double	getLength()
Vector3D	getOrigin()
boolean	intersects(Line line) Tests the intersection with a line.
String	toString() Get a representation for this elliptic cone.

Methods inherited from class java.lang.Object

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

Constructor Detail

RightCircularCone

public RightCircularCone(Vector3D inOrigin,
                         Vector3D inDirection,
                         double inAngle,
                         double inLength)

Build a elliptic cone from its radius, the height, the origin (apex) and direction of its axis

Parameters:

inOrigin - the origin of the axis

inDirection - the direction of the axis

inAngle - the angle of the cone

inLength - the height of the cone on its axis

Throws:

IllegalArgumentException - if the angle or the height is negative or null, or if the direction vector has a null norm.

Method Detail

getLength

public double getLength()

Returns:

the height

getOrigin

public Vector3D getOrigin()

Returns:

the origin

getAngle

public double getAngle()

Returns:

the angle

getDirection

public Vector3D getDirection()

Returns:

the direction

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 elliptic cone. The given parameters are in the same order as in the constructor.

Overrides:

toString in class Object

Returns:

a representation for this elliptic cone