Candy::InteractionHistogram Class Reference

Inheritance diagram for Candy::InteractionHistogram:

Public Member Functions
	InteractionHistogram (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::SFBool > _resetData=0, H3D::Inst< H3D::SFVec2f > _histogramRange=0, H3D::Inst< H3D::SFInt32 > _histogramSize=0, H3D::Inst< H3D::SFBool > _logarithmicVelocity=0, H3D::Inst< H3D::SFBool > _logarithmicTime=0, H3D::Inst< H3D::MFInt32 > _deviceId=0, H3D::Inst< H3D::MFFloat > _histogramValue=0, H3D::Inst< H3D::MFFloat > _histogramTime=0)
void	traverseSG (H3D::TraverseInfo &ti)

Public Attributes
std::auto_ptr< H3D::SFBool >	resetData
	(false) If set to true the histogram data will be reset. More...
std::auto_ptr< H3D::SFVec2f >	histogramRange
	(0.001,1.000) The range of velocity values to include in the histogram, in m/s. More...
std::auto_ptr< H3D::SFInt32 >	histogramSize
	(100) The size, in number of cells, of the histogram. More...
std::auto_ptr< H3D::SFBool >	logarithmicVelocity
	(False) If set to True, the logarithmic scale (base 10) is used for the velocity axis of the histogram (the primary axis). More...
std::auto_ptr< H3D::SFBool >	logarithmicTime
	(False) If set to True, the logarithmic scale (base 10) is used for the time axis of the histogram (the secondary axis). More...
std::auto_ptr< H3D::MFFloat >	histogramValue
	The interaction histogram containing time spent moving the haptic instrument in each velocity. More...
std::auto_ptr< H3D::MFFloat >	histogramTime
	The total time entered into the histogram per device. More...
std::auto_ptr< H3D::MFInt32 >	deviceId
	A list of devices to sample interaction from. More...

Static Public Attributes
static H3D::H3DNodeDatabase	database

Member Data Documentation

std::auto_ptr<H3D::MFInt32> Candy::InteractionHistogram::deviceId

A list of devices to sample interaction from.

The histogram data will be reset whenever this field is changed. An empty list will result in all and any device being used.

std::auto_ptr<H3D::SFVec2f> Candy::InteractionHistogram::histogramRange

(0.001,1.000) The range of velocity values to include in the histogram, in m/s.

The histogram data will be reset whenever this field is changed.

std::auto_ptr<H3D::SFInt32> Candy::InteractionHistogram::histogramSize

(100) The size, in number of cells, of the histogram.

This will be the size of histogramValue. The histogram data will be reset whenever this field is changed.

std::auto_ptr<H3D::MFFloat> Candy::InteractionHistogram::histogramTime

The total time entered into the histogram per device.

This field will have the same size as deviceId, if set. Dividing each value of histogramValue the value in histogramTime will provide the fraction of time spent in each velocity, iff you have only one active device.

std::auto_ptr<H3D::MFFloat> Candy::InteractionHistogram::histogramValue

The interaction histogram containing time spent moving the haptic instrument in each velocity.

Samples with velocity below the range specified through histogramRange will not be included but velocities above will be included in the top-most cell. Dividing each value of histogramValue the value in histogramTime will provide the fraction of time spent in each velocity, iff you have only one active device.

std::auto_ptr<H3D::SFBool> Candy::InteractionHistogram::logarithmicTime

(False) If set to True, the logarithmic scale (base 10) is used for the time axis of the histogram (the secondary axis).

std::auto_ptr<H3D::SFBool> Candy::InteractionHistogram::logarithmicVelocity

(False) If set to True, the logarithmic scale (base 10) is used for the velocity axis of the histogram (the primary axis).

The histogram data will be reset whenever this field is changed.

std::auto_ptr<H3D::SFBool> Candy::InteractionHistogram::resetData

(false) If set to true the histogram data will be reset.

This field is automatically set to false when the histogram data have been reset.