Inheritance diagram for deluge::gui::menu_item::osc::RetriggerPhase:

[legend]

Collaboration diagram for deluge::gui::menu_item::osc::RetriggerPhase:

[legend]

Public Member Functions
	RetriggerPhase (l10n::String newName, l10n::String title_format_str, uint8_t source_id, bool newForModulator=false)
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).
int32_t	getMinValue () const override
int32_t	getMaxValue () const override
int32_t	getNumDecimalPlaces () const override
int32_t	getDefaultEditPos () const override
void	readCurrentValue () override
	Like readValueAgain, but does not redraw.
void	writeCurrentValue () override
void	drawValue () override
void	drawPixelsForOled () override
	Paints the pixels below the standard title block.
void	horizontalEncoderAction (int32_t offset) override
	Handle horizontal encoder movement.
bool	isRelevant (ModControllableAudio *modControllable, int32_t whichThing) override
	Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.
int32_t	getNumberEditSize () override
void	selectEncoderAction (int32_t offset) override
	Handle select encoder movement.
void	renderInHorizontalMenu (int32_t startX, int32_t width, int32_t startY, int32_t height) override
void	getNotificationValue (StringBuf &valueBuf) override
	Get the parameter value string to show in the popup.
void	getColumnLabel (StringBuf &label) override
NumberStyle	getNumberStyle () const override
Public Member Functions inherited from deluge::gui::menu_item::Decimal
void	beginSession (MenuItem *navigatedBackwardFrom=nullptr) override
	Begin an editing session with this menu item.
Public Member Functions inherited from deluge::gui::menu_item::Number
void	drawHorizontalBar (int32_t yTop, int32_t marginL, int32_t marginR=-1, int32_t height=8)
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 MenuItem *	selectButtonPress ()
	Handle a select button press.
virtual ActionResult	timerCallback ()
	Handle a TimerName::UI_SPECIFIC event.
virtual bool	usesAffectEntire ()
	Claim support for Kit AFFECT_ENTIRE editing.
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 uint32_t	getParamIndex ()
virtual uint8_t	shouldBlinkPatchingSourceShortcut (PatchSource s, uint8_t *colour)
virtual MenuItem *	patchingSourceShortcutPress (PatchSource s, bool previousPressStillActive=false)
	Action to take when a source shortcut is pressed.
virtual void	learnKnob (MIDICable *cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel)
virtual bool	allowsLearnMode ()
	Used by SoundEditor to determine if the current menu item can accept MIDI learning.
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	unlearnAction ()
	Unlearn the parameter controlled by this menu.
virtual bool	isRangeDependent ()
	Returns true if this parameter is only relevant to some note ranges.
virtual void	renderOLED ()
	Root rendering routine for OLED.
virtual uint8_t	shouldDrawDotOnName ()
	Get the "draw dot state".
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	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 ()
virtual bool	showColumnLabel () const
	Show a label for the parameter in Horizontal menu.
virtual int32_t	getColumnSpan () const
	Get the number of occupied virtual columns in Horizontal menu.
virtual bool	showNotification () const
	Show a popup with the full name and value of the editing parameter at the top of Horizontal menu.
virtual bool	allowToBeginSessionFromHorizontalMenu ()
	Allow entering menu session by selecting the menu item twice in Horizontal menu.
Public Member Functions inherited from deluge::gui::menu_item::FormattedTitle
	FormattedTitle (l10n::String format_str, std::optional< uint8_t > arg=std::nullopt)
void	format (int32_t arg) const
std::string_view	title () const

Private Member Functions
uint32_t *	getValueAddress () const

Private Attributes
bool	for_modulator_
uint8_t	source_id_

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.
deluge::gui::menu_item::Submenu *	parent {nullptr}
Protected Member Functions inherited from deluge::gui::menu_item::Decimal
virtual void	drawActualValue (bool justDidHorizontalScroll=false)
virtual void	appendAdditionalDots (std::vector< uint8_t > &dotPositions)
Protected Member Functions inherited from deluge::gui::menu_item::Number
float	getNormalizedValue ()
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	drawLevel (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)
void	drawSlider (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight)
void	drawLengthSlider (int32_t startX, int32_t startY, int32_t slotWidth, int32_t slotHeight, bool minSliderPos=3)
Static Protected Member Functions inherited from deluge::gui::menu_item::Decimal
static int32_t	getNumNonZeroDecimals (int32_t value)

Member Function Documentation

◆ drawPixelsForOled()

void deluge::gui::menu_item::osc::RetriggerPhase::drawPixelsForOled ( )

inlineoverridevirtual

Paints the pixels below the standard title block.

