Public Types | Public Member Functions | Protected Attributes

OpenTissue::geometry::Torus< math_types_ > Class Template Reference

#include <geometry_torus.h>

Inheritance diagram for OpenTissue::geometry::Torus< math_types_ >:
OpenTissue::geometry::VolumeShape< math_types_ > OpenTissue::function::SignedDistanceFunction< math_types_ > OpenTissue::utility::ClassID< Torus< math_types_ > > OpenTissue::geometry::BaseShape< math_types_ > OpenTissue::function::ImplicitFunction< math_types_ > OpenTissue::utility::ClassIDInterface OpenTissue::collision::GeometryInterface< math_types_ > OpenTissue::utility::ClassIDInterface

List of all members.

Public Types

typedef math_types_ math_types
typedef math_types::value_traits value_traits
typedef math_types::real_type real_type
typedef math_types::vector3_type vector3_type
typedef math_types::matrix3x3_type matrix3x3_type
typedef math_types::quaternion_type quaternion_type

Public Member Functions

size_t const class_id () const
 Torus ()
 Torus (vector3_type const &center, real_type const &radius, real_type const &tube)
virtual ~Torus ()
void set (vector3_type const &center, real_type const &radius, real_type const &tube)
vector3_type center () const
real_type const & radius () const
real_type const & tube () const
vector3_type get_support_point (vector3_type const &) const
real_type volume () const
real_type area () const
real_type diameter () const
void compute_surface_points (std::vector< vector3_type > &) const
void translate (vector3_type const &T)
void rotate (matrix3x3_type const &)
void scale (real_type const &s)
real_type evaluate (vector3_type const &x) const
vector3_type gradient (vector3_type const &x) const
vector3_type normal (vector3_type const &x) const
real_type signed_distance (vector3_type const &x) const
void compute_collision_aabb (vector3_type const &r, matrix3x3_type const &R, vector3_type &min_coord, vector3_type &max_coord) const

Protected Attributes

vector3_type m_center
 the center of the torus hole
real_type m_radius
 the radius from the center to the tube center
real_type m_tube
 the radius of the torus tube

Detailed Description

template<typename math_types_>
class OpenTissue::geometry::Torus< math_types_ >

Standard single-holed torus.

Member Typedef Documentation

template<typename math_types_ >
typedef math_types_ OpenTissue::geometry::Torus< math_types_ >::math_types
template<typename math_types_ >
typedef math_types::matrix3x3_type OpenTissue::geometry::Torus< math_types_ >::matrix3x3_type
template<typename math_types_ >
typedef math_types::quaternion_type OpenTissue::geometry::Torus< math_types_ >::quaternion_type
template<typename math_types_ >
typedef math_types::real_type OpenTissue::geometry::Torus< math_types_ >::real_type
template<typename math_types_ >
typedef math_types::value_traits OpenTissue::geometry::Torus< math_types_ >::value_traits
template<typename math_types_ >
typedef math_types::vector3_type OpenTissue::geometry::Torus< math_types_ >::vector3_type

Constructor & Destructor Documentation

template<typename math_types_ >
OpenTissue::geometry::Torus< math_types_ >::Torus (  )  [inline]
template<typename math_types_ >
OpenTissue::geometry::Torus< math_types_ >::Torus ( vector3_type const &  center,
real_type const &  radius,
real_type const &  tube 
) [inline]

Torus constructor

Parameters:
center The cventer of the torus
radius The radius from the center to the middle of the torus tube
tube The radius of the torus tube
Note:
if radius > tube a ring torus (doughnut) is constructed.
if radius = tube a horn torus is constructed which is tangent to itself at the center.
if radius < tube a self-intersecting spindle torus is constructed.
template<typename math_types_ >
virtual OpenTissue::geometry::Torus< math_types_ >::~Torus (  )  [inline, virtual]

Member Function Documentation

template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::area (  )  const [inline]
template<typename math_types_ >
vector3_type OpenTissue::geometry::Torus< math_types_ >::center (  )  const [inline]
template<typename math_types_ >
size_t const OpenTissue::geometry::Torus< math_types_ >::class_id (  )  const [inline, virtual]

Query the class ID.

Returns:
The object's class ID

Reimplemented from OpenTissue::utility::ClassID< Torus< math_types_ > >.

template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::compute_collision_aabb ( vector3_type const &  r,
matrix3x3_type const &  R,
vector3_type &  min_coord,
vector3_type &  max_coord 
) const [inline]

Compute Bounding Box. This method computes an axis aligned bounding box (AABB) that encloses the geometry.

Parameters:
r The position of the model frame (i.e the coordinate frame the geometry lives in).
R The orientation of the model frame (i.e the coordinate frame the geometry lives in).
min_coord Upon return holds the minimum corner of the box.
max_coord Upon return holds the maximum corner of the box.
template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::compute_surface_points ( std::vector< vector3_type > &   )  const [inline]
template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::diameter (  )  const [inline]
template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::evaluate ( vector3_type const &  x  )  const [inline]

implicit function of a torus: f(x,y,z) = (c-sqrt(x^2+y^2))^2+z^2-a^2

template<typename math_types_ >
vector3_type OpenTissue::geometry::Torus< math_types_ >::get_support_point ( vector3_type const &   )  const [inline]
template<typename math_types_ >
vector3_type OpenTissue::geometry::Torus< math_types_ >::gradient ( vector3_type const &  x  )  const [inline]
template<typename math_types_ >
vector3_type OpenTissue::geometry::Torus< math_types_ >::normal ( vector3_type const &  x  )  const [inline]
template<typename math_types_ >
real_type const& OpenTissue::geometry::Torus< math_types_ >::radius (  )  const [inline]
template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::rotate ( matrix3x3_type const &   )  [inline]
template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::scale ( real_type const &  s  )  [inline]
template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::set ( vector3_type const &  center,
real_type const &  radius,
real_type const &  tube 
) [inline]

Set Torus (constructs the torus)

Parameters:
center The cventer of the torus
radius The radius from the center to the middle of the torus tube
tube The radius of the torus tube
Note:
if radius > tube a ring torus (doughnut) is constructed.
if radius = tube a horn torus is constructed which is tangent to itself at the center.
if radius < tube a self-intersecting spindle torus is constructed.
template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::signed_distance ( vector3_type const &  x  )  const [inline]
template<typename math_types_ >
void OpenTissue::geometry::Torus< math_types_ >::translate ( vector3_type const &  T  )  [inline]
template<typename math_types_ >
real_type const& OpenTissue::geometry::Torus< math_types_ >::tube (  )  const [inline]
template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::volume (  )  const [inline]

Member Data Documentation

template<typename math_types_ >
vector3_type OpenTissue::geometry::Torus< math_types_ >::m_center [protected]

the center of the torus hole

template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::m_radius [protected]

the radius from the center to the tube center

template<typename math_types_ >
real_type OpenTissue::geometry::Torus< math_types_ >::m_tube [protected]

the radius of the torus tube

The documentation for this class was generated from the following file:
Generated on Thu Dec 1 2011 12:55:56 for HUMIM Tracker by  doxygen 1.7.1