fr.cnes.sirius.patrius.bodies.mesh

Class FacetPoint

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyPoint

fr.cnes.sirius.patrius.bodies.mesh.FacetPoint

All Implemented Interfaces:

BodyPoint, PVCoordinatesProvider, Serializable

public class FacetPoint
extends AbstractBodyPoint

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

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
protected	FacetPoint(FacetBodyShape bodyShape, Intersection intersection, String name) Protected constructor from an Intersection object.
	FacetPoint(FacetBodyShape bodyShape, LLHCoordinates coordIn, String name) Constructor from lat/long/height coordinates. Warning: Be aware of following limitations when using an LLH coordinates system using the normal height convention (typically the LLHCoordinatesSystem.BODYCENTRIC_NORMAL system): Some regions of the space are not accessible with such a system: indeed, the accessible regions are limited to the vertical lines from any point at the shape surface (lines intersecting the shape surface, with a direction aligned with the local normal direction on the intersection point). When the closest point on shape is either a vertex or placed at the boundary between two facets (on a shape segment), an infinity of points share the same lat/long/normalHeight coordinates (see illustration below in 2D, to be transposed in 3D). Points on some regions of space can be built from several different lat/long/normal height coordinates.
	FacetPoint(FacetBodyShape bodyShape, LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height, String name) Constructor from lat/long/height coordinates. Warning: Be aware of following limitations when using an LLH coordinates system using the normal height convention (typically the LLHCoordinatesSystem.BODYCENTRIC_NORMAL system): Some regions of the space are not accessible with such a system: indeed, the accessible regions are limited to the vertical lines from any point at the shape surface (lines intersecting the shape surface, with a direction aligned with the local normal direction on the intersection point). When the closest point on shape is either a vertex or placed at the boundary between two facets (on a shape segment), an infinity of points share the same lat/long/normalHeight coordinates (see illustration below in 2D, to be transposed in 3D). Points on some regions of space can be built from several different lat/long/normal height coordinates.
	FacetPoint(FacetBodyShape bodyShape, Vector3D position, Frame frame, AbsoluteDate date, String name) Constructor from a position expressed in any given frame.
