IMP::algebra::Cylinder3D Class Reference

#include <IMP/algebra/Cylinder3D.h>

Inheritance diagram for IMP::algebra::Cylinder3D:

Public Member Functions
	Cylinder3D (const Segment3D &s, double radius)
const Vector3D	get_inner_point_at (double relative_height, double relative_radius, double angle) const
double	get_radius () const
const Segment3D &	get_segment () const
const Vector3D	get_surface_point_at (double relative_height, double angle)
void	show (std::ostream &out=std::cout) const

Detailed Description

It does what is says.

See geometric primitives for more information.

Definition at line 25 of file Cylinder3D.h.

Member Function Documentation

const Vector3D IMP::algebra::Cylinder3D::get_inner_point_at	(	double	relative_height,
		double	relative_radius,
		double	angle
	)		const

Returns a point inside the cylinder, specified by its location relative to the cylinder axis, its relative radius and its rotation angle about the axis

Parameters

relative_height	a number in the range [0..1] that specifies the point location relative to the cylinder axis such that 0 specifies the cylinder bottom and 1 specifies its top
relative_radius	a number in the range [0..1] that specifies the distance of the point from the cylinder axis relative to the cylinder radius, 0 being on the axis itself, and 1 being on the cylinder surface
angle	angle in radians about the cylinder axis, with 0 set to an arbitrary but consistent direction

const Vector3D IMP::algebra::Cylinder3D::get_surface_point_at	(	double	relative_height,
		double	angle
	)

Returns a point on the surface of the cylinder, specified by its location relative to the cylinder axis and its rotation angle about the axis

Parameters

relative_height	a number in the range [0..1] that specifies the point location relative to the cylinder axis such that 0 specifies the cylinder bottom and 1 specifies its top
angle	angle in radians about the cylinder axis, with 0 set to an arbitrary but consistent direction

---

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

• Cylinder3D.h