IMP logo
IMP Reference Guide  develop.b708a66810,2021/08/02
The Integrative Modeling Platform
shortest_segment.h
Go to the documentation of this file.
1 /**
2  * \file IMP/algebra/shortest_segment.h
3  * \brief Get the shortest segment connecting two geometric objects.
4  * Copyright 2007-2021 IMP Inventors. All rights reserved.
5 */
6 
7 #ifndef IMPALGEBRA_SHORTEST_SEGMENT_H
8 #define IMPALGEBRA_SHORTEST_SEGMENT_H
9 
10 #include <IMP/algebra/algebra_config.h>
11 #include "Segment3D.h"
12 #include <IMP/types.h>
13 
14 IMPALGEBRA_BEGIN_NAMESPACE
15 
16 /** \name Shortest segments
17 
18  These methods return the shortest segment connecting two geometric
19  objects. Such segments can be used to give the direction of the
20  derivative of the distance between the two objects. The 0 point on
21  the segment is in the first passed object and the 1 point is in
22  the second.
23 */
24 /** \see Segment3D
25  \see Vector3D
26 */
27 IMPALGEBRAEXPORT Segment3D
28  get_shortest_segment(const Segment3D &s, const Vector3D &p);
29 
30 /** \see Segment3D
31  */
32 IMPALGEBRAEXPORT Segment3D
33  get_shortest_segment(const Segment3D &sa, const Segment3D &sb);
34 
35 IMPALGEBRA_END_NAMESPACE
36 
37 #endif /* IMPALGEBRA_SHORTEST_SEGMENT_H */
Basic types used by IMP.
Simple implementation of segments in 3D.
VectorD< 3 > Vector3D
Definition: VectorD.h:421
Segment3D get_shortest_segment(const Segment3D &sa, const Segment3D &sb)