Package heronarts.glx.ui.component

Class UIKnob

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIParameterComponent

heronarts.glx.ui.component.UIInputBox

heronarts.glx.ui.component.UIParameterControl

heronarts.glx.ui.component.UICompoundParameterControl

heronarts.glx.ui.component.UIKnob

All Implemented Interfaces:

UIContextActions, UIControlTarget, UICopy, UIFocus, UIKeyFocus, UIModulationSource, UIModulationTarget, UIMouseFocus, UIPaste, UITabFocus, LXLoopTask, LXParameterListener

public class UIKnob
extends UICompoundParameterControl
implements UIFocus

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.glx.ui.component.UIInputBox

UIInputBox.EditState, UIInputBox.FillStyle, UIInputBox.ProgressIndicator

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
static final int	HEIGHT
static final int	KNOB_MARGIN
static final int	KNOB_SIZE
static final int	WIDTH

Fields inherited from class heronarts.glx.ui.component.UIParameterControl

enabled, keyEditable, LABEL_HEIGHT, LABEL_MARGIN, parameter, polarity, TEXT_MARGIN

Fields inherited from class heronarts.glx.ui.component.UIInputBox

editable, editing, fillColor, fillStyle, hasFill, mouseEditable, returnKeyEdit

Fields inherited from class heronarts.glx.ui.component.UIParameterComponent

DEFAULT_HEIGHT, useCommandEngine

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
UIKnob()
UIKnob(float x, float y)
UIKnob(float x, float y, float w, float h)
UIKnob(float x, float y, LXNormalizedParameter parameter)
UIKnob(LXNormalizedParameter parameter)

Method Summary

Modifier and Type	Method	Description
protected void	onDraw(UI ui, VGraphics vg)	Subclasses should override this method to perform their drawing functions.
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy)	Subclasses override to receive mouse events
protected void	onMousePressed(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events

Methods inherited from class heronarts.glx.ui.component.UICompoundParameterControl

addModulationContextActions, dispose, enableModulationRedraw, getCompoundNormalized, getContextActions, setParameter

Methods inherited from class heronarts.glx.ui.component.UIParameterControl

decrementValue, drawParameterLabel, getBaseNormalized, getControlTarget, getDescription, getDescription, getFocusColor, getModulatedValueColor, getModulationSource, getModulationTarget, getParameter, getValueString, incrementValue, isEnabled, isShowLabel, isTriggerParameter, isValidCharacter, isWrappable, onBlur, onCopy, onKeyPressed, onKeyReleased, onMouseReleased, onParameterChanged, onPaste, saveEditBuffer, setEditable, setEnabled, setLabel, setNormalized, setPolarity, setShowLabel

Methods inherited from class heronarts.glx.ui.component.UIInputBox

disableImmediateAppend, disableImmediateEdit, disableReturnKeyEdit, edit, edit, editAppend, enableImmediateAppend, enableImmediateEdit, enableReturnKeyEdit, getEditBuffer, getEditRange, getFillWidthNormalized, getInitialEditBufferValue, incrementMouseValue, isEditable, onDrawText, onEditChange, onEditFinished, setMouseEditable, setProgressColor, setProgressColor, setProgressColor, setProgressIndicator, setValueCommand

Methods inherited from class heronarts.glx.ui.component.UIParameterComponent

getOscAddress, setEnableContextActions, setModulationRangeCommand, setNormalizedCommand, setUseCommandEngine

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, 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, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

KNOB_MARGIN

public static final int KNOB_MARGIN

See Also:

• Constant Field Values

KNOB_SIZE

public static final int KNOB_SIZE

See Also:

• Constant Field Values

WIDTH

public static final int WIDTH

See Also:

• Constant Field Values

HEIGHT

public static final int HEIGHT

See Also:

• Constant Field Values

Constructor Details

UIKnob

public UIKnob(LXNormalizedParameter parameter)

UIKnob

public UIKnob(float x,
 float y,
 LXNormalizedParameter parameter)

UIKnob

public UIKnob()

UIKnob

public UIKnob(float x,
 float y)

UIKnob

public UIKnob(float x,
 float y,
 float w,
 float h)

Method Details

onDraw

protected 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 UIParameterControl

Parameters:

ui - UI context

vg - Graphics context

onMousePressed

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

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMousePressed in class UIParameterControl

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onMouseDragged

protected void onMouseDragged(MouseEvent mouseEvent,
 float mx,
 float my,
 float dx,
 float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseDragged in class UIInputBox

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y