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

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

All Implemented Interfaces:

Serializable, Cone, Shape, SolidShape

public final class RectangleCone
extends Object
implements Cone, Serializable

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

Since:

1.0

Version:

$Id: RectangleCone.java 11374 2014-10-30 15:39:29Z sabatini $

Author:

Thomas Trapier

See Also:

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

Use sample :

Creation with two dimensions, a length and three Vector3D : Vector3D origin = new Vector3D(1.0, 6.0, -2.0); Vector3D direction = new Vector3D(6.0, -3.0, -1.0); Vector3D uVector = new Vector3D(-5.0, 3.0, 0.0); double length = 2.0; double width = 4.0; double height = 5.0; RectangleCone cone = new RectangleCone(origin, direction, uVector, length, width, height); Intersection with a line : boolean intersects = cone(line);

Concurrency :

immutable

Constructor Summary

RectangleCone(Vector3D inOrigin, Vector3D inDirection, Vector3D inUvector, double inLength, double inWidth, double inHeight)
Build a rectangle cone from its apex (origin), axis' direction, approximative U vector of the local frame and dimensions.

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.
Vector3D	getDirection()
double	getHeight()
Vector3D[]	getIntersectionPoints(Line line) Compute the intersection points with a line.
double	getLength()
Vector3D	getOrigin()
Vector3D	getU()
Vector3D	getV()
double	getWidth()
boolean	intersects(Line line) Tests the intersection with a line.
String	toString() Get a representation for this rectangle cone.

Methods inherited from class java.lang.Object

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

Constructor Detail

RectangleCone

public RectangleCone(Vector3D inOrigin,
                     Vector3D inDirection,
                     Vector3D inUvector,
                     double inLength,
                     double inWidth,
                     double inHeight)

Build a rectangle cone from its apex (origin), axis' direction, approximative U vector of the local frame and dimensions.

Parameters:

inOrigin - the cone's origin

inDirection - the cone's direction

inUvector - the cone's approximative U vector : corrected to be orthogonal to the direction

inLength - the basis' length

inWidth - the basis' width

inHeight - the cone's height on its axis

Method Detail

getOrigin

public Vector3D getOrigin()

Returns:

the origin

getHeight

public double getHeight()

Returns:

the height

getLength

public double getLength()

Returns:

the length

getWidth

public double getWidth()

Returns:

the width

getDirection

public Vector3D getDirection()

Returns:

the direction

getU

public Vector3D getU()

Returns:

the u vector of the local frame

getV

public Vector3D getV()

Returns:

the v vector of the local frame

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

Overrides:

toString in class Object

Returns:

a representation for this rectangle cone