IMP logo
Public Member Functions | Related Functions
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.

List of all members.

Public Member Functions

 Plane3D (const Vector3D &point_on_plane, const Vector3D &normal_to_plane)
 Plane3D (double distance_to_plane, const Vector3D &normal_to_plane)
double get_distance_from_origin () const
double get_height (const Vector3D &p) const
const Vector3Dget_normal () const
Plane3D get_opposite () const
 Return the plane with the opposite normal.
Vector3D get_point_on_plane () const
Vector3D get_projected (const Vector3D &p) const
 Project the point onto the plane.
void show (std::ostream &out=std::cout) const

Orientation

Up is the direction of the normal. You really shouldn't use these as they aren't very reliable.

bool get_is_above (const Vector3D &p) const
bool get_is_below (const Vector3D &p) const

Related Functions

(Note that these are not member functions.)

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

Member Function Documentation

Plane3D IMP::algebra::Plane3D::get_opposite ( ) const

Return the plane with the opposite normal.

Vector3D IMP::algebra::Plane3D::get_projected ( const Vector3D p) const

Project the point onto the plane.


Friends And Related Function Documentation

double get_distance ( const Plane3D pln,
const Vector3D p 
)
related

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


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

Generated on Tue May 22 2012 23:33:25 for IMP by doxygen 1.8.1