IMP logo
IMP Reference Guide  develop.714915d50b,2024/12/07
The Integrative Modeling Platform
IMP::algebra::Plane3D Class Reference

Represent a plane in 3D. More...

#include <IMP/algebra/Plane3D.h>

+ Inheritance diagram for IMP::algebra::Plane3D:

Detailed Description

Represent a plane in 3D.

See geometric primitives for more information.

Definition at line 21 of file Plane3D.h.

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. More...
 
Vector3D get_point_on_plane () const
 
Vector3D get_projected (const Vector3D &p) const
 Project the point onto the plane. More...
 
void show (std::ostream &out=std::cout) const
 

Related Functions

(Note that these are not member functions.)

double get_area (const Plane3D &g)
 
BoundingBoxD< 3 > get_bounding_box (const Plane3D &g)
 
const Plane3Dget_plane_3d_geometry (const Plane3D &g)
 
void set_plane_3d_geometry (Plane3D &g, const Plane3D &v)
 

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
 

Member Function Documentation

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

Return the plane with the opposite normal.

Definition at line 54 of file Plane3D.h.

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

Project the point onto the plane.

Definition at line 38 of file Plane3D.h.

Friends And Related Function Documentation

double get_area ( const Plane3D g)
related

Definition at line 86 of file Plane3D.h.

BoundingBoxD< 3 > get_bounding_box ( const Plane3D g)
related

Definition at line 86 of file Plane3D.h.

const Plane3D & get_plane_3d_geometry ( const Plane3D g)
related

Definition at line 86 of file Plane3D.h.

void set_plane_3d_geometry ( Plane3D g,
const Plane3D v 
)
related

Definition at line 86 of file Plane3D.h.


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