Package heronarts.lx.studio.ui.modulation

Class UIAbstractGlobalModulator

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.lx.studio.ui.modulation.UIModulator

heronarts.lx.studio.ui.modulation.UIAbstractGlobalModulator

All Implemented Interfaces:

UIContainer, UIContextActions, UICopy, UIDuplicate, UIKeyFocus, UIMouseFocus, UIPaste, UITriggerTarget, LXLoopTask, UIModulationMappings.Container, Iterable<UIObject>

Direct Known Subclasses:

UIComponentModulator, UIGlobalModulator

public abstract class UIAbstractGlobalModulator
extends UIModulator
implements UIModulationMappings.Container, UIMouseFocus, UIKeyFocus, UITriggerTarget, UIDuplicate, UIContextActions

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dContainer

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout, UI2dContainer.Position

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dComponent

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Nested classes/interfaces inherited from interface heronarts.glx.ui.UIContextActions

UIContextActions.Action, UIContextActions.ContextAction

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	COLOR_WIDTH
final LXComponent	component
protected static final int	CONTENT_Y
protected static final int	LOOP_WIDTH
static final int	MAP_WIDTH
final UIModulationMappings	modulations
final LXModulator	modulator
protected static final int	PADDING
protected static final int	RUNNING_X
protected final UITextBox	title
protected static final int	TITLE_X
protected final UI2dComponent	toggleTarget

Fields inherited from class heronarts.lx.studio.ui.modulation.UIModulator

ui

Fields inherited from class heronarts.glx.ui.UI2dContainer

bottomPadding, childSpacingX, childSpacingY, leftPadding, rightPadding, topPadding

Fields inherited from class heronarts.glx.ui.UI2dComponent

borderRoundingBottomLeft, borderRoundingBottomRight, borderRoundingTopLeft, borderRoundingTopRight, debug, debugName, hasBorderRounding, height, marginBottom, marginLeft, marginRight, marginTop, redraw, scissor, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, width, x, y

Fields inherited from class heronarts.glx.ui.UIObject

children, hasFocus, visible

Constructor Summary

Constructors

Constructor	Description
UIAbstractGlobalModulator(UI ui, LX lx, LXComponent component, boolean isGlobalModulator, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method	Description
List<UIContextActions.Action>	getContextActions()	Returns a list of context actions that should be shown for this item
UIModulationMappings	getModulationMappings()
BooleanParameter	getTriggerTarget()
boolean	isExpanded()
LXClipboardItem	onCopy()
void	onDraw(UI ui, VGraphics vg)	Subclasses should override this method to perform their drawing functions.
void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode)	Subclasses override to receive key events
void	onMousePressed(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
void	onPaste(LXClipboardItem item)
UIAbstractGlobalModulator	setExpanded(boolean expanded)
UIAbstractGlobalModulator	toggleExpanded()

Methods inherited from class heronarts.lx.studio.ui.modulation.UIModulator

getModulationSourceUI, isDeviceModulator, newMacroSizeButton, setModulationSourceUI, showModulatorError

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, getScrollHeight, getScrollWidth, getTopPadding, hasDragToReorder, isEmpty, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onReflow, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setChildSpacingX, setChildSpacingY, setContentHeight, setContentSize, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, drawBorder, drawComponentBackground, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getBottomMargin, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getLeftMargin, getMappableParameter, getNextSibling, getNextSibling, getParent, getPrevSibling, getPrevSibling, getRightMargin, getTopMargin, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, onResize, redraw, removeFromContainer, removeFromContainer, setBackground, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBorderColor, setBorderRounding, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setContainerPosition, setDebug, setDebug, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusBackgroundColor, setFocusColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY, vgRoundedRect, vgRoundedRect, vgRoundedRect

Methods inherited from class heronarts.glx.ui.UIObject

addListener, addListener, addLoopTask, addLoopTask, blur, bringToFront, dispose, focus, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMouseReleased, onMouseScroll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface heronarts.glx.ui.UIDuplicate

onDuplicate

Field Details

PADDING

protected static final int PADDING

See Also:

• Constant Field Values

RUNNING_X

protected static final int RUNNING_X

See Also:

• Constant Field Values

TITLE_X

protected static final int TITLE_X

See Also:

• Constant Field Values

CONTENT_Y

protected static final int CONTENT_Y

See Also:

• Constant Field Values

MAP_WIDTH

public static final int MAP_WIDTH

See Also:

• Constant Field Values

LOOP_WIDTH

protected static final int LOOP_WIDTH

See Also:

• Constant Field Values

COLOR_WIDTH

protected static final int COLOR_WIDTH

See Also:

• Constant Field Values

component

public final LXComponent component

modulator

public final LXModulator modulator

toggleTarget

protected final UI2dComponent toggleTarget

title

protected final UITextBox title

modulations

public final UIModulationMappings modulations

Constructor Details

UIAbstractGlobalModulator

public UIAbstractGlobalModulator(UI ui,
 LX lx,
 LXComponent component,
 boolean isGlobalModulator,
 float x,
 float y,
 float w,
 float h)

Method Details

getModulationMappings

public UIModulationMappings getModulationMappings()

Specified by:

getModulationMappings in interface UIModulationMappings.Container

setExpanded

public UIAbstractGlobalModulator setExpanded(boolean expanded)

toggleExpanded

public UIAbstractGlobalModulator toggleExpanded()

isExpanded

public boolean isExpanded()

getTriggerTarget

public BooleanParameter getTriggerTarget()

Specified by:

getTriggerTarget in interface UITriggerTarget

onDraw

public void onDraw(UI ui,
 VGraphics vg)

Description copied from class: UI2dComponent

Subclasses should override this method to perform their drawing functions.

Overrides:

onDraw in class UI2dContainer

Parameters:

ui - UI context

vg - Graphics context

onKeyPressed

public void onKeyPressed(KeyEvent keyEvent,
 char keyChar,
 int keyCode)

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyPressed in class UI2dContainer

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

onMousePressed

public void onMousePressed(MouseEvent mouseEvent,
 float mx,
 float my)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMousePressed in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste

getContextActions

public List<UIContextActions.Action> getContextActions()

Description copied from interface: UIContextActions

Returns a list of context actions that should be shown for this item

Specified by:

getContextActions in interface UIContextActions

Returns:

List of context actions