HUMIM Tracker: OpenTissue::sph::Emitter< Types > Class Template Reference

#include <sph_emitter.h>

Inheritance diagram for OpenTissue::sph::Emitter< Types >:

List of all members.

Public Types
typedef Types::vector	vector
typedef Types::particle	particle
typedef Types::particle_container	particle_container
typedef Types::particle_ptr_container	particle_ptr_container
Public Member Functions
	Emitter ()
virtual	~Emitter ()
bool	active () const
bool	running () const
size_t &	rate ()
const size_t &	rate () const
size_t &	batch ()
const size_t &	batch () const
virtual const vector &	center () const =0
bool	initialize (typename particle_container::iterator begin, typename particle_container::iterator end)
void	start ()
bool	execute ()
void	stop ()
Protected Attributes
bool	m_running
size_t	m_rate
size_t	m_currate
	release rate, execution frequency
size_t	m_batch
	release rate, execution frequency
size_t	m_particles
particle_ptr_container	m_pars

Detailed Description

template<typename Types>
class OpenTissue::sph::Emitter< Types >

SPH Particle Emitter Base Class.

Member Typedef Documentation

template<typename Types >

typedef Types::particle OpenTissue::sph::Emitter< Types >::particle

Reimplemented in OpenTissue::sph::CircleEmitter< Types >, and OpenTissue::sph::PointEmitter< Types >.

template<typename Types >

typedef Types::particle_container OpenTissue::sph::Emitter< Types >::particle_container

template<typename Types >

typedef Types::particle_ptr_container OpenTissue::sph::Emitter< Types >::particle_ptr_container

Reimplemented in OpenTissue::sph::CircleEmitter< Types >, and OpenTissue::sph::PointEmitter< Types >.

template<typename Types >

typedef Types::vector OpenTissue::sph::Emitter< Types >::vector

Reimplemented in OpenTissue::sph::CircleEmitter< Types >, and OpenTissue::sph::PointEmitter< Types >.

Constructor & Destructor Documentation

template<typename Types >

OpenTissue::sph::Emitter< Types >::Emitter ( ) [inline]

Default Constructor.

template<typename Types >

virtual OpenTissue::sph::Emitter< Types >::~Emitter ( ) [inline, virtual]

Deconstructor.

Member Function Documentation

template<typename Types >

bool OpenTissue::sph::Emitter< Types >::active ( ) const [inline]

Active

Return whether or not this emitter is still active, i.e. it still has unreleased particles.

template<typename Types >

size_t& OpenTissue::sph::Emitter< Types >::batch ( ) [inline]

Batch

template<typename Types >

const size_t& OpenTissue::sph::Emitter< Types >::batch ( ) const [inline]

Batch (read only)

template<typename Types >

virtual const vector& OpenTissue::sph::Emitter< Types >::center ( ) const [pure virtual]

Implemented in OpenTissue::sph::CircleEmitter< Types >, and OpenTissue::sph::PointEmitter< Types >.

template<typename Types >

bool OpenTissue::sph::Emitter< Types >::execute ( ) [inline]

Execute

template<typename Types >

bool OpenTissue::sph::Emitter< Types >::initialize	(	typename particle_container::iterator	begin,
		typename particle_container::iterator	end
	)			`[inline]`

Initialize

Parameters:

	begin	the first particle iterator.
	end	the last particle iterator.

template<typename Types >

const size_t& OpenTissue::sph::Emitter< Types >::rate ( ) const [inline]

Rate (read only)

template<typename Types >

size_t& OpenTissue::sph::Emitter< Types >::rate ( ) [inline]

Rate

template<typename Types >

bool OpenTissue::sph::Emitter< Types >::running ( ) const [inline]

Running

Return whether or not this emitter is still active, i.e. it still has unreleased particles.

template<typename Types >

void OpenTissue::sph::Emitter< Types >::start ( ) [inline]

Start

Starts the emitter.

template<typename Types >

void OpenTissue::sph::Emitter< Types >::stop ( ) [inline]

Stop

Stops the emitter (how odd).

Member Data Documentation

template<typename Types >

size_t OpenTissue::sph::Emitter< Types >::m_batch [protected]

release rate, execution frequency

template<typename Types >

size_t OpenTissue::sph::Emitter< Types >::m_currate [protected]

release rate, execution frequency

template<typename Types >

particle_ptr_container OpenTissue::sph::Emitter< Types >::m_pars [protected]

template<typename Types >

size_t OpenTissue::sph::Emitter< Types >::m_particles [protected]

template<typename Types >

size_t OpenTissue::sph::Emitter< Types >::m_rate [protected]

template<typename Types >

bool OpenTissue::sph::Emitter< Types >::m_running [protected]

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

/home/hauberg/Dokumenter/Capture/humim-tracker-0.1/src/OpenTissue/OpenTissue/dynamics/sph/sph_emitter.h