UI Class Reference

Inheritance diagram for UI:

Public Member Functions
virtual ActionResult	padAction (int32_t x, int32_t y, int32_t velocity)
virtual ActionResult	buttonAction (deluge::hid::Button b, bool on, bool inCardRoutine)
virtual ActionResult	horizontalEncoderAction (int32_t offset)
virtual ActionResult	verticalEncoderAction (int32_t offset, bool inCardRoutine)
virtual void	selectEncoderAction (int8_t offset)
virtual void	modEncoderAction (int32_t whichModEncoder, int32_t offset)
virtual void	modButtonAction (uint8_t whichButton, bool on)
virtual void	modEncoderButtonAction (uint8_t whichModEncoder, bool on)
virtual void	graphicsRoutine ()
virtual ActionResult	timerCallback ()
virtual bool	opened ()
virtual void	focusRegained ()
virtual void	displayOrLanguageChanged ()
virtual bool	canSeeViewUnderneath ()
virtual ClipMinder *	toClipMinder ()
virtual TimelineView *	toTimelineView ()
	Convert this view to a TimelineView.
virtual void	scrollFinished ()
virtual bool	pcReceivedForMidiLearn (MIDICable &fromCable, int32_t channel, int32_t program)
virtual bool	noteOnReceivedForMidiLearn (MIDICable &fromCable, int32_t channel, int32_t note, int32_t velocity)
virtual bool	getGreyoutColsAndRows (uint32_t *cols, uint32_t *rows)
virtual bool	renderMainPads (uint32_t whichRows=0, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr, bool drawUndefinedArea=true)
virtual bool	renderSidebar (uint32_t whichRows=0, RGB image[][kDisplayWidth+kSideBarWidth]=nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth]=nullptr)
virtual bool	exitUI ()
	returns whether a UI exited
void	close ()
virtual void	renderOLED (deluge::hid::display::oled_canvas::Canvas &canvas)=0
virtual UI *	getUI ()
	When entering a UI (e.g. automationView), you may wish to open a different UI based on the current context (e.g. automationViewArranger, automationViewAudioClip, etc.)
virtual UIType	getUIType ()=0
	What type of UI is this? e.g. UIType::ARRANGER.
virtual UIType	getUIContextType ()
	What context does UI relate to? e.g. UIType could be AUTOMATION but UIContextType could be ARRANGER, AUDIO CLIP, INSTRUMENT CLIP.
virtual UIModControllableContext	getUIModControllableContext ()
	What mod controllable context is this UI using? E.g. Automation View can use the Song ModControllable when in Arranger but the Clip ModControllable when in a Clip.

Public Attributes
bool	oledShowsUIUnderneath

Protected Attributes
UIType	uiType

Member Function Documentation

exitUI()

virtual bool UI::exitUI ( )

inlinevirtual

returns whether a UI exited

Reimplemented in Browser, RenameUI, SampleMarkerEditor, and SoundEditor.

getUIContextType()

virtual UIType UI::getUIContextType ( )

inlinevirtual

What context does UI relate to? e.g. UIType could be AUTOMATION but UIContextType could be ARRANGER, AUDIO CLIP, INSTRUMENT CLIP.

Reimplemented in AutomationView, deluge::gui::ui::keyboard::KeyboardScreen, and PerformanceView.

getUIModControllableContext()

virtual UIModControllableContext UI::getUIModControllableContext ( )

inlinevirtual

What mod controllable context is this UI using? E.g. Automation View can use the Song ModControllable when in Arranger but the Clip ModControllable when in a Clip.

Reimplemented in ArrangerView, AudioClipView, AutomationView, deluge::gui::ui::keyboard::KeyboardScreen, InstrumentClipView, PerformanceView, and SessionView.

getUIType()

virtual UIType UI::getUIType ( )

pure virtual

What type of UI is this? e.g. UIType::ARRANGER.

Implemented in ArrangerView, AudioClipView, AudioRecorder, AutomationView, deluge::gui::ContextMenu, deluge::gui::ui::keyboard::KeyboardScreen, DxSyxBrowser, InstrumentClipView, LoadInstrumentPresetUI, LoadMidiDeviceDefinitionUI, LoadPatternUI, LoadSongUI, PerformanceView, RenameUI, SampleBrowser, SampleMarkerEditor, SaveInstrumentPresetUI, SaveKitRowUI, SaveMidiDeviceDefinitionUI, SavePatternUI, SaveSongUI, SessionView, Slicer, and SoundEditor.

modEncoderAction()

void UI::modEncoderAction ( int32_t whichModEncoder, int32_t offset )

virtual

Reimplemented in PerformanceView.

modEncoderButtonAction()

void UI::modEncoderButtonAction ( uint8_t whichModEncoder, bool on )

virtual

Reimplemented in PerformanceView.

renderSidebar()

virtual bool UI::renderSidebar ( uint32_t whichRows = 0, RGB image[][kDisplayWidth+kSideBarWidth] = nullptr, uint8_t occupancyMask[][kDisplayWidth+kSideBarWidth] = nullptr )

inlinevirtual

Reimplemented in PerformanceView.

selectEncoderAction()

virtual void UI::selectEncoderAction ( int8_t offset )

inlinevirtual

Reimplemented in PerformanceView.

toClipMinder()

virtual ClipMinder * UI::toClipMinder ( )

inlinevirtual

Convert this clip to a clip minder. Returns true for views which manage a single clip, false for song level views

Reimplemented in AudioClipView, AutomationView, deluge::gui::ui::keyboard::KeyboardScreen, and InstrumentClipView.

toTimelineView()

virtual TimelineView * UI::toTimelineView ( )

inlinevirtual

Convert this view to a TimelineView.

Returns

nullptr if the view is not a TimelineView, otherwise this cast to a TimelineView

Reimplemented in TimelineView.

verticalEncoderAction()

virtual ActionResult UI::verticalEncoderAction ( int32_t offset, bool inCardRoutine )

inlinevirtual

Reimplemented in InstrumentClipView.

---

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

• src/deluge/gui/ui/ui.h
• src/deluge/gui/ui/ui.cpp