#include <psys_pin.h>

Inheritance diagram for OpenTissue::psys::Pin< types >:

Public Types
typedef types::math_types	math_types
typedef math_types::real_type	real_type
typedef math_types::vector3_type	vector3_type
typedef types::particle_type	particle_type
Public Member Functions
vector3_type &	pin_position ()
vector3_type const &	pin_position () const
	Pin ()
virtual	~Pin ()
void	init (particle_type *particle)
void	satisfy ()
Protected Attributes
particle_type *	m_particle
	The particle that is subject to the constraint.
vector3_type	m_r
	The constrained position.

template<typename types>
class OpenTissue::psys::Pin< types >

Member Typedef Documentation

template<typename types >

typedef types::math_types OpenTissue::psys::Pin< types >::math_types

template<typename types >

typedef types::particle_type OpenTissue::psys::Pin< types >::particle_type

template<typename types >

typedef math_types::real_type OpenTissue::psys::Pin< types >::real_type

template<typename types >

typedef math_types::vector3_type OpenTissue::psys::Pin< types >::vector3_type

Constructor & Destructor Documentation

template<typename types >

OpenTissue::psys::Pin< types >::Pin ( ) [inline]

template<typename types >

virtual OpenTissue::psys::Pin< types >::~Pin ( ) [inline, virtual]

Member Function Documentation

template<typename types >

void OpenTissue::psys::Pin< types >::init ( particle_type * particle ) [inline]

NOTE: Sets the pin position to the particle position!

template<typename types >

vector3_type const& OpenTissue::psys::Pin< types >::pin_position ( ) const [inline]

template<typename types >

vector3_type& OpenTissue::psys::Pin< types >::pin_position ( ) [inline]

template<typename types >

void OpenTissue::psys::Pin< types >::satisfy ( ) [inline, virtual]

Satisfy Constraint. This method is invoked by caller.

The method is responsible for relaxing the constraint on all affected particles, that is it should adjust the positions of all affected particles in a way such that they fulfill the constraint.

Reimplemented from OpenTissue::psys::Constraint< types >.