Dragengine.Gui.ProgressGauge Class Reference

Show progress of value inside range. More...

Inheritance diagram for Dragengine.Gui.ProgressGauge:

Public Member Functions
void	dispose ()
CanvasCreator	getBlendCanvasCreator ()
	Blend canvas creator or null to show no gauge.
float	getBlendWidth ()
	Width of blending in the range from 0 to 1.
CanvasCreator	getGaugeCanvasCreator ()
	gauge canvas creator or null to show no gauge.
Point	getMinimumSize ()
RangeModel	getModel ()
	Model.
float	getPercentage ()
	Progress percentage in the range from 0 to 1.
bool	getShowPercentage ()
	Show percentage label.
ProgressGauge	new ()
	Create progress gauge widget.
ProgressGauge	new (RangeModel model)
	Create progress gauge widget with model.
ProgressGauge	new (RangeModel model, String designerSelector)
	Create progress gauge widget with model and designer selector.
ProgressGauge	new (String designerSelector)
	Create progress gauge widget with designer selector.
void	onGuiThemeChanged ()
void	onResize (WidgetEvent event)
	Size changed.
void	onSetFont ()
void	onSetTextColor ()
	Text color changed.
void	rangeChanged (RangeModel rangeModel)
	Range model minimum, maximum or page size changed.
void	setBlendCanvasCreator (CanvasCreator creator)
	Set blend canvas creator or null to show no gauge.
void	setBlendWidth (float width)
	Set width of blending in the range from 0 to 1.
void	setGaugeCanvasCreator (CanvasCreator creator)
	Set gauge canvas creator or null to show no gauge.
void	setModel (RangeModel model)
	Set model.
void	setShowPercentage (bool show)
	Set if percentage label is shown.
void	valueChanged (RangeModel rangeModel)
	Range model value changed.
Public Member Functions inherited from Dragengine.Gui.Widget
void	addDragListener (DragListener listener)
void	addFocusListener (FocusListener listener)
	Add focus listener.
void	addGamepadListener (GamepadListener listener)
	Add gamepad listener.
void	addKeyListener (KeyListener listener)
void	addMouseListener (MouseListener listener)
void	addStateChangeListener (StateChangeListener listener)
	Add state change listener.
void	addWidgetListener (WidgetListener listener)
	Add widget listener.
bool	canGrabFullFocus ()
void	captureDirectional ()
	Captures directional navigation if not already captured by another widget.
void	collectClosestFocusWidget (ClosestDirectionFocusFinder finder, Point origin)
	Find closest focus widget for directional navigation.
void	design ()
	Design widget using WidgetDesigner.
void	desktopWarpMouseFocusHere ()
	Warp mouse to focus location on this widget.
void	desktopWarpMouseFocusLocation ()
	Warp mouse to focus location on desktop focus widget.
void	ensureVisible ()
	Ensure widget is fully visible on desktop if possible.
void	ensureVisible (RectArea boundary)
	Ensure boundary is visible on desktop if possible.
Widget	findFocusableWidget ()
Widget	findLastFocusableWidget ()
void	focusDirectional (int direction)
	Focus widget in direction that can grab the focus.
CanvasCreator	getBackgroundCanvasCreator ()
	Background canvas creator or null to use background color.
bool	getBlockLayoutParent ()
	Block layoutParent calls.
Border	getBorder ()
BorderSize	getBorderSize ()
RectArea	getBoundary ()
	Rectangular boundary of the widget.
RectArea	getBoundaryWithBorder ()
	Rectangular boundary of the widget including border.
bool	getCanFocus ()
bool	getCanFocusDirectional ()
	Widget can get focus using directional navigation.
CanvasView	getCanvasBackground ()
CanvasView	getCanvasContent ()
CanvasView	getCanvasWidget ()
Clipboard	getClipboard ()
	Clipboard or null to use parent clipboard.
ColorMatrix	getColorTransformation ()
	Color transformation.
WidgetDesigner	getDesigner ()
	Designer.
String	getDesignerSelector ()
	Designer selector.
Desktop	getDesktop ()
RectArea	getDesktopBoundary ()
	Rectangular boundary of widget relative to desktop.
RectArea	getDesktopBoundaryWithBorder ()
	Rectangular boundary of widget including border relative to parent.
