FluxMeasurementComponentInstance Class Reference

#include </opt/build/repo/nap/system_modules/napfft/src/fluxmeasurementcomponent.h>

Public Member Functions
	FluxMeasurementComponentInstance (EntityInstance &entity, Component &resource)
bool	init (utility::ErrorState &errorState) override
virtual void	update (double deltaTime) override
float	getFlux () const
void	setDecay (float decay)
void	setScale (float scale)
Public Member Functions inherited from ComponentInstance
	ComponentInstance (EntityInstance &entity, Component &resource)
nap::EntityInstance *	getEntityInstance () const
nap::Component *	getComponent () const
template<typename T >
T *	getComponent () const
virtual bool	init (utility::ErrorState &errorState)
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Description

Instance of component to measure onsets of the audio signal from an audio component.

Inheritance diagram for FluxMeasurementComponentInstance:

Collaboration diagram for FluxMeasurementComponentInstance:

Constructor & Destructor Documentation

FluxMeasurementComponentInstance()

FluxMeasurementComponentInstance	(	EntityInstance &	entity,
		Component &	resource
	)

Member Function Documentation

getFlux()

float getFlux

(

)

const

Returns

the computed flux value between 0.0 and 1.0

init()

bool init ( utility::ErrorState &  errorState )

overridevirtual

Initializes this component based on it's resource.

Parameters

errorState

contains the error when initialization fails.

Returns

if initialization succeeded.

Reimplemented from ComponentInstance.

setDecay()

void setDecay

(

float

decay

)

Sets the decay factor

Parameters

the	decay factor

setScale()

void setScale

(

float

scale

)

Sets the scaling factor

Parameters

the	scaling factor

update()

virtual void update ( double  deltaTime )

overridevirtual

Update this component

Parameters

deltaTime

the time in between cooks in seconds

Reimplemented from ComponentInstance.