IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP::algebra::SpherePatch3D Class Reference

A sphere patch is defined as all points above the plane and on the sphere. More...

#include <IMP/algebra/SpherePatch3D.h>

+ Inheritance diagram for IMP::algebra::SpherePatch3D:

Detailed Description

A sphere patch is defined as all points above the plane and on the sphere.

Definition at line 18 of file SpherePatch3D.h.

Public Member Functions

 SpherePatch3D (const Sphere3D &sph, const Plane3D &crossing_plane)
 Constructor. More...
 
Vector3D get_boundary_point () const
 Get a point which is on the boundary of the patch. More...
 
bool get_contains (const Vector3D &p) const
 Return true if the point is contained in the patch. More...
 
Plane3D get_plane () const
 
Sphere3D get_sphere () const
 
void show (std::ostream &out=std::cout) const
 

Related Functions

(Note that these are not member functions.)

double get_area (const SpherePatch3D &g)
 
BoundingBoxD< 3 > get_bounding_box (const SpherePatch3D &g)
 
const SpherePatch3Dget_sphere_patch_3d_geometry (const SpherePatch3D &g)
 
void set_sphere_patch_3d_geometry (SpherePatch3D &g, const SpherePatch3D &v)
 

Constructor & Destructor Documentation

IMP::algebra::SpherePatch3D::SpherePatch3D ( const Sphere3D sph,
const Plane3D crossing_plane 
)

Constructor.

Parameters
[in]sphthe sphere to cut a patch from
[in]crossing_planethe plane that crosses the sphere

Member Function Documentation

Vector3D IMP::algebra::SpherePatch3D::get_boundary_point ( ) const

Get a point which is on the boundary of the patch.

bool IMP::algebra::SpherePatch3D::get_contains ( const Vector3D p) const

Return true if the point is contained in the patch.

Note that the point must be on the sphere (this is not necessarily checked).

Friends And Related Function Documentation

double get_area ( const SpherePatch3D g)
related

Definition at line 48 of file SpherePatch3D.h.

BoundingBoxD< 3 > get_bounding_box ( const SpherePatch3D g)
related

Definition at line 48 of file SpherePatch3D.h.

const SpherePatch3D & get_sphere_patch_3d_geometry ( const SpherePatch3D g)
related

Definition at line 48 of file SpherePatch3D.h.

void set_sphere_patch_3d_geometry ( SpherePatch3D g,
const SpherePatch3D v 
)
related

Definition at line 48 of file SpherePatch3D.h.


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