Public Member Functions | Protected Types | Protected Attributes

OpenTissue::gjk::Cone< math_types > Class Template Reference

#include <gjk_cone.h>

List of all members.

Public Member Functions

T const & half_height () const
Thalf_height ()
T const & base_radius () const
Tbase_radius ()
 Cone ()
V operator() (V const &v) const

Protected Types

typedef math_types::real_type T
typedef math_types::vector3_type V
typedef math_types::value_traits value_traits

Protected Attributes

T m_half_height
 The half height of the cone. Default value is one.
T m_base_radius
 The radius of the circular base of the cone. Default value is one.

Detailed Description

template<typename math_types>
class OpenTissue::gjk::Cone< math_types >

A Cone. A Cone is placed with its apex on positive z-axis and the base orthogonal to the negative z-axis.

The apex and base are placed equidistant wrt. x-y plane and the distance is given by the half-height of the cone.

The base is a circular disk of a specified radius. From the radius and height of the cone one can compute the cone angle at the apex. This angle is denoted alpha.


Member Typedef Documentation

template<typename math_types>
typedef math_types::real_type OpenTissue::gjk::Cone< math_types >::T [protected]
template<typename math_types>
typedef math_types::vector3_type OpenTissue::gjk::Cone< math_types >::V [protected]
template<typename math_types>
typedef math_types::value_traits OpenTissue::gjk::Cone< math_types >::value_traits [protected]

Constructor & Destructor Documentation

template<typename math_types>
OpenTissue::gjk::Cone< math_types >::Cone (  )  [inline]

Member Function Documentation

template<typename math_types>
T const& OpenTissue::gjk::Cone< math_types >::base_radius (  )  const [inline]

Get Cone Base Radius.

Returns:
A reference to the cone base radius.
template<typename math_types>
T& OpenTissue::gjk::Cone< math_types >::base_radius (  )  [inline]
template<typename math_types>
T& OpenTissue::gjk::Cone< math_types >::half_height (  )  [inline]
template<typename math_types>
T const& OpenTissue::gjk::Cone< math_types >::half_height (  )  const [inline]

Get Cone Half height.

Returns:
A reference to the cone half height.
template<typename math_types>
V OpenTissue::gjk::Cone< math_types >::operator() ( V const &  v  )  const [inline]

Member Data Documentation

template<typename math_types>
T OpenTissue::gjk::Cone< math_types >::m_base_radius [protected]

The radius of the circular base of the cone. Default value is one.

template<typename math_types>
T OpenTissue::gjk::Cone< math_types >::m_half_height [protected]

The half height of the cone. Default value is one.


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