Reimplemented from deluge::gui::menu_item::Decimal.

◆ drawValue()

void deluge::gui::menu_item::osc::RetriggerPhase::drawValue ( )

inlineoverridevirtual

Reimplemented from deluge::gui::menu_item::Decimal.

◆ getColumnLabel()

void deluge::gui::menu_item::osc::RetriggerPhase::getColumnLabel ( StringBuf & label )

inlineoverridevirtual

Reimplemented from MenuItem.

◆ getDefaultEditPos()

int32_t deluge::gui::menu_item::osc::RetriggerPhase::getDefaultEditPos ( ) const

inlinenodiscardoverridevirtual

Reimplemented from deluge::gui::menu_item::Decimal.

◆ getMaxValue()

int32_t deluge::gui::menu_item::osc::RetriggerPhase::getMaxValue ( ) const

inlinenodiscardoverridevirtual

Implements deluge::gui::menu_item::Number.

◆ getMinValue()

int32_t deluge::gui::menu_item::osc::RetriggerPhase::getMinValue ( ) const

inlinenodiscardoverridevirtual

Reimplemented from deluge::gui::menu_item::Number.

◆ getNotificationValue()

void deluge::gui::menu_item::osc::RetriggerPhase::getNotificationValue ( StringBuf & valueBuf )

inlineoverridevirtual

Get the parameter value string to show in the popup.

Needs to be overridden

Reimplemented from deluge::gui::menu_item::Decimal.

◆ getNumberEditSize()

int32_t deluge::gui::menu_item::osc::RetriggerPhase::getNumberEditSize ( )

inlineoverridevirtual

Reimplemented from deluge::gui::menu_item::Decimal.

◆ getNumberStyle()

NumberStyle deluge::gui::menu_item::osc::RetriggerPhase::getNumberStyle ( ) const

inlinenodiscardoverridevirtual

Reimplemented from deluge::gui::menu_item::Decimal.

◆ getNumDecimalPlaces()

int32_t deluge::gui::menu_item::osc::RetriggerPhase::getNumDecimalPlaces ( ) const

inlinenodiscardoverridevirtual

Implements deluge::gui::menu_item::Decimal.

◆ getTitle()

std::string_view deluge::gui::menu_item::osc::RetriggerPhase::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.

◆ horizontalEncoderAction()

void deluge::gui::menu_item::osc::RetriggerPhase::horizontalEncoderAction ( int32_t offset )

inlineoverridevirtual

Handle horizontal encoder movement.

Parameters

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

Reimplemented from deluge::gui::menu_item::Decimal.

◆ isRelevant()

bool deluge::gui::menu_item::osc::RetriggerPhase::isRelevant	(	ModControllableAudio *	modControllable,
		int32_t	whichThing )

inlineoverridevirtual

Check if this MenuItem should show up in a containing deluge::gui::menu_item::Submenu.

Parameters

sound	Sound we would edit if we were to be entered.
whichThing	Source index within the sound. Usually ignored, but matters for e.g. oscillator and FM modulator parameters.

Reimplemented from MenuItem.

◆ readCurrentValue()

void deluge::gui::menu_item::osc::RetriggerPhase::readCurrentValue ( )

inlineoverridevirtual

Like readValueAgain, but does not redraw.

Reimplemented from MenuItem.

◆ renderInHorizontalMenu()

void deluge::gui::menu_item::osc::RetriggerPhase::renderInHorizontalMenu	(	int32_t	startX,
		int32_t	width,
		int32_t	startY,
		int32_t	height )

inlineoverridevirtual

Reimplemented from deluge::gui::menu_item::Decimal.

◆ selectEncoderAction()

void deluge::gui::menu_item::osc::RetriggerPhase::selectEncoderAction ( int32_t offset )

inlineoverridevirtual

Handle select encoder movement.

Child classes which override this should be careful to handle offsets larger than 1, as holding shift and scrolling will increase them.

Reimplemented from deluge::gui::menu_item::Decimal.

◆ writeCurrentValue()

void deluge::gui::menu_item::osc::RetriggerPhase::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/osc/retrigger_phase.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ drawPixelsForOled()

◆ drawValue()

◆ getColumnLabel()

◆ getDefaultEditPos()

◆ getMaxValue()

◆ getMinValue()

◆ getNotificationValue()

◆ getNumberEditSize()

◆ getNumberStyle()

◆ getNumDecimalPlaces()

◆ getTitle()

◆ horizontalEncoderAction()

◆ isRelevant()

◆ readCurrentValue()

◆ renderInHorizontalMenu()

◆ selectEncoderAction()

◆ writeCurrentValue()