heronarts.p3lx.ui.component

Class UIKnob

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIInputBox

heronarts.p3lx.ui.component.UIParameterControl

heronarts.p3lx.ui.component.UICompoundParameterControl

heronarts.p3lx.ui.component.UIKnob

All Implemented Interfaces:

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

public class UIKnob
extends UICompoundParameterControl
implements UIFocus

Nested Class Summary

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

UIInputBox.FillStyle, UIInputBox.ProgressIndicator

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

UIContextActions.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEIGHT
static int	KNOB_MARGIN
static int	KNOB_SIZE
static int	WIDTH

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

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

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

editable, editBuffer, editing, fillColor, fillStyle, hasFill, progressFillStyle, returnKeyEdit

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

DEFAULT_HEIGHT, useCommandEngine

Fields inherited from class heronarts.p3lx.ui.UI2dComponent

bottomMargin, height, leftMargin, rightMargin, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, topMargin, width, x, y

Fields inherited from class heronarts.p3lx.ui.UIObject

children, hasFocus, mousePressContextMenu, visible

Constructor Summary

Constructors

Constructor and Description
UIKnob()
UIKnob(float x, float y)
UIKnob(float x, float y, float w, float h)
UIKnob(float x, float y, LXListenableNormalizedParameter parameter)
UIKnob(LXListenableNormalizedParameter parameter)

Method Summary

Modifier and Type	Method and Description
protected void	onDraw(UI ui, PGraphics pg) 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.p3lx.ui.component.UICompoundParameterControl

getCompoundNormalized, registerModulation, setParameter

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

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

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

edit, enableImmediateEdit, enableMousePressEdit, enableReturnKeyEdit, getEditBufferValue, getFillWidthNormalized, incrementMouseValue, isEditable, setProgressColor, setProgressColor, setProgressFillStyle, setProgressIndicator, setValueCommand

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

getContextActions, getOscAddress, setNormalizedCommand, setUseCommandEngine

Methods inherited from class heronarts.p3lx.ui.UI2dComponent

addToContainer, addToContainer, breakTextToWidth, clipTextToWidth, contains, drawBackground, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, getBackgroundColor, getBorderColor, getBorderRounding, getBorderWeight, getContainer, getFocusSize, getFont, getFontColor, getHeight, getNextSibling, getParent, getPrevSibling, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, onResize, redraw, removeFromContainer, setBackground, setBackgroundColor, setBorder, setBorderColor, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY

Methods inherited from class heronarts.p3lx.ui.UIObject

addLoopTask, beginDraw, blur, bringToFront, consumeKeyEvent, consumeMousePress, consumeMouseWheelEvent, endDraw, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyTyped, onMouseClicked, onMouseMoved, onMouseOut, onMouseOver, onMouseWheel

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

UIKnob

public UIKnob(LXListenableNormalizedParameter parameter)

UIKnob

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

UIKnob

public UIKnob()

UIKnob

public UIKnob(float x,
              float y)

UIKnob

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

Method Detail

onDraw

protected void onDraw(UI ui,
                      PGraphics pg)

Description copied from class: UIObject

Subclasses should override this method to perform their drawing functions.

Overrides:

onDraw in class UIParameterControl

Parameters:

ui - UI context

pg - 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