protected	FacetPoint(FacetBodyShape bodyShape, Vector3D position, List<Triangle> closestTriangles, boolean onTheShape, String name) Protected constructor from a position, a list of closest triangles 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.
	FacetPoint(FacetBodyShape 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.
FacetBodyShape	getBodyShape() Get the BodyShape associated to this body point.
FacetPoint	getClosestPointOnShape() Returns the closest point to this on the shape surface.
List<Triangle>	getClosestTriangles() Get the list of shape triangles closest to this.
FacetPoint	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.
protected void	setClosestPointOnShape(BodyPoint closestOnShape) Setter for the entered body point as closest point on shape.
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 and/or the closest triangles have not been computed yet.

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

computePositionHeightCoordinateSignum, getLLHCoordinates, getName, getNormal, getNormalHeight, getPosition, 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

FacetPoint

public FacetPoint(FacetBodyShape bodyShape,
                  LLHCoordinatesSystem coordSystem,
                  double latitude,
                  double longitude,
                  double height,
                  String name)

Constructor from lat/long/height coordinates.
Warning: Be aware of following limitations when using an LLH coordinates system using the normal height convention (typically the LLHCoordinatesSystem.BODYCENTRIC_NORMAL system):

• Some regions of the space are not accessible with such a system: indeed, the accessible regions are limited to the vertical lines from any point at the shape surface (lines intersecting the shape surface, with a direction aligned with the local normal direction on the intersection point).
• When the closest point on shape is either a vertex or placed at the boundary between two facets (on a shape segment), an infinity of points share the same lat/long/normalHeight coordinates (see illustration below in 2D, to be transposed in 3D).
• Points on some regions of space can be built from several different lat/long/normal height coordinates.

       o v0 = vertex0                                  . <-- normale to s01
     %% \                                         .
   %%%%% \                                   .
 %%%%%%%% \ s01= segment between        .
 %%%%%%%%% \     v0 and v1         .
 %%%%%%%%%% \                 .     \
 %%%%%%%%%%% \ _         .           | same {lat, long, normalHeight} coordinates on the portion of any sphere centered on v1
 %%%%%%%%%%%% \ \   .                |
 %%%%%%%%%%%%% o v1  .    .    .    / .     .      .      .      .      <-- normale to s12
 %%%%%%%%%%%%% |_|
 %%%%%%%%%%%%% |
 %%%%%%%%%%%%% |
 %% INSIDE %%% | s12
 %%  BODY  %%% |
 %%%%%%%%%%%%% |
 %%%%%%%%%%%%% |_
 %%%%%%%%%%%%% | |
 %%%%%%%%%%%%% o v2   .     .    .    .    .    .    .    .    .    .    <-- normale to s12
 %%%%%%%%%%%% /_/   .    .
 %%%%%%%%%%% /           .           .
 %%%%%%%%%% /                  .               .
 %%%%%%%%% / s23                    .                    .  <-- only the bisector is accessible to construction from {lat, long, normal height} coordinates
 %%%%%%%% /                              .
 %%%%%%% /                                    .
  %%%%% /                                         .
   %%% o v3                                            <-- normale to s23

 

Parameters:

bodyShape - body shape on which the point is defined

coordSystem - LLH coordinates system in which are expressed the entered lat/long/height (must not be LLHCoordinatesSystem.ELLIPSODETIC otherwise an exception is raised)

latitude - input latitude

longitude - input longitude

height - input height

name - name of the point

Throws:

IllegalArgumentException - if the input coordinates use the LLHCoordinatesSystem.ELLIPSODETIC system

FacetPoint

public FacetPoint(FacetBodyShape bodyShape,
                  LLHCoordinates coordIn,
                  String name)

Constructor from lat/long/height coordinates.
Warning: Be aware of following limitations when using an LLH coordinates system using the normal height convention (typically the LLHCoordinatesSystem.BODYCENTRIC_NORMAL system):

• Some regions of the space are not accessible with such a system: indeed, the accessible regions are limited to the vertical lines from any point at the shape surface (lines intersecting the shape surface, with a direction aligned with the local normal direction on the intersection point).
• When the closest point on shape is either a vertex or placed at the boundary between two facets (on a shape segment), an infinity of points share the same lat/long/normalHeight coordinates (see illustration below in 2D, to be transposed in 3D).
• Points on some regions of space can be built from several different lat/long/normal height coordinates.

       o v0 = vertex0                                  . <-- normale to s01
     %% \                                         .
   %%%%% \                                   .
 %%%%%%%% \ s01= segment between        .
 %%%%%%%%% \     v0 and v1         .
 %%%%%%%%%% \                 .     \
 %%%%%%%%%%% \ _         .           | same {lat, long, normalHeight} coordinates on the portion of any sphere centered on v1
 %%%%%%%%%%%% \ \   .                |
 %%%%%%%%%%%%% o v1  .    .    .    / .     .      .      .      .      <-- normale to s12
 %%%%%%%%%%%%% |_|
 %%%%%%%%%%%%% |
 %%%%%%%%%%%%% |
 %% INSIDE %%% | s12
 %%  BODY  %%% |
 %%%%%%%%%%%%% |
 %%%%%%%%%%%%% |_
 %%%%%%%%%%%%% | |
 %%%%%%%%%%%%% o v2   .     .    .    .    .    .    .    .    .    .    <-- normale to s12
 %%%%%%%%%%%% /_/   .    .
 %%%%%%%%%%% /           .           .
 %%%%%%%%%% /                  .               .
 %%%%%%%%% / s23                    .                    .  <-- only the bisector is accessible to construction from {lat, long, normal height} coordinates
 %%%%%%%% /                              .
 %%%%%%% /                                    .
  %%%%% /                                         .
   %%% o v3                                            <-- normale to s23

 

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

Throws:

IllegalArgumentException - if the input coordinates use the LLHCoordinatesSystem.ELLIPSODETIC system

FacetPoint

public FacetPoint(FacetBodyShape 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

FacetPoint

public FacetPoint(FacetBodyShape 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

FacetPoint

protected FacetPoint(FacetBodyShape bodyShape,
                     Vector3D position,
                     List<Triangle> closestTriangles,
                     boolean onTheShape,
                     String name)

Protected constructor from a position, a list of closest triangles 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

closestTriangles - list of closest triangles

onTheShape - flag stating if the point is known to be on the shape or not: if true, both closestPointOnShape and radialPointOnShape attribute are set equal to this, and normalHeight is set to 0

name - name of the point

FacetPoint

protected FacetPoint(FacetBodyShape bodyShape,
                     Intersection intersection,
                     String name)

Protected constructor from an Intersection object.

The built facet point is associated with one single triangle.

Parameters:

bodyShape - body shape on which the point is defined

intersection - intersection defining both the position and the associated shape triangle

name - name of the point

Method Detail

getClosestTriangles

public List<Triangle> getClosestTriangles()

Get the list of shape triangles closest to this.

Returns:

the list of shape triangles closest to this

getBodyShape

public FacetBodyShape 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 FacetPoint 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.

The returned facet point is associated with one single triangle.

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 FacetPoint getClosestPointOnShape()

Returns the closest point to this on the shape surface.

The returned facet point is associated with one or several triangles following its position on the shape:

• 3 triangles or more if it corresponds to one shape vertex,
• 2 triangles if it belongs to one shape segment,
• 1 triangle in other cases.

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 a FacetPoint 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

toString

public 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 and/or the closest triangles have not been computed yet.

Specified by:

toString in interface BodyPoint

Overrides:

toString in class AbstractBodyPoint

Parameters:

coordSystem - coordinates system to be used

Returns:

a string representing the object