IMP  2.0.0
The Integrative Modeling Platform
IMP::algebra::Segment3D Class Reference

#include <IMP/algebra/Segment3D.h>

+ Inheritance diagram for IMP::algebra::Segment3D:

Public Member Functions

 Segment3D (const Vector3D &start, const Vector3D &end)
 
Vector3D get_direction () const
 Get a normalized direction vector pointing from get_point(0) to get_point(1).
 
double get_length () const
 
Vector3D get_middle_point () const
 
const Vector3Dget_point (unsigned int i) const
 Get the start=0/end=1 point of the segment.
 
void show (std::ostream &out=std::cout) const
 

Related Functions

(Note that these are not member functions.)

BoundingBoxD< 3 > get_bounding_box (const Segment3D &g)
 
double get_distance (const Segment3D &s, const Vector3D &p)
 Get the distance between a segment and a point. More...
 
double get_distance (const Segment3D &a, const Segment3D &b)
 Get the distance between two segments. More...
 
const Segment3Dget_segment_3d_geometry (const Segment3D &g)
 

Shortest segments

These methods return the shortest segment connecting two geometric objects. Such segments can be used to give the direction of the derivative of the distance between the two objects. The 0 point on the segment is in the first passed object and the 1 point is in the second.

Segment3D get_shortest_segment (const Segment3D &sa, const Segment3D &sb)
 

Detailed Description

It does what is says.

Note
This class is a geometric primitive. Also, this class is not not initialized by its default constructor.

Definition at line 24 of file Segment3D.h.

Friends And Related Function Documentation

BoundingBoxD< 3 > get_bounding_box ( const Segment3D g)
related

Definition at line 54 of file Segment3D.h.

double get_distance ( const Segment3D s,
const Vector3D p 
)
related
double get_distance ( const Segment3D a,
const Segment3D b 
)
related
const Segment3D & get_segment_3d_geometry ( const Segment3D g)
related

Definition at line 54 of file Segment3D.h.


The documentation for this class was generated from the following files: