lmms::KickerInstrument Class Reference

#include <Kicker.h>

Inheritance diagram for lmms::KickerInstrument:

Public Member Functions
	KickerInstrument (InstrumentTrack *_instrument_track)
	~KickerInstrument () override=default
void	playNote (NotePlayHandle *_n, SampleFrame *_working_buffer) override
void	deleteNotePluginData (NotePlayHandle *_n) override
void	saveSettings (QDomDocument &doc, QDomElement &elem) override
void	loadSettings (const QDomElement &elem) override
QString	nodeName () const override
float	desiredReleaseTimeMs () const override
gui::PluginView *	instantiateView (QWidget *_parent) override
	Create a view for the model.
Public Member Functions inherited from lmms::Instrument
	Instrument (InstrumentTrack *_instrument_track, const Descriptor *_descriptor, const Descriptor::SubPluginFeatures::Key *key=nullptr, Flags flags=Flag::NoFlags)
	~Instrument () override=default
virtual bool	hasNoteInput () const
virtual void	play (SampleFrame *_working_buffer)
virtual auto	midiPatch () const -> std::optional< MidiPatch >
	For applicable instruments: Provides host with current MIDI bank and program.
virtual auto	childModel (std::string_view modelName) -> AutomatableModel *
virtual f_cnt_t	beatLen (NotePlayHandle *_n) const
f_cnt_t	desiredReleaseFrames () const
sample_rate_t	getSampleRate () const
bool	isSingleStreamed () const
bool	isMidiBased () const
bool	isBendable () const
virtual bool	handleMidiEvent (const MidiEvent &, const TimePos &=TimePos(), f_cnt_t offset=0)
QString	fullDisplayName () const override
virtual bool	isFromTrack (const Track *_track) const
InstrumentTrack *	instrumentTrack () const
Public Member Functions inherited from lmms::Plugin
	Plugin (const Descriptor *descriptor, Model *parent, const Descriptor::SubPluginFeatures::Key *key=nullptr)
	Constructor of a plugin.
	~Plugin () override=default
QString	displayName () const override
	Return display-name out of sub plugin or descriptor.
const PixmapLoader *	logo () const
	Return logo out of sub plugin or descriptor.
Type	type () const
	Return plugin type.
const Descriptor *	descriptor () const
	Return plugin Descriptor.
const Descriptor::SubPluginFeatures::Key &	key () const
virtual void	loadFile (const QString &file)
gui::PluginView *	createView (QWidget *parent)
	Create a view for the model.
Public Member Functions inherited from lmms::Model
	Model (Model *parent, QString displayName=QString(), bool defaultConstructed=false)
	~Model () override=default
bool	isDefaultConstructed () const
Model *	parentModel () const
virtual void	setDisplayName (const QString &displayName)
Public Member Functions inherited from lmms::JournallingObject
	JournallingObject ()
	~JournallingObject () override
jo_id_t	id () const
void	saveJournallingState (const bool newState)
void	restoreJournallingState ()
void	addJournalCheckPoint ()
QDomElement	saveState (QDomDocument &_doc, QDomElement &_parent) override
void	restoreState (const QDomElement &_this) override
bool	isJournalling () const
void	setJournalling (const bool _sr)
bool	testAndSetJournalling (const bool newState)
bool	isJournallingStateStackEmpty () const
Public Member Functions inherited from lmms::SerializingObject
	SerializingObject ()
virtual	~SerializingObject ()
void	setHook (SerializingObjectHook *_hook)
SerializingObjectHook *	hook ()

Private Attributes
FloatModel	m_startFreqModel
FloatModel	m_endFreqModel
TempoSyncKnobModel	m_decayModel
FloatModel	m_distModel
FloatModel	m_distEndModel
FloatModel	m_gainModel
FloatModel	m_envModel
FloatModel	m_noiseModel
FloatModel	m_clickModel
FloatModel	m_slopeModel
BoolModel	m_startNoteModel
BoolModel	m_endNoteModel
IntModel	m_versionModel

Friends
class	gui::KickerInstrumentView

