IMP logo

IMP::algebra::Plane3D Class Reference


Detailed Description

Represent a plane in 3D.
Note:
This class is a geometric primitive. Also, this class is not not initialized by its default constructor.

Public Member Functions

const VectorD< 3 > & get_normal () const
Plane3D get_opposite () const
 Return the plane with the opposite normal.
VectorD< 3 > get_point_on_plane () const
VectorD< 3 > get_projection (const VectorD< 3 > &p) const
 Project the point onto the plane.
 Plane3D (double distance_to_plane, const VectorD< 3 > &normal_to_plane)
 Plane3D (const VectorD< 3 > &point_on_plane, const VectorD< 3 > &normal_to_plane)
Orientation
Up is the direction of the normal.

bool get_is_above (const VectorD< 3 > &p) const
bool get_is_below (const VectorD< 3 > &p) const

Related Functions

(Note that these are not member functions.)

double get_distance (const Plane3D &pln, const VectorD< 3 > &p)
 Return the distance between a plane and a point in 3D.

Member Function Documentation

bool IMP::algebra::Plane3D::get_is_above ( const VectorD< 3 > &  p  )  const

Note:
This predicates will produce guaranteed correct results if the CGAL library is available (the results will be unreliable if it is not).

bool IMP::algebra::Plane3D::get_is_below ( const VectorD< 3 > &  p  )  const

Note:
This predicates will produce guaranteed correct results if the CGAL library is available (the results will be unreliable if it is not).


Friends And Related Function Documentation

double get_distance ( const Plane3D pln,
const VectorD< 3 > &  p 
) [related]

Return the distance between a plane and a point in 3D.


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

Generated on Mon Mar 8 23:08:47 2010 for IMP by doxygen 1.5.8