Package heronarts.glx.ui.component

Class UIMeter

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIMeter

All Implemented Interfaces:

UIModulationSource, LXLoopTask

public class UIMeter
extends UI2dComponent
implements UIModulationSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UIMeter.Axis

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

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Field Summary

Fields

Modifier and Type	Field	Description
protected float	drawPixels

Fields inherited from class heronarts.glx.ui.UI2dComponent

debug, debugName, 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
UIMeter(UI ui, LXNormalizedParameter parameter, float x, float y, float w, float h)
UIMeter(UI ui, LXNormalizedParameter parameter, UIMeter.Axis axis, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component.
LXNormalizedParameter	getModulationSource()
static UIMeter	newHorizontalMeter(UI ui, LXNormalizedParameter parameter, float w, float h)
static UIMeter	newVerticalMeter(UI ui, LXNormalizedParameter parameter, float w, float h)
void	onDraw(UI ui, VGraphics vg)	Subclasses should override this method to perform their drawing functions.
UIMeter	setParameter(LXNormalizedParameter parameter)

Methods inherited from class heronarts.glx.ui.UI2dComponent

addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getMappableParameter, getNextSibling, getParent, getPrevSibling, 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, blur, bringToFront, dispose, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onKeyPressed, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

drawPixels

protected float drawPixels

Constructor Details

UIMeter

public UIMeter(UI ui,
 LXNormalizedParameter parameter,
 float x,
 float y,
 float w,
 float h)

UIMeter

public UIMeter(UI ui,
 LXNormalizedParameter parameter,
 UIMeter.Axis axis,
 float x,
 float y,
 float w,
 float h)

Method Details

newHorizontalMeter

public static UIMeter newHorizontalMeter(UI ui,
 LXNormalizedParameter parameter,
 float w,
 float h)

newVerticalMeter

public static UIMeter newVerticalMeter(UI ui,
 LXNormalizedParameter parameter,
 float w,
 float h)

setParameter

public UIMeter setParameter(LXNormalizedParameter parameter)

getDescription

public String getDescription()

Description copied from class: UIObject

Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component. If no help is available, return null rather than an empty String.

Overrides:

getDescription in class UIObject

Returns:

Helpful contextual string explaining function of this element

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 UI2dComponent

Parameters:

ui - UI context

vg - Graphics context

getModulationSource

public LXNormalizedParameter getModulationSource()

Specified by:

getModulationSource in interface UIModulationSource