Displays a world-space health bar that follows a sprite. More...

Inheritance diagram for Gondwana.Widgets.Hud.HealthBarWidget:

Public Member Functions
	HealthBarWidget (RenderSurfaceHostBase renderSurfaceHost, Sprite target, float maximum, Size? size=null, Point? offsetPx=null, string? nickname=null)
	Initializes a health bar that follows target .
HealthBarWidget	SetValue (float value)
	Sets the current health and returns this widget for fluent setup.
HealthBarWidget	SetFillColor (Color color)
	Sets the fill color and returns this widget.
void	RefreshPosition ()
	Repositions the bar from the target's current render bounds.
override void	Dispose ()
	Disposes the composite and every child it owns.
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.

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
Sprite	Target `[get]`
	Gets the sprite followed by this health bar.
float	Maximum `[get, set]`
	Gets or sets the maximum health value.
float	Value `[get, set]`
	Gets or sets the current health value. Values are clamped to zero through Maximum.
float	Fraction `[get]`
	Gets the filled fraction in the range zero through one.
Size	Size `[get, set]`
	Gets or sets the outer bar size in world pixels.
Point	OffsetPx `[get, set]`
	Gets or sets an additional world-pixel offset from the centered position above the target.
Rectangle	TrackBoundsWorld `[get]`
	Gets the current world bounds of the health-bar track.
Rectangle	FillBoundsWorld `[get]`
	Gets the current world bounds of the filled portion.
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 world-space health bar that follows a sprite.

The widget tracks sprite movement automatically. Set Value when gameplay changes the target's health.

Definition at line 16 of file HealthBarWidget.cs.

Constructor & Destructor Documentation

◆ HealthBarWidget()

Gondwana.Widgets.Hud.HealthBarWidget.HealthBarWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		Sprite	target,
		float	maximum,
		Size?	size = null,
		Point?	offsetPx = null,
		string?	nickname = null )

Initializes a health bar that follows target .

Parameters

renderSurfaceHost	The render surface hosting the target scene.
target	The sprite followed by the bar.
maximum	The maximum health value. Must be greater than zero.
size	The outer bar size in world pixels.
offsetPx	An additional world-pixel offset from the centered position above the sprite.
nickname	An optional diagnostic nickname.

Definition at line 38 of file HealthBarWidget.cs.

Member Function Documentation

◆ Dispose()

override void Gondwana.Widgets.Hud.HealthBarWidget.Dispose ( )

virtual

Disposes the composite and every child it owns.

Reimplemented from Gondwana.Drawing.Direct.DirectComposite.

Definition at line 225 of file HealthBarWidget.cs.

◆ ProcessShown()

override void Gondwana.Widgets.Hud.HealthBarWidget.ProcessShown ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 237 of file HealthBarWidget.cs.

◆ RefreshPosition()

void Gondwana.Widgets.Hud.HealthBarWidget.RefreshPosition ( )

Repositions the bar from the target's current render bounds.

Definition at line 215 of file HealthBarWidget.cs.

◆ SetFillColor()

HealthBarWidget Gondwana.Widgets.Hud.HealthBarWidget.SetFillColor ( Color color )

Sets the fill color and returns this widget.

Parameters

color The color to apply.

Returns: This instance for fluent chaining.

Definition at line 206 of file HealthBarWidget.cs.

◆ SetValue()

HealthBarWidget Gondwana.Widgets.Hud.HealthBarWidget.SetValue ( float value )

Sets the current health and returns this widget for fluent setup.

Parameters

value The value.

Returns: This instance for fluent chaining.

Definition at line 195 of file HealthBarWidget.cs.

Property Documentation

◆ FillBoundsWorld

Rectangle Gondwana.Widgets.Hud.HealthBarWidget.FillBoundsWorld

get

Gets the current world bounds of the filled portion.

Definition at line 188 of file HealthBarWidget.cs.

◆ Fraction

float Gondwana.Widgets.Hud.HealthBarWidget.Fraction

get

Gets the filled fraction in the range zero through one.

Definition at line 145 of file HealthBarWidget.cs.

◆ Maximum

float Gondwana.Widgets.Hud.HealthBarWidget.Maximum

getset

Gets or sets the maximum health value.

Definition at line 110 of file HealthBarWidget.cs.

◆ OffsetPx

Point Gondwana.Widgets.Hud.HealthBarWidget.OffsetPx

getset

Gets or sets an additional world-pixel offset from the centered position above the target.

Definition at line 170 of file HealthBarWidget.cs.

◆ Size

Size Gondwana.Widgets.Hud.HealthBarWidget.Size

getset

Gets or sets the outer bar size in world pixels.

Definition at line 150 of file HealthBarWidget.cs.

◆ Target

Sprite Gondwana.Widgets.Hud.HealthBarWidget.Target

get

Gets the sprite followed by this health bar.

Definition at line 105 of file HealthBarWidget.cs.

◆ TrackBoundsWorld

Rectangle Gondwana.Widgets.Hud.HealthBarWidget.TrackBoundsWorld

get

Gets the current world bounds of the health-bar track.

Definition at line 183 of file HealthBarWidget.cs.

◆ Value

float Gondwana.Widgets.Hud.HealthBarWidget.Value

getset

Gets or sets the current health value. Values are clamped to zero through Maximum.

Definition at line 127 of file HealthBarWidget.cs.

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HealthBarWidget()

Member Function Documentation

◆ Dispose()

◆ ProcessShown()

◆ RefreshPosition()

◆ SetFillColor()

◆ SetValue()

Property Documentation

◆ FillBoundsWorld

◆ Fraction

◆ Maximum

◆ OffsetPx

◆ Size

◆ Target

◆ TrackBoundsWorld

◆ Value