Point	getDesktopPosition ()
	Widget position in desktop coordinates.
Widget	getDirectionalCaptureWidget ()
	Widget having captured directional navigation.
bool	getEnabled ()
MousePointerFactory	getFirstMousePointer ()
	First assigned mouse pointer.
Point	getFocusMouseLocation ()
	Focus mouse location in widget coordinates.
Font	getFont ()
bool	getHasBlockedLayoutParent ()
	layoutParent calls happened during runWhileBlockingLayoutParent.
bool	getHasFocus ()
int	getHeight ()
	Height of widget.
RangeModel	getHorizontalRangeModel ()
	Horizontal range model for viewports to synchronize the horizontal scrollbar.
Widget	getHoverWidget ()
	Widget the mouse hovers above or null.
Point	getLocalMouseLocation ()
	Parent desktop mouse location in widget coordinates.
Point	getMinimumSizeForHeight (int height)
	Minimum size of widget using reference widget height and variable width.
Point	getMinimumSizeForWidth (int width)
	Minimum size of widget using reference widget width and variable height.
Point	getMinimumSizeWithBorder ()
Point	getMinimumSizeWithBorderForHeight (int height)
	Minimum size of widget with border using reference height.
Point	getMinimumSizeWithBorderForWidth (int width)
	Minimum size of widget with border for reference width.
Widget	getMouseCaptureWidget ()
	Widget having captured the mouse.
MousePointerFactory	getMousePointer ()
	Mouse pointer to use.
BorderSize	getPadding ()
	Padding.
Container	getParent ()
Point	getPosition ()
	Position of the widget.
bool	getProtectBackgroundCanvasCreator ()
	Protect custom set background canvas creator.
bool	getProtectBorder ()
	Protect custom set border.
bool	getProtectFont ()
	Protect custom set font.
bool	getProtectMinimumSize ()
	Protect custom set minimumsize.
bool	getProtectMousePointer ()
	Protect custom set mouse pointer.
bool	getProtectPadding ()
	Protect custom set padding.
bool	getProtectTextColor ()
	Protect custom set text color.
RectArea	getRelativeBoundary (Container parent)
	Rectangular boundary of widget relative to parent.
RectArea	getRelativeBoundaryWithBorder (Container parent)
	Rectangular boundary of widget including border relative to parent.
Point	getRelativePosition (Container parent)
	Widget position in parent widget coordinates.
Point	getScreenPosition ()
	Widget position in screen coordinates.
RectArea	getScreenRectArea ()
Point	getSetMinimumSize ()
Point	getSize ()
	Size of the widget.
Color	getTextColor ()
	Text color.
String	getTitle ()
	Widget title.
Object	getToolTip ()
	Tooltip or null.
float	getTotalTransparency ()
TexMatrix2	getTransformation ()
float	getTransparency ()
RangeModel	getVerticalRangeModel ()
	Vertical range model for viewports to synchronize the vertical scrollbar.
bool	getVisible ()
RectArea	getVisibleDesktopBoundary ()
	Visible widget boundary in desktop coordinates.
RectArea	getVisibleRelativeBoundary (Container parent)
	Visible widget boundary relative to parent coordinate system.
Widget	getWidgetAt (Point position)
	Widget at coordinates or null if not found.
int	getWidth ()
	Width of widget.
Window	getWindow ()
Point	getWindowPosition ()
	Widget position in window coordinates.
int	getX ()
	X position of widget.
int	getY ()
	Y position of widget.
void	grabFocus ()
bool	hasParent (Container container)
bool	isCapturingDirectional ()
	Widget is capturing directional navigation.
bool	isCapturingMouse ()
	Widget is capturing mouse.
bool	isDesignerSet ()
	Custom designer is set.
bool	isFullEnabled ()
	Widget and all parent widgets are enabled.
bool	isMinimumSizeSet ()
bool	isMouseInside ()
	Mouse is hovering over this widget.
bool	isPointInside (Point position)
bool	isTransformationSet ()
void	layoutParent ()
void	layoutParentIfBlocked ()
	Calls layoutParent if getHasBlockedLayoutParent() is true.
Widget	new (int x, int y, int width, int height)
	Create widget with initial location and size.
