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

java.lang.Object
  org.apache.commons.math3.geometry.euclidean.threed.Ellipsoid
      org.apache.commons.math3.geometry.euclidean.threed.Spheroid

All Implemented Interfaces:

Serializable, IEllipsoid, Shape, SolidShape

public final class Spheroid
extends Ellipsoid
implements Serializable

This is the Spheroid (also called Revolved Ellipsoid) class. Spheroids are ellipsoids that are revolved around an axis. Thus, this class cannot represent all ellipsoid objects.

It creates a spheroid object.

Usage: With two Vector3D for position and Rev. Axis and two doubles for the two semi axes, call

Spheroid mySpheroid = new Spheroid(position, axis, a, b)

Since:

1.0

Version:

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

Author:

Rami Houdroge

See Also:

IEllipsoid, SolidShape, Serialized Form

Concurrency :

immutable

Constructor Summary

Spheroid(Vector3D myPosition, Vector3D myRevAxis, double myA, double myB)
This constructor builds a spheroid from its centers position, its revolution axis and its transverse and conjugate radii.

Method Summary

double	getConjugateRadius() Get conjugate radius of Spheroid
double	getTransverseRadius() Get transverse radius of Spheroid
String	toString() Get a representation for this spheroid.

Methods inherited from class org.apache.commons.math3.geometry.euclidean.threed.Ellipsoid

closestPointTo, closestPointTo, distanceTo, distanceTo, getAffineLocalExpression, getAffineStandardExpression, getCartesianCoordinates, getCenter, getEllipsoidicCoordinates, getIntersectionPoints, getLocalBasisTransform, getNormal, getSemiA, getSemiB, getSemiC, getSemiPrincipalX, getSemiPrincipalY, getSemiPrincipalZ, getStandardBasisTransform, getVectorialLocalExpression, getVectorialStandardExpression, intersects

Methods inherited from class java.lang.Object

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

Constructor Detail

Spheroid

public Spheroid(Vector3D myPosition,
                Vector3D myRevAxis,
                double myA,
                double myB)

This constructor builds a spheroid from its centers position, its revolution axis and its transverse and conjugate radii. A spheroid, or ellipsoid of revolution, is a quadric surface obtained by rotating an ellipse about one of its principal axes.

Parameters:

myPosition - The position of the spheroids center

myRevAxis - The axis of revolution of the spheroid

myA - Transverse radius : semi axis of the spheroid along a direction orthogonal to the axis of revolution

myB - Conjugate radius : semi axis of the spheroid along the axis of revolution

Throws:

IllegalArgumentException - if semi-axis or norm of revolution axis is null

Since:

1.0

Method Detail

getTransverseRadius

public double getTransverseRadius()

Get transverse radius of Spheroid

Returns:

a transverse radius value

getConjugateRadius

public double getConjugateRadius()

Get conjugate radius of Spheroid

Returns:

b conjugate radius value

toString

public String toString()

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

Overrides:

toString in class Ellipsoid

Returns:

a representation for this spheroid