BodyPoint (patrimoine de base SIRIUS 4.13 API)

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Implementing Classes:

AbstractBodyPoint, EllipsoidPoint, FacetPoint
```
public interface BodyPoint
extends PVCoordinatesProvider
```
Interface for a point linked to a body. This point does not make any assumption about the shape of the body.
Instance of this class are guaranteed to be immutable.

Since:

4.12

Author:

Emmanuel Bignon

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class BodyPoint.BodyPointName
Class allowing to manage the default body point names.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BodyPoint.BodyPointName` Class allowing to manage the default body point names.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default double`	`angularSeparation(BodyPoint otherPoint)` Compute the angular separation, in radians, between the position of this and this of provided point, from the body frame origin.
`default double`	`distance(BodyPoint otherPoint)` Compute the cartesian distance, in meters, between the position of this and this of provided point.
`BodyShape`	`getBodyShape()` Get the `BodyShape` associated to this body point.
`BodyPoint`	`getClosestPointOnShape()` Returns the closest point to this on the shape surface.
`default LLHCoordinates`	`getLLHCoordinates()` Returns (after computation if not computed yet) the latitude/longitude/height coordinates of this in the associated body shape preferred coordinates system.
`LLHCoordinates`	`getLLHCoordinates(LLHCoordinatesSystem coordSystem)` Returns (after computation if not computed yet) the latitude/longitude/height coordinates of this in the requested coordinates system.
`String`	`getName()` Getter for the name of the point.
`default Frame`	`getNativeFrame(AbsoluteDate date)` Get the native frame, i.e.
`Vector3D`	`getNormal()` Get the normal direction, expressed in body frame, to the local horizontal plane at the point position, oriented towards the outside. It corresponds to the direction (apart from orientation) from this towards the closestPointOnShape.
`default Vector3D`	`getNormal(AbsoluteDate date, Frame frame)` Returns the normal direction expressed in the provided frame.
`double`	`getNormalHeight()` Returns the normal height, computed as the signed distance between the closestPointOnShape and this: Positive distance if this is outside the shape, Negative distance if this is inside the shape, Null distance if this is on the shape.
`Vector3D`	`getPosition()` Get the point cartesian position expressed in body frame.
`default PVCoordinates`	`getPVCoordinates(AbsoluteDate date, Frame frame)` Get the `PVCoordinates` of the body in the selected frame.
`BodyPoint`	`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.
`default boolean`	`isInsideShape()` Returns true if the point is located inside the shape, false otherwise.
`default boolean`	`isOnShapeSurface()` Returns true if point is on body shape surface (i.e.
`String`	`toString(LLHCoordinatesSystem coordSystem)` Getter for a string representing the object using the entered coordinates system. Note: the method may induce some computation if the coordinates have not been computed yet.

- Method Detail
  - getBodyShape
```
BodyShape getBodyShape()
```
    Get the BodyShape associated to this body point.
    
    Returns:
    
    BodyShape associated to this body point
  - getName
```
String getName()
```
    Getter for the name of the point.
    
    Returns:
    
    the name of the point.
  - getPosition
```
Vector3D getPosition()
```
    Get the point cartesian position expressed in body frame.
    
    Returns:
    
    point cartesian position in body frame
  - getNormal
```
Vector3D getNormal()
```
    Get the normal direction, expressed in body frame, to the local horizontal plane at the point position, oriented towards the outside.
    
    It corresponds to the direction (apart from orientation) from this towards the closestPointOnShape.
    
    Returns:
    
    unit vector in the normal direction
  - getNormalHeight
```
double getNormalHeight()
```
    Returns the normal height, computed as the signed distance between the closestPointOnShape and this:
    - Positive distance if this is outside the shape,
    - Negative distance if this is inside the shape,
    - Null distance if this is on the shape.
    Returns:
    
    the normal height
  - getClosestPointOnShape
```
BodyPoint getClosestPointOnShape()
```
    Returns the closest point to this on the shape surface.
    
    Returns:
    
    the closest point to this on the shape surface
  - getRadialProjectionOnShape
```
BodyPoint 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.
    
    Returns:
    
    the projection of this on the associated shape surface along the radial direction
  - isInsideShape
