Gondwana.Widgets.Controls.ProgressBarWidget Class Reference

Displays a normalized progress value as a horizontal or vertical filled bar. More...

Inheritance diagram for Gondwana.Widgets.Controls.ProgressBarWidget:

Public Member Functions
	ProgressBarWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, float value=0f, WidgetOrientation orientation=WidgetOrientation.Horizontal, string? nickname=null)
	Creates a view-level progress bar.
	ProgressBarWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, float value=0f, WidgetOrientation orientation=WidgetOrientation.Horizontal, string? nickname=null)
	Creates a scene-layer progress bar.
ProgressBarWidget	SetValue (float value)
	Sets the progress value and returns this widget for fluent setup.
ProgressBarWidget	SetFillColor (Color color)
	Sets the fill color.
ProgressBarWidget	SetTrackColor (Color color)
	Sets the track color.
ProgressBarWidget	SetProgressZOrder (int zOrder)
	Places the track at the requested Z-order and the fill directly above it.
Public Member Functions inherited from Gondwana.Widgets.WidgetBase
virtual bool	HitTest (View view, Point screenPositionPx)
	Determines whether the widget can be hit at the specified screen position within the specified view.
virtual bool	HitTest (Point screenPositionPx)
	Determines whether the widget can be hit at the specified screen position.
WidgetBase	Show ()
	Shows the widget and registers it for input routing.
WidgetBase	Hide ()
	Hides the widget and releases any routed input state.
WidgetBase	Activate ()
	Activates the widget and brings it to the front of the input order.
WidgetBase	Cancel ()
	Cancels the widget.
Public Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite
	DirectComposite (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)
	Initializes a new instance of the DirectComposite class.
Vector2	GetPosition ()
	Gets the current composite anchor.
void	SetPosition (Vector2 position)
	Sets the composite anchor and repositions all children from their stored offsets.
DirectComposite	SetPosition (float x, float y)
	Sets the composite anchor and repositions all children from their stored offsets.
virtual DirectComposite	Add (IDirectCompositeChild child, bool keepCurrentOffset=true, Vector2? explicitLocalOffsetPx=null)
	Adds a composite-compatible direct drawable as a child.
virtual DirectComposite	Remove (IDirectCompositeChild child)
	Removes a child without disposing it.
virtual DirectComposite	Clear ()
	Removes every child without disposing them.
DirectComposite	SetLocalOffset (IDirectCompositeChild child, Vector2 newLocalOffsetPx)
	Changes one child's local offset and reapplies its position.
DirectComposite	SetZOrder (int zOrder)
	Applies one Z-order to every descendant.
DirectComposite	SetOpacity (float opacity)
	Applies one opacity to every descendant.
DirectComposite	SetIsVisible (bool visible)
	Applies one visibility value to every descendant.
DirectComposite	FadeTo (float targetOpacity, float durationSec)
	Fades every descendant to the requested opacity.
DirectComposite	FadeIn (float durationSec)
	Fades every descendant to full opacity.
DirectComposite	FadeOut (float durationSec)
	Fades every descendant to zero opacity.
RectangleF	GetDrawLocationScreen (View view)
	Gets the union of all visible descendants as projected through a view.
void	Draw (BackbufferBase backbuffer, RectangleF destRectScreen)
	Performs no direct rendering because descendants render independently.
virtual void	Update (long tick)
	Advances composite movement.
virtual void	Dispose ()
	Disposes the composite and every child it owns.

Protected Member Functions
override void	ProcessShown ()
	Performs processing when the widget is shown before notification callbacks are invoked.
Protected Member Functions inherited from Gondwana.Widgets.WidgetBase
	WidgetBase (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)
	Initializes a new instance of the WidgetBase class.
virtual void	ProcessHidden ()
	Performs processing when the widget is hidden before notification callbacks are invoked.
virtual void	ProcessActivated ()
	Performs processing when the widget is activated before notification callbacks are invoked.
virtual void	ProcessCancelled ()
	Performs processing when the widget is cancelled before notification callbacks are invoked.
virtual void	ProcessPointerEnter (WidgetPointerEventArgs args)
	Performs processing when a pointer enters the widget before notification callbacks are invoked.
virtual void	ProcessPointerLeave (WidgetPointerEventArgs args)
	Performs processing when a pointer leaves the widget before notification callbacks are invoked.
virtual void	ProcessPointerDown (WidgetPointerEventArgs args)
	Performs processing when a pointer press begins on the widget before notification callbacks are invoked.
virtual void	ProcessPointerMove (WidgetPointerEventArgs args)
	Performs processing when pointer movement is routed to the widget before notification callbacks are invoked.
virtual void	ProcessPointerUp (WidgetPointerEventArgs args)
	Performs processing when a pointer press is released for the widget before notification callbacks are invoked.
virtual void	ProcessFocusGained ()
	Performs processing when the widget gains focus before notification callbacks are invoked.
virtual void	ProcessFocusLost ()
	Performs processing when the widget loses focus before notification callbacks are invoked.
virtual void	ProcessKeyboardInput (WidgetKeyboardEventArgs args)
	Performs processing when keyboard input is routed to the widget before notification callbacks are invoked.
virtual bool	ShouldDispatchPointerClick (WidgetPointerEventArgs args)
	Determines whether a pointer-click event should be dispatched for the specified pointer event data.
virtual void	OnShown ()
	Called when the widget is shown.
virtual void	OnHidden ()
	Called when the widget is hidden.
virtual void	OnActivated ()
	Called when the widget is activated.
virtual void	OnCancelled ()
	Called when the widget is cancelled.
virtual void	OnPointerEnter (WidgetPointerEventArgs args)
	Called when a pointer enters the widget bounds.
virtual void	OnPointerLeave (WidgetPointerEventArgs args)
	Called when a pointer leaves the widget bounds.
virtual void	OnPointerDown (WidgetPointerEventArgs args)
	Called when a pointer press begins on the widget.
virtual void	OnPointerMove (WidgetPointerEventArgs args)
	Called when pointer movement is routed to the widget.
virtual void	OnPointerUp (WidgetPointerEventArgs args)
	Called when a pointer press is released for the widget.
virtual void	OnMouseWheel (WidgetMouseWheelEventArgs args)
	Called when mouse-wheel input is routed to the widget.
virtual void	OnPointerClick (WidgetPointerEventArgs args)
	Called when a pointer click is dispatched to the widget.
virtual void	OnFocusGained ()
	Called when the widget gains focus.
virtual void	OnFocusLost ()
	Called when the widget loses focus.
virtual void	OnKeyboardInput (WidgetKeyboardEventArgs args)
	Called when keyboard input is routed to the widget.
Protected Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite
virtual void	OnChildAdded (IDirectCompositeChild child)
	Called after a child has been successfully added.
virtual void	OnChildRemoved (IDirectCompositeChild child)
	Called after a child has been removed from the composite.

Properties
DirectRectangle	Track [get]
	Gets the background/track drawing.
DirectRectangle	Fill [get]
	Gets the foreground/fill drawing.
float	Value [get, set]
	Gets or sets the normalized progress value in the range 0 through 1.
WidgetOrientation	Orientation [get, set]
	Gets or sets the fill orientation. Vertical bars fill from bottom to top.
int	Padding [get, set]
	Gets or sets the inner padding between the track and fill.
Size	Size [get, set]
	Gets or sets the outer progress-bar size.
Rectangle	TrackBounds [get]
	Gets the track bounds in the widget's native coordinate space.
Rectangle	FillBounds [get]
	Gets the fill bounds in the widget's native coordinate space.
Properties inherited from Gondwana.Widgets.WidgetBase
bool	IsInputEnabled [get, set]
	Gets or sets a value indicating whether the widget can participate in input routing.
bool	IsPointerInputEnabled [get, set]
	Gets or sets a value indicating whether the widget can receive pointer input.
