deluge::gui::menu_item::sample::Transpose Class Reference

Inheritance diagram for deluge::gui::menu_item::sample::Transpose:

Collaboration diagram for deluge::gui::menu_item::sample::Transpose:

Public Member Functions
	Transpose (l10n::String name, l10n::String title_format_str, int32_t newP)
std::string_view	getTitle () const override
	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).
void	readCurrentValue () override
	Like readValueAgain, but does not redraw.
bool	usesAffectEntire () override
	Claim support for Kit AFFECT_ENTIRE editing.
void	writeCurrentValue () override
MenuPermission	checkPermissionToBeginSession (ModControllableAudio *modControllable, int32_t whichThing, ::MultiRange **currentRange) override
bool	isRangeDependent () override
	Returns true if this parameter is only relevant to some note ranges.
Public Member Functions inherited from deluge::gui::menu_item::source::Transpose
ParamDescriptor	getLearningThing () final
	Transpose (l10n::String newName, int32_t newP=0)
	Transpose (l10n::String newName, l10n::String title, int32_t newP=0)
Public Member Functions inherited from deluge::gui::menu_item::Transpose
	Transpose (l10n::String newName, int32_t newP=0)
	Transpose (l10n::String newName, l10n::String title, int32_t newP=0)
MenuItem *	selectButtonPress () final
	Handle a select button press.
int32_t	getMinValue () const final
int32_t	getMaxValue () const final
int32_t	getNumDecimalPlaces () const final
uint32_t	getParamIndex () final
uint8_t	shouldDrawDotOnName () final
	Get the "draw dot state".
void	drawValue () final
uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour) 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
Public Member Functions inherited from deluge::gui::menu_item::Decimal
void	beginSession (MenuItem *navigatedBackwardFrom=nullptr) override
	Begin an editing session with this menu item.
void	selectEncoderAction (int32_t offset) override
	Handle select encoder movement.
void	horizontalEncoderAction (int32_t offset) override
	Handle horizontal encoder movement.
Public Member Functions inherited from deluge::gui::menu_item::Number
void	renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height) override
void	drawHorizontalBar (int32_t yTop, int32_t marginL, int32_t marginR=-1, int32_t height=8)
void	drawKnob (int32_t startX, int32_t startY, int32_t width, int32_t height)
void	drawVerticalBar (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight)
void	drawPercent (int32_t startX, int32_t startY, int32_t width, int32_t height)
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)
int32_t	getValue ()
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 ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)
	Handle an arbitrary button.
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 void	endSession ()
	End an editing session with this menu item.
virtual uint8_t	getIndexOfPatchedParamToBlink ()
virtual deluge::modulation::params::Kind	getParamKind ()
virtual void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel)
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 void	renderOLED ()
	Root rendering routine for OLED.
virtual void	getColumnLabel (StringBuf &label)
virtual bool	showColumnLabel () const
	Show a label for the parameter in the horizontal menu.
virtual int32_t	getColumnSpan () const
	Get the number of occupied virtual columns in the horizontal menu.
virtual bool	showPopup () const
	Show a popup with the full name of the editing parameter at the top of the horizontal menu.
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 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 ()
virtual void	updateAutomationViewParameter ()
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)
virtual deluge::modulation::params::Kind	getParamKind ()
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)
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::FormattedTitle
	FormattedTitle (l10n::String format_str)
void	format (int32_t arg)
std::string_view	title () const

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.
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.
Public Attributes inherited from deluge::gui::menu_item::Param
uint8_t	p
Protected Member Functions inherited from deluge::gui::menu_item::source::Transpose
uint8_t	getP () final
Protected Member Functions inherited from deluge::gui::menu_item::Decimal
virtual int32_t	getDefaultEditPos () const
void	drawPixelsForOled () override
	Paints the pixels below the standard title block.
virtual void	drawActualValue (bool justDidHorizontalScroll=false)
virtual void	appendAdditionalDots (std::vector< uint8_t > &dotPositions)
int32_t	getNonZeroDecimalPlacesCount ()
Protected Member Functions inherited from deluge::gui::menu_item::Number
virtual NumberStyle	getNumberStyle () const
void	getValueForPopup (StringBuf &value) override
	Get the parameter value string to show in the popup.
bool	showValueInPopup () const override
	Show a parameter value in the popup at the top of the horizontal menu.
float	getValuePercent ()
Protected Member Functions inherited from deluge::gui::menu_item::PatchedParam
ParamSet *	getParamSet () override

Member Function Documentation

getTitle()

std::string_view deluge::gui::menu_item::sample::Transpose::getTitle ( ) const

inlinenodiscardoverridevirtual

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).

If not overridden, defaults to returning title.

The returned pointer must live long enough for us to draw the title, which for practical purposes means "the lifetime of this menu item"

Reimplemented from MenuItem.

isRangeDependent()

bool deluge::gui::menu_item::sample::Transpose::isRangeDependent ( )

inlineoverridevirtual

Returns true if this parameter is only relevant to some note ranges.

Reimplemented from MenuItem.

readCurrentValue()

void deluge::gui::menu_item::sample::Transpose::readCurrentValue ( )

inlineoverridevirtual

Like readValueAgain, but does not redraw.

Reimplemented from MenuItem.

usesAffectEntire()

bool deluge::gui::menu_item::sample::Transpose::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::sample::Transpose::writeCurrentValue ( )

inlineoverridevirtual

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

---

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

• src/deluge/gui/menu_item/sample/transpose.h