Candy::InteractionHistogramEffect Struct Reference

Inheritance diagram for Candy::InteractionHistogramEffect:

Classes
struct	sample_t

Public Member Functions
EffectOutput	calculateForces (const EffectInput &input)
void	lockSamples ()
	Locks the sample list. More...
int	getSampleCount () const
	Returns the number of available samples. More...
const sample_t &	getSample (int idx) const
	Returns the sample specified by the idx parameter. More...
void	clearSamples ()
	Clears the sample list. More...
void	unlockSamples ()
	Unlocks the sample list. More...

Member Function Documentation

void Candy::InteractionHistogramEffect::clearSamples ( )

inline

Clears the sample list.

lockSamples() has to be called before making this call.

const sample_t& Candy::InteractionHistogramEffect::getSample ( int  idx ) const

inline

Returns the sample specified by the idx parameter.

lockSamples() has to be called before making this call.

int Candy::InteractionHistogramEffect::getSampleCount ( ) const

inline

Returns the number of available samples.

lockSamples() has to be called before making this call.

void Candy::InteractionHistogramEffect::lockSamples ( )

inline

Locks the sample list.

This has to be done before calling getSampleCount() or getSample() or clearSamples().

void Candy::InteractionHistogramEffect::unlockSamples ( )

inline

Unlocks the sample list.