Voir la source de Catégorie:User Manual 4.2 Geometry

__NOTOC__ 
== Introduction ==
=== Scope ===
The geometry objects implemented in the PATRIUS library are both infinite and finite shapes.

The finite shapes shall be used for example to represent parts of a spacecraft or celestial bodies. The infinite ones can represent more mathematical surfaces such as instruments' characteristics.

All the objects provide methods to compute interactions with lines (intersections, distances, etc...), points and other objects.


=== Javadoc ===
The geometry objects are available in the package <code>fr.cnes.sirius.patrius.math.geometry.euclidean.threed</code>.

{| class="wikitable"
|-
! scope="col"| Library
! scope="col"| Javadoc
|-
|Patrius
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/package-summary.html Package fr.cnes.sirius.patrius.math.geometry.euclidean.threed]
|-
|Patrius
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/package-summary.html Package fr.cnes.sirius.patrius.math.geometry.euclidean.threed]
|}

=== Links ===
The math package contains several other packages related to geometry (1D, 2D, 3D) and provides objects for Binary Space Partitioning (BSP) Tree. See javadoc for more information.
Some other "basic" objects are contained in the threed package and documented in other parts of this manual (eg : Rotations, Matrix3D).

=== Useful Documents ===
Useful reference documents for this theme can be found here :

