Inheritance diagram for deluge::gui::menu_item::patched_param::Integer:

[legend]

Collaboration diagram for deluge::gui::menu_item::patched_param::Integer:

[legend]

Public Member Functions
	Integer (l10n::String newName, int32_t newP=0)

	Integer (l10n::String newName, l10n::String title, int32_t newP=0)

void	drawValue () override

bool	usesAffectEntire () override
	Claim support for Kit AFFECT_ENTIRE editing.

ParamDescriptor	getLearningThing () final

int32_t	getMaxValue () const override

int32_t	getMinValue () const override

uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) final

uint8_t	shouldDrawDotOnName () final

MenuItem *	selectButtonPress () final
	Handle a select button press.

ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine) final
	Handle an arbitrary button.

void	horizontalEncoderAction (int32_t offset) final
	Handle horizontal encoder movement.

deluge::modulation::params::Kind	getParamKind () final

uint32_t	getParamIndex () final

MenuItem *	patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false) final
	Action to take when a source shortcut is pressed.

void	unlearnAction () final
	Unlearn the parameter controlled by this menu.

bool	allowsLearnMode () final
	Used by SoundEditor to determine if the current menu item can accept MIDI learning.

void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel) final

int32_t	getParamValue ()

void	updateAutomationViewParameter () override

Public Member Functions inherited from deluge::gui::menu_item::PatchedParam
	PatchedParam (int32_t newP)

MenuItem *	selectButtonPress ()

ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)

void	horizontalEncoderAction (int32_t offset)

ParamDescriptor	getLearningThing () override

uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour)

MenuItem *	patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false)

ModelStackWithAutoParam *	getModelStack (void *memory) override

Public Member Functions inherited from deluge::gui::menu_item::Param
	Param (int32_t newP=0)

virtual uint8_t	getP ()

MenuItem *	selectButtonPress ()

ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)

void	horizontalEncoderAction (int32_t offset)

ModelStackWithAutoParam *	getModelStackWithParam (void *memory) override

Public Member Functions inherited from deluge::gui::menu_item::Automation
MenuItem *	selectButtonPress ()

ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)

virtual PatchSource	getPatchSource ()

void	selectAutomationViewParameter (bool clipMinder)

void	handleAutomationViewParameterUpdate ()
	MenuItem::updateAutomationViewParameter forwards here when necessary.

Public Member Functions inherited from MenuItemWithCCLearning
void	unlearnAction ()

bool	allowsLearnMode () const

void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel)

Public Member Functions inherited from deluge::gui::menu_item::Integer
void	selectEncoderAction (int32_t offset) override
	Handle select encoder movement.

Public Member Functions inherited from deluge::gui::menu_item::Number
void	drawBar (int32_t yTop, int32_t marginL, int32_t marginR=-1)

void	renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height) override

Public Member Functions inherited from deluge::gui::menu_item::Value< int32_t >
	MenuItem ()

	MenuItem (deluge::l10n::String newName, deluge::l10n::String newTitle=deluge::l10n::String::EMPTY_STRING)

	MenuItem (const MenuItem &other)=delete

	MenuItem (const MenuItem &&other)=delete

void	beginSession (MenuItem *navigatedBackwardFrom) override
	Begin an editing session with this menu item.

void	selectEncoderAction (int32_t offset) override
	Handle select encoder movement.

void	readValueAgain () override
	Re-read the value from the system and redraw the display to match.

bool	selectEncoderActionEditsInstrument () final
	Used by the sound editor to mark the current instrument as edited when the select encoder is scrolled.

void	setValue (int32_t value)

void	setValue (E value)

int32_t	getValue ()

E	getValue ()

	MenuItem ()

	MenuItem (deluge::l10n::String newName, deluge::l10n::String newTitle=deluge::l10n::String::EMPTY_STRING)

	MenuItem (const MenuItem &other)=delete

	MenuItem (const MenuItem &&other)=delete

Public Member Functions inherited from MenuItem
	MenuItem (deluge::l10n::String newName, deluge::l10n::String newTitle=deluge::l10n::String::EMPTY_STRING)

	MenuItem (const MenuItem &other)=delete

	MenuItem (const MenuItem &&other)=delete

MenuItem &	operator= (const MenuItem &other)=delete

MenuItem &	operator= (const MenuItem &&other)=delete

virtual void	verticalEncoderAction (int32_t offset)
	Handle vertical encoder movement.

virtual ActionResult	timerCallback ()
	Handle a TimerName::UI_SPECIFIC event.

virtual MenuPermission	checkPermissionToBeginSession (ModControllableAudio modControllable, int32_t whichThing, MultiRange *currentRange)
	Double-check that this MenuItem will work with the currently selected sound range.

virtual uint8_t	getIndexOfPatchedParamToBlink ()

virtual bool	learnNoteOn (MIDICable &cable, int32_t channel, int32_t noteCode)
	Attempt to bind this menu item to a note code.

