IMP logo

IMP::algebra::Cone3D Class Reference


Detailed Description

In general, a cone is a pyramid with a circular cross section. A right cone is a cone with its vertex above the center of its base. However, when used without qualification, the term "cone" often means "right cone." We have implemented a "right cone".
Note:
This class is a geometric primitive. Also, this class is not not initialized by its default constructor.

Public Member Functions

 Cone3D (const Segment3D &s, double radius)
double get_angle () const
Plane3D get_base_plane () const
 Get the plane supporting the base of the cone.
bool get_contains (const VectorD< 3 > &v) const
VectorD< 3 > get_direction () const
 Get the direction of the axis of the cone.
double get_height () const
double get_radius () const
 get the radius of the base circle
VectorD< 3 > get_tip () const
 Get the vertex of the cone.
void show (std::ostream &out) const

Related Functions

(Note that these are not member functions.)

Vector Generators
These functions generate vector objects. Some of the methods, those with random in their name, generate a single vector chosen uniformly from the specified domain. Others, the cover methods, generate a set of points distributed (somewhat) evenly over the domain.

std::vector< VectorD< 3 > > get_uniform_surface_cover (const Cone3D &cone, unsigned int number_of_points)

Member Function Documentation

double IMP::algebra::Cone3D::get_angle (  )  const

The opening angle of a cone is the vertex angle made by a cross section through the apex and center of the base.

Plane3D IMP::algebra::Cone3D::get_base_plane (  )  const

Get the plane supporting the base of the cone.

The cone is on the positive side of the plane.

VectorD<3> IMP::algebra::Cone3D::get_direction (  )  const

Get the direction of the axis of the cone.

This vector points from the tip into the occupied volume.


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