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

Class RightParallelepiped

java.lang.Object

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

All Implemented Interfaces:

CrossSectionProvider, Serializable

public class RightParallelepiped
extends Object
implements CrossSectionProvider, Serializable

Right parallelepiped shape.

Since:

4.1

Version:

$Id: NthOccurrenceDetector.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RightParallelepiped(double surfXIn, double surfYIn, double surfZIn) Creates a new instance of a parallelepiped.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
double	getCrossSection(Vector3D direction) Computes the cross section from the direction defined by a Vector3D.
double	getHeight() Get z direction dimension (m).
static double	getHeightFromSurfs(double surfX, double surfY, double surfZ) Get parallelepiped height (Z direction dimension).
double	getLength() Get x direction dimension (m).
static double	getLengthFromSurfs(double surfX, double surfY, double surfZ) Get parallelepiped length (X direction dimension).
double	getSurfX() Get surface perpendicular to X axis.
double	getSurfY() Get surface perpendicular to Y axis.
double	getSurfZ() Get surface perpendicular to Z axis.
double	getWidth() Get y direction dimension (m).
static double	getWidthFromSurfs(double surfX, double surfY, double surfZ) Get parallelepiped width (Y direction dimension).
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RightParallelepiped

public RightParallelepiped(double surfXIn,
                           double surfYIn,
                           double surfZIn)

Creates a new instance of a parallelepiped.

Parameters:

surfXIn - surface perpendicular to X axis (m2)

surfYIn - surface perpendicular to Y axis (m2)

surfZIn - surface perpendicular to Z axis (m2)

Method Detail

getCrossSection

public double getCrossSection(Vector3D direction)
                       throws ArithmeticException

Computes the cross section from the direction defined by a Vector3D.

Specified by:

getCrossSection in interface CrossSectionProvider

Parameters:

direction - the direction vector

Returns:

the cross section

Throws:

ArithmeticException - if in direction, x, y or z are NaN or if they are all 0

getSurfX

public double getSurfX()

Get surface perpendicular to X axis.

Returns:

the surface perpendicular to X axis

getSurfY

public double getSurfY()

Get surface perpendicular to Y axis.

Returns:

the surface perpendicular to Y axis

getSurfZ

public double getSurfZ()

Get surface perpendicular to Z axis.

Returns:

the surface perpendicular to Z axis

getLength

public double getLength()
                 throws IllegalArgumentException

Get x direction dimension (m).

Returns:

the length (x direction dimension)

Throws:

IllegalArgumentException - if surfX is negative or zero (undetermined Length)

getWidth

public double getWidth()
                throws IllegalArgumentException

Get y direction dimension (m).

Returns:

the width (y direction dimension)

Throws:

IllegalArgumentException - if surfZ is negative or zero (undetermined Width)

getHeight

public double getHeight()
                 throws IllegalArgumentException

Get z direction dimension (m).

Returns:

the height (z direction dimension)

Throws:

IllegalArgumentException - if surfZ is negative or zero (undetermined height)

getLengthFromSurfs

public static double getLengthFromSurfs(double surfX,
                                        double surfY,
                                        double surfZ)
                                 throws IllegalArgumentException

Get parallelepiped length (X direction dimension).

Parameters:

surfX - surface perpendicular to X axis

surfY - surface perpendicular to Y axis

surfZ - surface perpendicular to Z axis

Returns:

the parallelepiped length (X direction dimension)

Throws:

IllegalArgumentException - if surfX is negative or zero (undetermined Length)

getWidthFromSurfs

public static double getWidthFromSurfs(double surfX,
                                       double surfY,
                                       double surfZ)
                                throws IllegalArgumentException

Get parallelepiped width (Y direction dimension).

Parameters:

surfX - surface perpendicular to X axis

surfY - surface perpendicular to Y axis

surfZ - surface perpendicular to Z axis

Returns:

the parallelepiped width (y direction dimension)

Throws:

IllegalArgumentException - if Z surface is negative or zero (undetermined Width)

getHeightFromSurfs

public static double getHeightFromSurfs(double surfX,
                                        double surfY,
                                        double surfZ)
                                 throws IllegalArgumentException

Get parallelepiped height (Z direction dimension).

Parameters:

surfX - surface perpendicular to X axis

surfY - surface perpendicular to Y axis

surfZ - surface perpendicular to Z axis

Returns:

the parallelepiped height (Z direction dimension)

Throws:

IllegalArgumentException - if Z surface is negative or zero (undetermined height)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object