virtual void	learnProgramChange (MIDICable &cable, int32_t channel, int32_t programNumber)

virtual void	learnCC (MIDICable &cable, int32_t channel, int32_t ccNumber, int32_t value)

virtual bool	shouldBlinkLearnLed ()

virtual bool	isRangeDependent ()
	Returns true if this parameter is only relevant to some note ranges.

virtual void	renderOLED ()
	Root rendering routine for OLED.

virtual std::string_view	getTitle () const
	Get the title to be used when rendering on OLED, both as a deluge::gui::menu_item::Submenu and when displaying ourselves (using the default renderOLED implementation).

virtual void	drawName ()
	Draw the name we want to use when selecting this in a deluge::gui::menu_item::Submenu to the 7SEG.

virtual std::string_view	getName () const
	Get the actual name for use on OLED for deluge::gui::menu_item::Submenu s.

virtual void	getColumnLabel (StringBuf &label)
	Get the name for use on horizontal menus.

virtual bool	isRelevant (ModControllableAudio *modControllable, int32_t whichThing)
	Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.

virtual bool	shouldEnterSubmenu ()
	Check if selecting this menu item (with select encoder) should enter a submenu.

virtual int32_t	getSubmenuItemTypeRenderLength ()
	Handle rendering of submenu item types.

virtual int32_t	getSubmenuItemTypeRenderIconStart ()

virtual void	renderSubmenuItemTypeForOled (int32_t yPixel)

virtual bool	isSubmenu ()

virtual void	setupNumberEditor ()

virtual void	updatePadLights ()

void	renderColumnLabel (int32_t startX, int32_t width, int32_t startY)

Protected Member Functions
void	readCurrentValue () override
	Like readValueAgain, but does not redraw.

void	writeCurrentValue () final

virtual int32_t	getFinalValue ()

Protected Member Functions inherited from deluge::gui::menu_item::PatchedParam
ParamSet *	getParamSet () override

Protected Member Functions inherited from deluge::gui::menu_item::IntegerContinuous
void	drawPixelsForOled ()
	Paints the pixels below the standard title block.

Protected Member Functions inherited from deluge::gui::menu_item::Integer
virtual int32_t	getDisplayValue ()

virtual const char *	getUnit ()

virtual void	drawInteger (int32_t textWidth, int32_t textHeight, int32_t yPixel)

Additional Inherited Members
static void	drawItemsForOled (std::span< std::string_view > options, int32_t selectedOption, int32_t offset=0)
	Internal helper which can draw the standard deluge::gui::menu_item::Submenu layout.

Public Attributes inherited from deluge::gui::menu_item::Param
uint8_t	p

deluge::l10n::String	title
	Can get overridden by getTitle(). Actual max num chars for OLED display is 14.

const deluge::l10n::String	name
	Default name for use on OLED for deluge::gui::menu_item::Submenu s.

Member Function Documentation

◆ allowsLearnMode()

bool deluge::gui::menu_item::patched_param::Integer::allowsLearnMode ( )

inlinefinalvirtual

Used by SoundEditor to determine if the current menu item can accept MIDI learning.

Reimplemented from MenuItem.

◆ buttonAction()

ActionResult deluge::gui::menu_item::patched_param::Integer::buttonAction	(	deluge::hid::Button	b,
		bool	on,
		bool	inCardRoutine )

inlinefinalvirtual

Handle an arbitrary button.

The returned result is forwarded up the View stack, so returning ActionResult::DEALT_WITH will suppress buttons going to the current View.

This is called with (b == SELECT_ENC && on) immediately after the menu is entered, or after selectButtonPress is called and returns NO_NAVIGATION.

Reimplemented from MenuItem.

◆ drawValue()

void deluge::gui::menu_item::patched_param::Integer::drawValue ( )

inlineoverridevirtual

Implements deluge::gui::menu_item::PatchedParam.

◆ getLearningThing()

ParamDescriptor deluge::gui::menu_item::patched_param::Integer::getLearningThing ( )

inlinefinalvirtual

Implements MenuItemWithCCLearning.

◆ getMaxValue()

int32_t deluge::gui::menu_item::patched_param::Integer::getMaxValue ( ) const

inlinenodiscardoverridevirtual

Reimplemented from deluge::gui::menu_item::Param.

◆ getMinValue()

int32_t deluge::gui::menu_item::patched_param::Integer::getMinValue ( ) const

inlinenodiscardoverridevirtual

Reimplemented from deluge::gui::menu_item::Param.

◆ getParamIndex()

uint32_t deluge::gui::menu_item::patched_param::Integer::getParamIndex ( )

inlinefinalvirtual

Reimplemented from deluge::gui::menu_item::PatchedParam.

◆ getParamKind()

deluge::modulation::params::Kind deluge::gui::menu_item::patched_param::Integer::getParamKind ( )

