Public Types | Public Member Functions | Protected Attributes

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

#include <geometry_cylinder.h>

Inheritance diagram for OpenTissue::geometry::Cylinder< math_types_ >:
OpenTissue::geometry::VolumeShape< math_types_ > OpenTissue::function::SignedDistanceFunction< math_types_ > OpenTissue::utility::ClassID< Cylinder< 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
virtual ~Cylinder ()
vector3_type center () const
real_type const & radius () const
real_type const & height () const
vector3_type const & axis () const
 Cylinder ()
 Cylinder (vector3_type const &new_center, vector3_type const &new_axis, real_type const &new_height, real_type const &new_radius)
 Cylinder (Cylinder const &copy)
void set (Cylinder const &other_cylinder)
void set (vector3_type const &new_center, vector3_type const &new_axis, real_type const &new_height, real_type const &new_radius)
void place (vector3_type const &new_center, vector3_type const &new_axis)
void xform (vector3_type const &T, matrix3x3_type const &R)
real_type diameter () const
real_type area () const
real_type volume () const
void compute_surface_points (std::vector< vector3_type > &points) const
void translate (vector3_type const &T)
void rotate (matrix3x3_type const &R)
void scale (real_type const &s)
vector3_type get_support_point (vector3_type const &v) const
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 &, matrix3x3_type const &, vector3_type &min_coord, vector3_type &max_coord) const

Protected Attributes

vector3_type m_axis
vector3_type m_center
real_type m_radius
real_type m_height

Detailed Description

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

An Oriented Cylinder.


Member Typedef Documentation

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

Constructor & Destructor Documentation

template<typename math_types_>
virtual OpenTissue::geometry::Cylinder< math_types_ >::~Cylinder (  )  [inline, virtual]
template<typename math_types_>
OpenTissue::geometry::Cylinder< math_types_ >::Cylinder (  )  [inline]
template<typename math_types_>
OpenTissue::geometry::Cylinder< math_types_ >::Cylinder ( vector3_type const &  new_center,
vector3_type const &  new_axis,
real_type const &  new_height,
real_type const &  new_radius 
) [inline, explicit]
template<typename math_types_>
OpenTissue::geometry::Cylinder< math_types_ >::Cylinder ( Cylinder< math_types_ > const &  copy  )  [inline]

Member Function Documentation

template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::area (  )  const [inline]

Get Surface Area

Returns:
template<typename math_types_>
vector3_type const& OpenTissue::geometry::Cylinder< math_types_ >::axis (  )  const [inline]
template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::center (  )  const [inline]
template<typename math_types_>
size_t const OpenTissue::geometry::Cylinder< math_types_ >::class_id (  )  const [inline, virtual]

Query the class ID.

Returns:
The object's class ID

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

template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::compute_collision_aabb ( vector3_type const &  ,
matrix3x3_type const &  ,
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::Cylinder< math_types_ >::compute_surface_points ( std::vector< vector3_type > &  points  )  const [inline]
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::diameter (  )  const [inline]

Get Diameter

Returns:
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::evaluate ( vector3_type const &  x  )  const [inline]
template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::get_support_point ( vector3_type const &  v  )  const [inline]
template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::gradient ( vector3_type const &  x  )  const [inline]
template<typename math_types_>
real_type const& OpenTissue::geometry::Cylinder< math_types_ >::height (  )  const [inline]
template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::normal ( vector3_type const &  x  )  const [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::place ( vector3_type const &  new_center,
vector3_type const &  new_axis 
) [inline]
template<typename math_types_>
real_type const& OpenTissue::geometry::Cylinder< math_types_ >::radius (  )  const [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::rotate ( matrix3x3_type const &  R  )  [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::scale ( real_type const &  s  )  [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::set ( vector3_type const &  new_center,
vector3_type const &  new_axis,
real_type const &  new_height,
real_type const &  new_radius 
) [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::set ( Cylinder< math_types_ > const &  other_cylinder  )  [inline]
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::signed_distance ( vector3_type const &  x  )  const [inline]
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::translate ( vector3_type const &  T  )  [inline]
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::volume (  )  const [inline]

Get Volume

Returns:
template<typename math_types_>
void OpenTissue::geometry::Cylinder< math_types_ >::xform ( vector3_type const &  T,
matrix3x3_type const &  R 
) [inline]

Apply Transform to Cylinder First rotate then translate

Parameters:
T 
R 

Member Data Documentation

template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::m_axis [protected]
template<typename math_types_>
vector3_type OpenTissue::geometry::Cylinder< math_types_ >::m_center [protected]
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::m_height [protected]
template<typename math_types_>
real_type OpenTissue::geometry::Cylinder< math_types_ >::m_radius [protected]

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