fr.cnes.sirius.patrius.bodies

Class EllipsoidPoint

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyPoint

fr.cnes.sirius.patrius.bodies.EllipsoidPoint

All Implemented Interfaces:

BodyPoint, PVCoordinatesProvider, Serializable

public class EllipsoidPoint
extends AbstractBodyPoint

Point location relative to a 2D body surface of type EllipsoidBodyShape.

Instance of this class are guaranteed to be immutable.

Since:

4.12

Author:

Emmanuel Bignon

See Also:

AbstractBodyPoint, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.BodyPoint

BodyPoint.BodyPointName

Constructor Summary

Constructors

Modifier	Constructor and Description
	EllipsoidPoint(EllipsoidBodyShape bodyShape, LLHCoordinates coordIn, String name) Constructor from lat/long/height coordinates.
	EllipsoidPoint(EllipsoidBodyShape bodyShape, LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height, String name) Constructor from lat/long/height coordinates.
protected	EllipsoidPoint(EllipsoidBodyShape bodyShape, Vector3D position, boolean onShapeSurface, String name) Protected constructor from a position and a flag stating if the point is known to be on the shape: if the latter is set true, the normal height is set to 0 and the closest and radial projections on the shape are set equal to this.
	EllipsoidPoint(EllipsoidBodyShape bodyShape, Vector3D position, Frame frame, AbsoluteDate date, String name) Constructor from a position expressed in any given frame.
	EllipsoidPoint(EllipsoidBodyShape bodyShape, Vector3D position, String name) Constructor from a position.

Method Summary

Modifier and Type	Method and Description
protected Vector3D	computeNormal() Method to compute normal direction in body frame, to be implemented in each specific child class of AbstractBodyPoint.
EllipsoidBodyShape	getBodyShape() Get the BodyShape associated to this body point.
EllipsoidPoint	getClosestPointOnShape() Returns the closest point to this on the shape surface.
EllipsoidPoint	getRadialProjectionOnShape() Returns the body point, on the associated shape surface, in the radial direction corresponding to the position of this: if several of them (may happen for not star-convex shapes), the method considers the one farthest to the body frame origin (having the largest norm).
protected void	setClosestPointOnShape(BodyPoint closestOnShape) Setter for the entered body point as closest point on shape.

Methods inherited from class fr.cnes.sirius.patrius.bodies.AbstractBodyPoint

computePositionHeightCoordinateSignum, getLLHCoordinates, getName, getNormal, getNormalHeight, getPosition, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.bodies.BodyPoint

angularSeparation, distance, getLLHCoordinates, getNativeFrame, getNormal, getPVCoordinates, isInsideShape, isOnShapeSurface

Constructor Detail

EllipsoidPoint

public EllipsoidPoint(EllipsoidBodyShape bodyShape,
                      LLHCoordinatesSystem coordSystem,
                      double latitude,
                      double longitude,
                      double height,
                      String name)

Constructor from lat/long/height coordinates.

Parameters:

bodyShape - body shape on which the point is defined

coordSystem - LLH coordinates system in which are expressed the entered lat/long/height

latitude - input latitude

longitude - input longitude

height - input height

name - name of the point

EllipsoidPoint

public EllipsoidPoint(EllipsoidBodyShape bodyShape,
                      LLHCoordinates coordIn,
                      String name)

Constructor from lat/long/height coordinates.

Parameters:

bodyShape - body shape on which the point is defined

coordIn - lat/long/height coordinates associated with the coordinates system in which they are expressed

name - name of the point

EllipsoidPoint

public EllipsoidPoint(EllipsoidBodyShape bodyShape,
                      Vector3D position,
                      String name)

Constructor from a position.

Parameters:

bodyShape - body shape on which the point is defined

position - point position in body frame

name - name of the point

EllipsoidPoint

public EllipsoidPoint(EllipsoidBodyShape bodyShape,
                      Vector3D position,
                      Frame frame,
                      AbsoluteDate date,
                      String name)
               throws PatriusException

Constructor from a position expressed in any given frame.

Parameters:

bodyShape - body shape on which the point is defined

position - position in provided frame at provided date

frame - frame

date - date

name - name of the point

Throws:

PatriusException - if frame transformation cannot be computed at provided date

EllipsoidPoint

protected EllipsoidPoint(EllipsoidBodyShape bodyShape,
                         Vector3D position,
                         boolean onShapeSurface,
                         String name)

Protected constructor from a position and a flag stating if the point is known to be on the shape: if the latter is set true, the normal height is set to 0 and the closest and radial projections on the shape are set equal to this.

Parameters:

bodyShape - body shape on which the point is defined

position - point position in body frame

onShapeSurface - flag to be set to true value if the point is known to be on the shape

name - name of the point

Method Detail

getBodyShape

public EllipsoidBodyShape getBodyShape()

Get the BodyShape associated to this body point.

Specified by:

getBodyShape in interface BodyPoint

Overrides:

getBodyShape in class AbstractBodyPoint

Returns:

BodyShape associated to this body point

getRadialProjectionOnShape

public EllipsoidPoint getRadialProjectionOnShape()

Returns the body point, on the associated shape surface, in the radial direction corresponding to the position of this: if several of them (may happen for not star-convex shapes), the method considers the one farthest to the body frame origin (having the largest norm).
Warnings: the returned point is not necessary the closest point belonging to the shape in the radial direction.

Specified by:

getRadialProjectionOnShape in interface BodyPoint

Overrides:

getRadialProjectionOnShape in class AbstractBodyPoint

Returns:

the projection of this on the associated shape surface along the radial direction

getClosestPointOnShape

public EllipsoidPoint getClosestPointOnShape()

Returns the closest point to this on the shape surface.

Specified by:

getClosestPointOnShape in interface BodyPoint

Overrides:

getClosestPointOnShape in class AbstractBodyPoint

Returns:

the closest point to this on the shape surface

setClosestPointOnShape

protected void setClosestPointOnShape(BodyPoint closestOnShape)

Setter for the entered body point as closest point on shape.

Overrides:

setClosestPointOnShape in class AbstractBodyPoint

Parameters:

closestOnShape - body point to be set

Throws:

IllegalArgumentException - if the entered body point is not an EllipsoidPoint instance

computeNormal

protected final Vector3D computeNormal()

Method to compute normal direction in body frame, to be implemented in each specific child class of AbstractBodyPoint. Associated getter AbstractBodyPoint.getNormal() is implemented in this class in order to handle lazy initialization of this attribute.
The returned vector does not need to be normalized (normalization managed by method AbstractBodyPoint.getNormal()).

Specified by:

computeNormal in class AbstractBodyPoint

Returns:

normal direction in body frame