Additional Inherited Members
Public Types inherited from lmms::Instrument
enum class	Flag { NoFlags = 0x00 , IsSingleStreamed = 0x01 , IsMidiBased = 0x02 , IsNotBendable = 0x04 }
using	Flags = lmms::Flags<Flag>
Public Types inherited from lmms::Plugin
enum class	Type {   Instrument , Effect , ImportFilter , ExportFilter ,   Tool , Library , Other , Undefined = 255 }
using	DescriptorList = QList<Descriptor*>
Signals inherited from lmms::Model
void	dataChanged ()
void	dataUnchanged ()
void	propertiesChanged ()
Static Public Member Functions inherited from lmms::Instrument
static Instrument *	instantiate (const QString &_plugin_name, InstrumentTrack *_instrument_track, const Plugin::Descriptor::SubPluginFeatures::Key *key, bool keyFromDnd=false)
Static Public Member Functions inherited from lmms::Plugin
static Plugin *	instantiateWithKey (const QString &pluginName, Model *parent, const Descriptor::SubPluginFeatures::Key *key, bool keyFromDnd=false)
static Plugin *	instantiate (const QString &pluginName, Model *parent, void *data)
Protected Member Functions inherited from lmms::Instrument
void	applyFadeIn (SampleFrame *buf, NotePlayHandle *n)
void	applyRelease (SampleFrame *buf, const NotePlayHandle *_n)
float	computeReleaseTimeMsByFrameCount (f_cnt_t frames) const
Protected Member Functions inherited from lmms::Plugin
void	collectErrorForUI (QString errMsg)
Protected Member Functions inherited from lmms::JournallingObject
void	changeID (jo_id_t _id)

Constructor & Destructor Documentation

KickerInstrument()

lmms::KickerInstrument::KickerInstrument

(

InstrumentTrack *

_instrument_track

)

~KickerInstrument()

lmms::KickerInstrument::~KickerInstrument ( )

overridedefault

Member Function Documentation

deleteNotePluginData()

void lmms::KickerInstrument::deleteNotePluginData ( NotePlayHandle * _n )

overridevirtual

Reimplemented from lmms::Instrument.

desiredReleaseTimeMs()

float lmms::KickerInstrument::desiredReleaseTimeMs ( ) const

inlineoverridevirtual

Reimplemented from lmms::Instrument.

instantiateView()

gui::PluginView * lmms::KickerInstrument::instantiateView ( QWidget * _parent )

overridevirtual

Create a view for the model.

Implements lmms::Plugin.

loadSettings()

void lmms::KickerInstrument::loadSettings ( const QDomElement & elem )

overridevirtual

Implements lmms::SerializingObject.

nodeName()

QString lmms::KickerInstrument::nodeName ( void ) const

overridevirtual

Implements lmms::SerializingObject.

playNote()

void lmms::KickerInstrument::playNote ( NotePlayHandle * _n, SampleFrame * _working_buffer )

overridevirtual

Reimplemented from lmms::Instrument.

saveSettings()

void lmms::KickerInstrument::saveSettings ( QDomDocument & doc, QDomElement & elem )

overridevirtual

Implements lmms::SerializingObject.

Friends And Related Symbol Documentation

gui::KickerInstrumentView

friend class gui::KickerInstrumentView

friend

Member Data Documentation

m_clickModel

FloatModel lmms::KickerInstrument::m_clickModel

private

m_decayModel

TempoSyncKnobModel lmms::KickerInstrument::m_decayModel

private

m_distEndModel

FloatModel lmms::KickerInstrument::m_distEndModel

private

m_distModel

FloatModel lmms::KickerInstrument::m_distModel

private

m_endFreqModel

FloatModel lmms::KickerInstrument::m_endFreqModel

private

m_endNoteModel

BoolModel lmms::KickerInstrument::m_endNoteModel

private

m_envModel

FloatModel lmms::KickerInstrument::m_envModel

private

m_gainModel

FloatModel lmms::KickerInstrument::m_gainModel

private

m_noiseModel

FloatModel lmms::KickerInstrument::m_noiseModel

private

m_slopeModel

FloatModel lmms::KickerInstrument::m_slopeModel

private

m_startFreqModel

FloatModel lmms::KickerInstrument::m_startFreqModel

private

m_startNoteModel

BoolModel lmms::KickerInstrument::m_startNoteModel

private

m_versionModel

IntModel lmms::KickerInstrument::m_versionModel

private

---

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

• plugins/Kicker/Kicker.h
• plugins/Kicker/Kicker.cpp