Widget	new (Point position, Point size)
	Create widget with initial location and size.
Widget	nextFocusWidget ()
	Find next widget in the focus cycle that can grab the focus.
void	notifyBorderParametersChanged ()
void	onDesignerChanged ()
	Designer changed.
void	onDesignerSelectorChanged ()
	Designer selector changed.
void	onDispose (WidgetEvent event)
	Window is disposing.
void	onFocusLost (FocusEvent event)
	Widget lost focus.
void	onFocusReceived (FocusEvent event)
	Widget received focus.
void	onFrameUpdate (float elapsed)
	Do frame update.
void	onGamepadButtonPressed (GamepadEvent event)
	Gamepad button has been pressed.
void	onGamepadButtonReleased (GamepadEvent event)
	Gamepad button has been released.
void	onHidden (WidgetEvent event)
	Widget has been hidden.
void	onPaddingChanged ()
	Padding changed.
void	onParentStateChanged ()
	Parent state changed.
void	onParentStateChanged (bool force)
	Parent state changed.
void	onReposition (WidgetEvent event)
	Position changed.
void	onShown (WidgetEvent event)
	Widget has been shown.
void	onStateChanged (StateChangeEvent event)
	State changed.
void	onTranslationChanged ()
	Translation manager or active language pack changed.
void	popdownVirtualKeyboard ()
	Popdown virtual keyboard if Desktop has one assigned.
void	popdownVirtualKeyboardDirectional ()
	Popdown virtual keyboard if Desktop has one assigned and direction focus widget.
void	popupVirtualKeyboard ()
	Popup virtual keyboard if Desktop has one assigned.
Widget	prevFocusWidget ()
	Find previous widget in the focus cycle that can grab the focus.
void	processEvent (Event event)
	Process an event.
void	releaseDirectional ()
	Release directional navigation capture.
void	releaseMouse ()
void	removeDragListener (DragListener listener)
void	removeFocusListener (FocusListener listener)
	Remove focus listener.
void	removeGamepadListener (GamepadListener listener)
	Remove gamepad listener.
void	removeKeyListener (KeyListener listener)
void	removeMouseListener (MouseListener listener)
void	removeStateChangeListener (StateChangeListener listener)
	Remove state change listener.
void	removeWidgetListener (WidgetListener listener)
	Remove widget listener.
void	requestGrabFocus (Widget widget)
void	runWhileBlockingLayoutParent (Block ablock)
	Run block while layouting is blocked.
void	safeDispose ()
	Safely dispose of widget.
void	sendEvent (Event event)
void	sendEventToListeners (Event event, bool sendToParent)
	Send event to all appropriate listeners for events of its kind.
void	setBackgroundCanvasCreator (CanvasCreator creator)
	Set background canvas creator or null to use background color.
void	setBlockLayoutParent (bool blockLayoutParent)
	Set block layoutParent calls.
void	setBorder (Border border)
void	setCanFocus (bool canFocus)
void	setCanFocusDirectional (bool canFocus)
	Set if widget can get focus using directional navigation.
void	setClipboard (Clipboard clipboard)
	Set clipboard or null to use parent clipboard.
void	setColorTransformation (ColorMatrix transformation)
	Set color transformation.
void	setDesigner (WidgetDesigner designer)
	Set designer.
void	setDesignerSelector (String selector)
	Set designer selector.
void	setEnabled (bool enabled)
void	setFont (Font font)
void	setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
	Set if layoutParent calls happened during runWhileBlockingLayoutParent.
void	setHasFocus (bool hasFocus)
void	setHeight (int height)
	Set height of widget.
void	setMinimumSize (Point size)
void	setMousePointer (MousePointerFactory mousePointer)
	Set mouse pointer to use.
void	setPadding (BorderSize padding)
	Set padding.
void	setParent (Container parent)
void	setPosition (Point position)
	Set position of widget.
void	setProtectBackgroundCanvasCreator (bool protect)
	Set protect custom set background canvas creator.
void	setProtectBorder (bool protect)
	Set protect custom set border.
void	setProtectFont (bool protect)
	Set protect custom set font.
void	setProtectMinimumSize (bool protect)
	Set protect custom set minimumsize.
void	setProtectMousePointer (bool protect)
	Set protect custom set mouse pointer.