* Nürnberg, R.; ''Distance from a Point to an Ellipse'', Imperial College London, 2006, [http://www2.imperial.ac.uk/~~rn/distance2ellipse.pdf http://www2.imperial.ac.uk/~~rn/distance2ellipse.pdf].

=== Package Overview ===
The aim of the following diagram is to present the architecture implemented for the Geometry package. This does not mean that all the classes and/or interfaces are in the Geometry package and it doesnt mean that all the classes and interfaces of the package are presented.

[[File:geometry.PNG|center]]

== Features Description ==
=== 2D Objects ===
The two dimensional objects (in three dimensional space) implemented in the PATRIUS library are given hereunder :

* Lines
* Planes
* Plates
* Disks
* Ellipses

Please refer to the [MAT_GEO_Home#HClasses Classes section] for more information.

=== 3D Objects ===
The three dimensional objects (in three dimensional space) implemented in the PATRIUS library are given hereunder :

* Infinite and Finite Cylinders (right circular, elliptic and rectangular)
* Infinite and Finite Cones (right circular, oblique circular and rectangular)
* Spheres, Spheroids and Spherical Caps
* Parallelepipeds

Please refer to the [MAT_GEO_Home#HClasses Classes section] for more information.

=== Interactions between objects ===
[MAT_GEO_Home#HInterfaces Interfaces] have been implemented for geometrical objects in order to set a standard as to what method each and any geometrical object should implement.

As of now, (some of the) geometrical objects must provide methods to :
* Check if a line intersects with said objects,
* Compute and return the intersection points,
* Compute and return the closest point on the object surface to a given user point,
* Compute and return the distance between these two points,
* Compute and return the closest point on the object surface to a given user line and return the closest points on the line and on the object,
* Compute and return the distance between an object and a given user line.

Plese refer to the [MAT_GEO_Home#HInteractions Interactions section] for more details.

== Getting Started ==

=== Interactions ===
Given an object implementing the [MAT_GEO_Home#HInterfaces Shape] interface, the following methods are available :


'''intersects(Line) : boolean'''<br>
Test the intersection of the object with a user given line.

Code snippet :
<syntaxhighlight lang="java">
Line line = new Line(lineOrigin, lineDirection);
boolean result = myObject.intersects(line);
</syntaxhighlight>


'''getIntersectionPoints(Line) : Vector3D[]'''<br>
Compute the intersection point of the object with a user given line.

Code snippet :
<syntaxhighlight lang="java">
Line line = new Line(lineOrigin, lineDirection);
Vector3D[] intersectionPoints = myObject.getIntersectionPoints(line);
</syntaxhighlight>


'''closestPointTo(Vector3D) : Vector3D'''<br>
Compute the point on the surface of the object that is the closest to a user given point.

Code snippet :
<syntaxhighlight lang="java">
Vector3D point = new Vector3D(1.0, 2.0, 3.0);
Vector3D result = myObject.closestPointTo(point);
</syntaxhighlight>


'''distanceTo(Vector3D) : double'''<br>
Compute the shortest distance from the surface of the object and user given point. 

Code snippet :
<syntaxhighlight lang="java">
Line line = new Line(lineOrigin, lineDirection);
double distance = myObject.distanceTo(line);
</syntaxhighlight>


'''closestPointTo(Line) : Vector3D[]'''<br>
Compute the points realizing the shortest distance to a line (the first one is from the line, the second one from the object ). If the line intersects the object , the two points are identical, and equal to the first one returned by the "getIntersectionPoints" method. If the line is parallel to the object 's side, the closest point to the origin is used.

Code snippet :
<syntaxhighlight lang="java">
Line line = new Line(lineOrigin, lineDirection);
Vector3D[] points = myObject.closestPointTo(line);
</syntaxhighlight>


'''distanceTo(Line) : double'''<br>
Compute the shortest distance from a line to the surface of the object.

Code snippet :
<syntaxhighlight lang="java">
Line line = new Line(lineOrigin, lineDirection);
double distance = myObject.distanceTo(line);
</syntaxhighlight>

== Contents ==
=== Interfaces ===
{| class="wikitable"
|-
! scope="col"| Interface
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 The Cone Interface|Cone]]'''
|This interface extends the SolidShape interface for the particular case of cones.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Cone.html ...]
|-
|'''[[User Manual 4.1 The CrossSectionProvider Interface|CrossSectionProvider]]'''
|Interface for all geometric objects that can provide their cross section from a direction defined by a Vector3D.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/CrossSectionProvider.html ...]
|-
|'''[[User Manual 4.1 The Cylinder Interface|Cylinder]]'''
|This interface extends the SolidShape interface for the particular case of cylinders.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Cylinder.html ...]
|-
|'''[[User Manual 4.1 The Ellipsoid Interface|IEllipsoid]]'''
|This interface extends the InfiniteShape interface for the particular cases of ellipsoid objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/IEllipsoid.html ...]
|-
|'''[[User Manual 4.1 The Infinite Cone Interface|InfiniteCone]]'''
|This interface extends the InfiniteShape interface for the particular cases of infinite cones.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteCone.html ...]
|-
|'''[[User Manual 4.1 The Infinite Cylinder Interface|InfiniteCylinder]]'''
|This interface extends the InfiniteShape interface for the particular cases of infinite cylinders.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteCylinder.html ...]
|-
|'''InfiniteShape'''
|This interface extends the Shape interface for the particular cases of infinite shapes.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteShape.html ...]
|-
|'''Shape'''
|This interface is the '''main interface for all shapes''', including infinite and solid shapes. It defines the general methods required by each geometrical object implementing any of the above interfaces : All of them must be able to compute their intersection and distance to a line. See [MAT_GEO_Home#HInteractionsbetweenobjects Interactions].
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Shape.html ...]
|-
|'''SolidShape'''
|This interface extends the Shape interface for the particular cases of solids.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/SolidShape.html ...]
|}

=== Classes ===
'''Basic Shapes'''

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 Disk|Disk]]'''
|The class represent disks in a three dimensional space.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Disk.html ...]
|-
|'''[[User Manual 4.1 Ellipse|Ellipse]]'''
|The class represent ellipses in a three dimensional space.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Ellipse.html ...]
|-
|'''[[User Manual 4.1 Lines|Line]]'''
|The class represent lines in a three dimensional space.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Line.html ...]
|-
|'''[[User Manual 4.1 Planes|Plane]]'''
|The class represent planes in a three dimensional space.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Plane.html ...]
|-
|'''[[User Manual 4.1 Plates|Plate]]'''
|This is a describing class for a 3D rectangle plate shape, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Plate.html ...]
|-
|'''[[User Manual 4.1 Parallelepipeds|Parallelepiped]]'''
|This is a describing class for a rectangle parallelepiped shape, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Parallelepiped.html ...]
|}

