Public Types | Public Member Functions

OpenTissue::geometry::VolumeShape< math_types > Class Template Reference

#include <geometry_volume_shape.h>

Inheritance diagram for OpenTissue::geometry::VolumeShape< math_types >:
OpenTissue::geometry::BaseShape< math_types > OpenTissue::collision::GeometryInterface< math_types > OpenTissue::utility::ClassIDInterface

List of all members.

Public Types

typedef math_types::real_type real_type
typedef math_types::vector3_type vector3_type
typedef math_types::matrix3x3_type matrix3x3_type

Public Member Functions

virtual ~VolumeShape ()
virtual vector3_type center () const =0
virtual real_type volume () const =0
virtual real_type area () const =0
virtual real_type diameter () const =0

Detailed Description

template<typename math_types>
class OpenTissue::geometry::VolumeShape< math_types >

VolumeShape Template Class. If you implement a new volumetric geometry then you should derive your new class from the VolumeShape class .

Template Parameters:
math_types standard math types containing at least the real, vector3 and matrix3x3 types.

Member Typedef Documentation


Constructor & Destructor Documentation

template<typename math_types>
virtual OpenTissue::geometry::VolumeShape< math_types >::~VolumeShape (  )  [inline, virtual]

Member Function Documentation

template<typename math_types>
virtual real_type OpenTissue::geometry::VolumeShape< math_types >::area (  )  const [pure virtual]

Get Area.

Returns:
The actual surface area of the volume.
template<typename math_types>
virtual vector3_type OpenTissue::geometry::VolumeShape< math_types >::center (  )  const [pure virtual]

Get Center Position.

Returns:
The center point of the volume shape, in most cases this would be the mean point.
template<typename math_types>
virtual real_type OpenTissue::geometry::VolumeShape< math_types >::diameter (  )  const [pure virtual]

Get Diameter.

Returns:
A measure of the diameter of the shape. Not all shapes have a well-defined diameter in such cases the measure would simply be a measure of the longst extent of the shape.
template<typename math_types>
virtual real_type OpenTissue::geometry::VolumeShape< math_types >::volume (  )  const [pure virtual]

Get Volume.

Returns:
The actual volume of the shape.

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