void	setProtectPadding (bool protect)
	Set protect custom set padding.
void	setProtectTextColor (bool protect)
	Set protect custom set text color.
void	setSize (Point size)
	Set size of widget.
void	setTextColor (Color color)
	Set text color.
void	setTitle (String title)
	Set widget title.
void	setToolTip (Object toolTip)
	Set tooltip or null.
void	setTransformation (TexMatrix2 transformation)
void	setTransparency (float transparency)
void	setVisible (bool visible)
void	setWidth (int width)
	Set width of widget.
void	setX (int x)
	Set X position of widget.
void	setY (int y)
	Set Y Position of widget.
void	simulateKeyPress (int keyCode, int keyChar)
	Simulate keyboard press event.
void	simulateKeyPressRelease (int keyCode, int keyChar)
	Simulate keyboard press and release event.
void	simulateKeyRelease (int keyCode, int keyChar)
	Simulate keyboard release event.
void	startFrameUpdater ()
	Start frame updater if not running.
void	stopFrameUpdater ()
	Stop frame updater if running.

Public Attributes
float	pBlendWidth
CanvasView	pCanvasBlend
Canvas	pCanvasGauge
CanvasText	pCanvasText
CanvasCreator	pGaugeCanvasCreator
RangeModel	pModel
bool	pShowPercentage
Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator	pBackgroundCanvasCreator
bool	pBlockLayoutParent
Border	pBorder
CanvasView	pCanvasWidget
Clipboard	pClipboard
WidgetDesigner	pDesigner
String	pDesignerSelector
Font	pFont
FrameUpdater	pFrameUpdater
bool	pIsDesignerSet
Array	pKeyListeners
MousePointerFactory	pMousePointer
BorderSize	pPadding
Container	pParent
Point	pPosition
bool	pProtectBackgroundCanvasCreator
RepeatKeyEventTimer	pRepeatEventTimer
Color	pTextColor
GuiTheme	pTheme
String	pThemeSelector
String	pTitle
Object	pToolTip
TexMatrix2	pTransformation
TranslationManager	pTranslationManager
float	pTransparency
bool	pVisible

Protected Member Functions
ColorMatrix	createBlendColorMatrix ()
	Create blend color matrix.
void	updateLabelCanvasParams ()
	Update label canvas font, color and visibility.
void	updateProgress ()
	Update progress.
Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner	getDesignerFromTheme ()
	Get designer from gui theme.
void	updateCanvasBackground ()
	Update background canvas content.
void	updateCanvasGeometry ()
	Update canvas position and size.

Detailed Description

Show progress of value inside range.

Version

1.24

Similar in behavior to ProgressBar but using a generic approach to represent complex gauge widgets. The empty gauge is represented using the regular widget background canvas designer. The filled gauge is represented using second canvas designer. The gradual filling in is done using a third canvas designer which is used as blending mask. This canvas designer has to produce a grayscale image which is then color processed to turn color values below the progress threshold to visible and color values above to be invisible. The width of the threshold can be configured to get a sharper or smoother blend.

Supports designing using designer selector "ProgressGauge".

Member Function Documentation

createBlendColorMatrix()

ColorMatrix Dragengine.Gui.ProgressGauge.createBlendColorMatrix ( )

protected

Create blend color matrix.

dispose()

void Dragengine.Gui.ProgressGauge.dispose

(

)

Disposes of the widget cleaning references.

Warning

This does not remove the widget from the parent container if present. Calling this method while a widget is still inside a parent container will cause exceptions. Use #safeDispose() to safely dispose of a widget.

Reimplemented from Dragengine.Gui.Widget.

getBlendCanvasCreator()

CanvasCreator Dragengine.Gui.ProgressGauge.getBlendCanvasCreator

(

)

Blend canvas creator or null to show no gauge.

getBlendWidth()

float Dragengine.Gui.ProgressGauge.getBlendWidth

(

)

Width of blending in the range from 0 to 1.

getGaugeCanvasCreator()

CanvasCreator Dragengine.Gui.ProgressGauge.getGaugeCanvasCreator

(

)

gauge canvas creator or null to show no gauge.

getMinimumSize()

Point Dragengine.Gui.ProgressGauge.getMinimumSize