```
default boolean isInsideShape()
```
    Returns true if the point is located inside the shape, false otherwise. A point lying on the surface of the shape is considered to be in the shape.
    
    Returns:
    
    true if the point is located inside or on the shape, false otherwise
  - isOnShapeSurface
```
default boolean isOnShapeSurface()
```
    Returns true if point is on body shape surface (i.e. its normal height is smaller than the body shape altitude epsilon), false otherwise.
    
    Returns:
    
    true if point is on body shape surface, {@code false otherwise
  - getLLHCoordinates
```
default LLHCoordinates getLLHCoordinates()
```
    Returns (after computation if not computed yet) the latitude/longitude/height coordinates of this in the associated body shape preferred coordinates system.
    
    Returns:
    
    the lat/long/height coordinates as a LLHCoordinates
  - getLLHCoordinates
```
LLHCoordinates getLLHCoordinates(LLHCoordinatesSystem coordSystem)
```
    Returns (after computation if not computed yet) the latitude/longitude/height coordinates of this in the requested coordinates system.
    
    Parameters:
    
    coordSystem - requested coordinates system
    
    Returns:
    
    the lat/long/height coordinates as a LLHCoordinates
    
    Throws:
    
    IllegalArgumentException - if LLHCoordinatesSystem.ELLIPSODETIC with a not ellipsoidal body shape
  - distance
```
default double distance(BodyPoint otherPoint)
```
    Compute the cartesian distance, in meters, between the position of this and this of provided point.
    
    Parameters:
    
    otherPoint - other body point
    
    Returns:
    
    the angular distance
  - angularSeparation
```
default double angularSeparation(BodyPoint otherPoint)
```
    Compute the angular separation, in radians, between the position of this and this of provided point, from the body frame origin.
    
    Parameters:
    
    otherPoint - other body point
    
    Returns:
    
    the angular distance
  - getPVCoordinates
```
default PVCoordinates getPVCoordinates(AbsoluteDate date,
                                       Frame frame)
                                throws PatriusException
```
    Get the PVCoordinates of the body in the selected frame.
    
    Specified by:
    
    getPVCoordinates in interface PVCoordinatesProvider
    
    Parameters:
    
    date - current date
    
    frame - the frame where to define the position
    
    Returns:
    
    position/velocity of the body (m and m/s)
    
    Throws:
    
    PatriusException - if position cannot be computed in given frame
  - getNativeFrame
```
default Frame getNativeFrame(AbsoluteDate date)
                      throws PatriusException
```
    Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.
    
    Specified by:
    
    getNativeFrame in interface PVCoordinatesProvider
    
    Parameters:
    
    date - a date
    
    Returns:
    
    the native frame
    
    Throws:
    
    PatriusException - thrown if native frame is undefined or unknown
  - getNormal
```
default Vector3D getNormal(AbsoluteDate date,
                           Frame frame)
                    throws PatriusException
```
    Returns the normal direction expressed in the provided frame.
    
    Parameters:
    
    date - date
    
    frame - frame in which the normal direction must be expressed
    
    Returns:
    
    the normal direction expressed in the provided frame
    
    Throws:
    
    PatriusException - if frame transformation cannot be computed
  - toString
```
String toString(LLHCoordinatesSystem coordSystem)
```
    Getter for a string representing the object using the entered coordinates system.
    Note: the method may induce some computation if the coordinates have not been computed yet.
    
    Parameters:
    
    coordSystem - coordinates system to be used
    
    Returns:
    
    a string representing the object

Interface BodyPoint

Nested Class Summary

Method Summary

Method Detail

getBodyShape

getName

getPosition

getNormal

getNormalHeight

getClosestPointOnShape

getRadialProjectionOnShape

isInsideShape

isOnShapeSurface

getLLHCoordinates

getLLHCoordinates

distance

angularSeparation

getPVCoordinates

getNativeFrame

getNormal

toString