inlinefinalvirtual

Reimplemented from deluge::gui::menu_item::PatchedParam.

◆ horizontalEncoderAction()

void deluge::gui::menu_item::patched_param::Integer::horizontalEncoderAction ( int32_t offset )

inlinefinalvirtual

Handle horizontal encoder movement.

Parameters

offset must be either -1 or 1, jumping is not supported by many children.

Reimplemented from MenuItem.

◆ learnKnob()

void deluge::gui::menu_item::patched_param::Integer::learnKnob	(	MIDICable *	cable,
		int32_t	whichKnob,
		int32_t	modKnobMode,
		int32_t	midiChannel )

inlinefinalvirtual

Learn a mod knob to the parameter edited by this menu.

Parameters

cable The MIDI cable to learn from, or null if a mod knob is to be learned.

Reimplemented from MenuItem.

◆ patchingSourceShortcutPress()

MenuItem * deluge::gui::menu_item::patched_param::Integer::patchingSourceShortcutPress	(	PatchSource	s,
		bool	previousPressStillActive = false )

inlinefinalvirtual

Action to take when a source shortcut is pressed.

Potentially reconfigures some SoundEditor state so patching will work.

Parameters

s	The source being pressed.
previousPressStillActive	True if there is another patch source press still active. Useful to set up cable strength modulation.

Returns

NO_NAVIGATION if the SoundEditor should ask the menu 1 layer up in the stack what to do
nullptr if nothing should happen
A valid MenuItem if we should switch to that menu item.

Reimplemented from MenuItem.

◆ readCurrentValue()

void deluge::gui::menu_item::patched_param::Integer::readCurrentValue ( )

overrideprotectedvirtual

Like readValueAgain, but does not redraw.

Reimplemented from MenuItem.

Reimplemented in deluge::gui::menu_item::osc::PulseWidth, and deluge::gui::menu_item::patched_param::Pan.

◆ selectButtonPress()

MenuItem * deluge::gui::menu_item::patched_param::Integer::selectButtonPress ( )

inlinefinalvirtual

Handle a select button press.

Returns

NO_NAVIGATION if the SoundEditor should stay on the current menu.
nullptr if the SoundEditor should go up one level in the menu stack.
otherwise, enter the returned menu.

Reimplemented from MenuItem.

◆ shouldBlinkPatchingSourceShortcut()

uint8_t deluge::gui::menu_item::patched_param::Integer::shouldBlinkPatchingSourceShortcut	(	PatchSource	s,
		uint8_t *	colour )

inlinefinalvirtual

Get the frequency at which this pad should blink the given source.

Parameters

colour Output parameter for the colour to use when blinking.

Returns: Blink time period (higher means more delay between flashes), or 255 if we shouldn't blink.

Reimplemented from MenuItem.

◆ shouldDrawDotOnName()

uint8_t deluge::gui::menu_item::patched_param::Integer::shouldDrawDotOnName ( )

inlinefinalvirtual

Reimplemented from deluge::gui::menu_item::PatchedParam.

◆ unlearnAction()

void deluge::gui::menu_item::patched_param::Integer::unlearnAction ( )

inlinefinalvirtual

Unlearn the parameter controlled by this menu.

Reimplemented from MenuItem.

◆ updateAutomationViewParameter()

void deluge::gui::menu_item::patched_param::Integer::updateAutomationViewParameter ( )

overridevirtual

Called to inform automation view that the active parameter has changed. Parameters inheriting from Automation forward there, no-op for everything else.

Reimplemented from MenuItem.

◆ usesAffectEntire()

bool deluge::gui::menu_item::patched_param::Integer::usesAffectEntire ( )

inlineoverridevirtual

Claim support for Kit AFFECT_ENTIRE editing.

Returns: true if this Menu can edit parameters across an entire kit if changed with AFFECT_ENTIRE held down.

Reimplemented from MenuItem.

◆ writeCurrentValue()

void deluge::gui::menu_item::patched_param::Integer::writeCurrentValue ( )

finalprotectedvirtual

Reimplemented from deluge::gui::menu_item::Value< int32_t >.

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

src/deluge/gui/menu_item/patched_param/integer.h
src/deluge/gui/menu_item/patched_param/integer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ allowsLearnMode()

◆ buttonAction()

◆ drawValue()

◆ getLearningThing()

◆ getMaxValue()

◆ getMinValue()

◆ getParamIndex()

◆ getParamKind()

◆ horizontalEncoderAction()

◆ learnKnob()

◆ patchingSourceShortcutPress()

◆ readCurrentValue()

◆ selectButtonPress()

◆ shouldBlinkPatchingSourceShortcut()

◆ shouldDrawDotOnName()

◆ unlearnAction()

◆ updateAutomationViewParameter()

◆ usesAffectEntire()

◆ writeCurrentValue()