bool	IsKeyboardInputEnabled [get, set]
	Gets or sets a value indicating whether the widget can receive keyboard input.
bool	CanReceiveFocus [get, set]
	Gets or sets a value indicating whether the widget can receive keyboard focus.
bool	IsFocused [get, set]
	Gets a value indicating whether the widget currently has keyboard focus.
Properties inherited from Gondwana.Drawing.Direct.DirectComposite
Guid	Id = Guid.NewGuid() [get]
	Gets the unique identifier of the composite.
string?	Nickname [get]
	Gets the optional diagnostic nickname of the composite.
RenderSurfaceHostBase	RenderSurfaceHost [get]
	Gets the render surface host shared by the composite and its children.
DirectDrawingMode	Mode [get]
	Gets the coordinate mode shared by the composite and its children.
SceneLayer?	SceneLayer [get]
	Gets the scene layer shared by all children in scene-layer mode.
View?	View [get]
	Gets the view shared by all children in view mode.
ReadOnlyCollection< IDirectCompositeChild >	Children [get]
	Gets the children owned by the composite.
MovementController	Movement [get]
	Gets the movement controller used to move the composite anchor.
MovementSpace	PositionSpace [get]
	Gets the coordinate space used by the movement controller.
bool	Visible [get, set]
	Gets or sets the visibility of all descendants.
int	ZOrder [get]
	Gets the composite Z-order.
Rectangle	ScreenBounds [get]
	Gets the union of all visible descendants' screen-space bounds.
Rectangle	WorldBounds [get]
	Gets the union of all visible descendants' world-space bounds.

Additional Inherited Members
Events inherited from Gondwana.Widgets.WidgetBase
Action?	Shown
	Occurs when the widget is shown.
Action?	Hidden
	Occurs when the widget is hidden.
Action?	Activated
	Occurs when the widget is activated.
Action?	Cancelled
	Occurs when the widget is cancelled.
Action< WidgetPointerEventArgs >?	PointerEnter
	Occurs when a pointer enters the widget bounds.
Action< WidgetPointerEventArgs >?	PointerLeave
	Occurs when a pointer leaves the widget bounds.
Action< WidgetPointerEventArgs >?	PointerDown
	Occurs when a pointer button or touch press begins on the widget.
Action< WidgetPointerEventArgs >?	PointerMove
	Occurs when a pointer moves while routed to the widget.
Action< WidgetPointerEventArgs >?	PointerUp
	Occurs when a pointer button or touch press is released for the widget.
Action< WidgetPointerEventArgs >?	PointerClick
	Occurs when a pointer press and release completes as a click on the widget.
Action< WidgetMouseWheelEventArgs >?	MouseWheel
	Occurs when mouse-wheel input is routed to the widget while the pointer is over it.
Action?	FocusGained
	Occurs when the widget gains keyboard focus.
Action?	FocusLost
	Occurs when the widget loses keyboard focus.
Action< WidgetKeyboardEventArgs >?	KeyboardInput
	Occurs when keyboard input is routed to the widget.
Events inherited from Gondwana.Drawing.Direct.DirectComposite
EventHandler< IDirectDrawable >?	Disposing
	Occurs when the composite is being disposed.
Events inherited from Gondwana.Drawing.Direct.IDirectDrawable
EventHandler< IDirectDrawable >?	Disposing
	Occurs when the object is being disposed.

Detailed Description

Displays a normalized progress value as a horizontal or vertical filled bar.

Definition at line 14 of file ProgressBarWidget.cs.

Constructor & Destructor Documentation

ProgressBarWidget() [1/2]

Gondwana.Widgets.Controls.ProgressBarWidget.ProgressBarWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		View	view,
		Rectangle	bounds,
		float	value = 0f,
		WidgetOrientation	orientation = WidgetOrientation::Horizontal,
		string?	nickname = null )

Creates a view-level progress bar.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
view	The view used for presentation and coordinate conversion.
bounds	The widget bounds in view-local pixels.
value	The value.
orientation	The orientation.
nickname	An optional name used to identify the object.