'''Cylinders'''

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 Infinite Elliptic Cylinder|InfiniteEllipticCylinder]]'''
|This class is the Infinite Elliptic Cylinder class.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteEllipticCylinder.html ...]
|-
|'''[[User Manual 4.1 Infinite right circular cylinder|InfiniteRightCircularCylinder]]'''
|This is a describing class for a 3D infinite right circular cylinder, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteRightCircularCylinder.html ...]
|-
|'''[[User Manual 4.1 Infinite Rectangle Cylinder|InfiniteRectangleCylinder]]'''
|This is a describing class for a 3D infinite rectangle cylinder, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math//geometry/euclidean/threed/InfiniteRectangleCylinder.html ...]
|-
|'''[[User Manual 4.1 Elliptic cylinder|EllipticCylinder]]'''
|This is a describing class for a 3D oblique circular cylinder ended by two planes normal to its axis, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/EllipticCylinder.html ...]
|-
|'''[[User Manual 4.1 Right circular cylinder|RightCircularCylinder]]'''
|This is a describing class for a 3D right circular cylinder ended by two planes normal to its axis, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/RightCircularCylinder.html ...]
|}

NB : For the rectangular cylinder, please refer to the parallelepiped class mentioned above.

'''Cones'''

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 Infinite right circular cone|InfiniteRightCircularCone]]'''
|This is a describing class for a 3D infinite cone, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteRightCircularCone.html ...]
|-
|'''[[User Manual 4.1 Infinite elliptic cone|InfiniteEllipticCone]]'''
|This class is the Infinite Elliptic Cone class.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteEllipticCone.html ...]
|-
|'''[[User Manual 4.1 Infinite rectangle cone|InfiniteRectangleCone]]'''
|This is a describing class for a 3D infinite cone, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/InfiniteRectangleCone.html ...]
|-
|'''[[User Manual 4.1 Right circular cone|RightCircularCone]]'''
|This is a describing class for a 3D right circular cone ended by a plane normal to its axis, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/RightCircularCone.html ...]
|-
|'''[[User Manual 4.1 Elliptic cone|EllipticCone]]'''
|This is a describing class for a 3D elliptic cone ended by a plane normal to its axis, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/EllipticCone.html ...]
|-
|'''[[User Manual 4.1 Rectangular cone|RectangleCone]]'''
|This is a describing class for a 3D rectangle cone ended by a plane normal to its axis (pyramid), with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/RectangleCone.html ...]
|}

'''Ellipsoids'''

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 Ellipsoids|Ellipsoid]]'''
|This is a describing class for an ellipsoid, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Ellipsoid.html ...]
|-
|'''[[User Manual 4.1 Spheres|Sphere]]'''
|This is a describing class for a 3D spherical shape, with some algorithm to compute intersections and distances to some other objects.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Sphere.html ...]
|-
|'''[[User Manual 4.1 Spheroids|Spheroid]]'''
|This is the Spheroid (also called Revolved Ellipsoid) class.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/Spheroid.html ...]
|}

'''Other objects'''

{| class="wikitable"
|-
! scope="col"| Class
! scope="col"| Summary
! scope="col"| Javadoc
|-
|'''[[User Manual 4.1 Facets|Facet]]'''
|Implements a representation of a facet.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/assembly/properties/features/Facet.html ...]
|-
|'''[[User Manual 4.1 Spherical Caps|SphericalCap]]'''
|Implements a representation of a spherical cap solid.
|[{{JavaDoc4.1}}/fr/cnes/sirius/patrius/math/geometry/euclidean/threed/SphericalCap.html ...]
|}

[[Category:User_Manual_4.0_Mathematics]]