(

)

Retrieve the minimal size of widget.

Reimplemented from Dragengine.Gui.Widget.

getModel()

RangeModel Dragengine.Gui.ProgressGauge.getModel

(

)

Model.

getPercentage()

float Dragengine.Gui.ProgressGauge.getPercentage

(

)

Progress percentage in the range from 0 to 1.

getShowPercentage()

bool Dragengine.Gui.ProgressGauge.getShowPercentage

(

)

Show percentage label.

new() [1/4]

ProgressGauge Dragengine.Gui.ProgressGauge.new

(

)

Create progress gauge widget.

Reimplemented from Dragengine.Gui.Widget.

new() [2/4]

ProgressGauge Dragengine.Gui.ProgressGauge.new

(

RangeModel

model

)

Create progress gauge widget with model.

new() [3/4]

ProgressGauge Dragengine.Gui.ProgressGauge.new	(	RangeModel	model,
		String	designerSelector
	)

Create progress gauge widget with model and designer selector.

new() [4/4]

ProgressGauge Dragengine.Gui.ProgressGauge.new

(

String

designerSelector

)

Create progress gauge widget with designer selector.

onGuiThemeChanged()

void Dragengine.Gui.ProgressGauge.onGuiThemeChanged

(

)

Notification that the gui theme changed. Attention! You have to super-call this method since it is used a bit differently than the other callback methods.

Reimplemented from Dragengine.Gui.Widget.

onResize()

void Dragengine.Gui.ProgressGauge.onResize

(

WidgetEvent

event

)

Size changed.

Sends event to listeners.

Reimplemented from Dragengine.Gui.Widget.

onSetFont()

void Dragengine.Gui.ProgressGauge.onSetFont

(

)

Notification that the widget font changed.

Reimplemented from Dragengine.Gui.Widget.

onSetTextColor()

void Dragengine.Gui.ProgressGauge.onSetTextColor

(

)

Text color changed.

Reimplemented from Dragengine.Gui.Widget.

rangeChanged()

void Dragengine.Gui.ProgressGauge.rangeChanged

(

RangeModel

rangeModel

)

Range model minimum, maximum or page size changed.

Implements Dragengine.Gui.RangeModelListener.

setBlendCanvasCreator()

void Dragengine.Gui.ProgressGauge.setBlendCanvasCreator

(

CanvasCreator

creator

)

Set blend canvas creator or null to show no gauge.

setBlendWidth()

void Dragengine.Gui.ProgressGauge.setBlendWidth

(

float

width

)

Set width of blending in the range from 0 to 1.

setGaugeCanvasCreator()

void Dragengine.Gui.ProgressGauge.setGaugeCanvasCreator

(

CanvasCreator

creator

)

Set gauge canvas creator or null to show no gauge.

setModel()

void Dragengine.Gui.ProgressGauge.setModel

(

RangeModel

model

)

Set model.

setShowPercentage()

void Dragengine.Gui.ProgressGauge.setShowPercentage

(

bool

show

)

Set if percentage label is shown.

updateLabelCanvasParams()

void Dragengine.Gui.ProgressGauge.updateLabelCanvasParams ( )

protected

Update label canvas font, color and visibility.

updateProgress()

void Dragengine.Gui.ProgressGauge.updateProgress ( )

protected

Update progress.

valueChanged()

void Dragengine.Gui.ProgressGauge.valueChanged

(

RangeModel

rangeModel

)

Range model value changed.

Implements Dragengine.Gui.RangeModelListener.

Member Data Documentation

pBlendWidth

float Dragengine.Gui.ProgressGauge.pBlendWidth

pCanvasBlend

CanvasView Dragengine.Gui.ProgressGauge.pCanvasBlend

pCanvasGauge

Canvas Dragengine.Gui.ProgressGauge.pCanvasGauge

pCanvasText

CanvasText Dragengine.Gui.ProgressGauge.pCanvasText

pGaugeCanvasCreator

CanvasCreator Dragengine.Gui.ProgressGauge.pGaugeCanvasCreator

pModel

RangeModel Dragengine.Gui.ProgressGauge.pModel

pShowPercentage

bool Dragengine.Gui.ProgressGauge.pShowPercentage

---

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

• ProgressGauge.ds