Definition at line 30 of file ProgressBarWidget.cs.

ProgressBarWidget() [2/2]

Gondwana.Widgets.Controls.ProgressBarWidget.ProgressBarWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		SceneLayer	sceneLayer,
		Rectangle	bounds,
		float	value = 0f,
		WidgetOrientation	orientation = WidgetOrientation::Horizontal,
		string?	nickname = null )

Creates a scene-layer progress bar.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
sceneLayer	The scene layer that owns the content.
bounds	The widget bounds in world pixels.
value	The value.
orientation	The orientation.
nickname	An optional name used to identify the object.

Definition at line 57 of file ProgressBarWidget.cs.

Member Function Documentation

ProcessShown()

override void Gondwana.Widgets.Controls.ProgressBarWidget.ProcessShown ( )

protectedvirtual

Performs processing when the widget is shown before notification callbacks are invoked.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 219 of file ProgressBarWidget.cs.

SetFillColor()

ProgressBarWidget Gondwana.Widgets.Controls.ProgressBarWidget.SetFillColor

(

Color

color

)

Sets the fill color.

Parameters

color

The color to apply.

Returns

This instance for fluent chaining.

Definition at line 187 of file ProgressBarWidget.cs.

SetProgressZOrder()

ProgressBarWidget Gondwana.Widgets.Controls.ProgressBarWidget.SetProgressZOrder

(

int

zOrder

)

Places the track at the requested Z-order and the fill directly above it.

Parameters

zOrder

The drawing order relative to other content.

Returns

This instance for fluent chaining.

Definition at line 211 of file ProgressBarWidget.cs.

SetTrackColor()

ProgressBarWidget Gondwana.Widgets.Controls.ProgressBarWidget.SetTrackColor

(

Color

color

)

Sets the track color.

Parameters

color

The color to apply.

Returns

This instance for fluent chaining.

Definition at line 199 of file ProgressBarWidget.cs.

SetValue()

ProgressBarWidget Gondwana.Widgets.Controls.ProgressBarWidget.SetValue

(

float

value

)

Sets the progress value and returns this widget for fluent setup.

Parameters

value

The value.

Returns

This instance for fluent chaining.

Definition at line 176 of file ProgressBarWidget.cs.

Property Documentation

Fill

DirectRectangle Gondwana.Widgets.Controls.ProgressBarWidget.Fill

get

Gets the foreground/fill drawing.

Definition at line 83 of file ProgressBarWidget.cs.

FillBounds

Rectangle Gondwana.Widgets.Controls.ProgressBarWidget.FillBounds

get

Gets the fill bounds in the widget's native coordinate space.

Definition at line 167 of file ProgressBarWidget.cs.

Orientation

WidgetOrientation Gondwana.Widgets.Controls.ProgressBarWidget.Orientation

getset

Gets or sets the fill orientation. Vertical bars fill from bottom to top.

Definition at line 108 of file ProgressBarWidget.cs.

Padding

int Gondwana.Widgets.Controls.ProgressBarWidget.Padding

getsetadd

Gets or sets the inner padding between the track and fill.

Definition at line 124 of file ProgressBarWidget.cs.

Size

Size Gondwana.Widgets.Controls.ProgressBarWidget.Size

getset

Gets or sets the outer progress-bar size.

Definition at line 140 of file ProgressBarWidget.cs.

Track

DirectRectangle Gondwana.Widgets.Controls.ProgressBarWidget.Track

get

Gets the background/track drawing.

Definition at line 78 of file ProgressBarWidget.cs.

TrackBounds

Rectangle Gondwana.Widgets.Controls.ProgressBarWidget.TrackBounds

get

Gets the track bounds in the widget's native coordinate space.

Definition at line 160 of file ProgressBarWidget.cs.

Value

float Gondwana.Widgets.Controls.ProgressBarWidget.Value

getset

Gets or sets the normalized progress value in the range 0 through 1.

Definition at line 88 of file ProgressBarWidget.cs.