Base type for leaf widgets that can be repositioned through pointer dragging. More...

Inheritance diagram for Gondwana.Widgets.DraggableWidgetBase:

Protected Member Functions

DraggableWidgetBase (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)

Initializes a new instance of the DraggableWidgetBase class.

override void ProcessHidden ()

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

override void ProcessCancelled ()

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

override void ProcessPointerDown (WidgetPointerEventArgs args)

Performs processing when a pointer press begins on the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

override void ProcessPointerMove (WidgetPointerEventArgs args)

Performs processing when pointer movement is routed to the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

override void ProcessPointerUp (WidgetPointerEventArgs args)

Performs processing when a pointer press is released for the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

override bool ShouldDispatchPointerClick (WidgetPointerEventArgs args)

Determines whether a pointer-click event should be dispatched for the specified pointer event data.

Parameters

args	The pointer event data.

Returns: true if the pointer-click event should be dispatched; otherwise, false.

virtual bool CanStartDrag (WidgetPointerEventArgs args)

Determines whether a pointer-down event may begin drag tracking.

virtual Vector2 ConvertScreenDeltaToPositionDelta (Vector2 totalScreenDeltaPx, View view)

Converts total screen movement into this widget's coordinate space.

virtual Vector2 ConstrainDragPosition (Vector2 proposedPositionPx)

Constrains a proposed anchor position before it is applied.

virtual void OnDragStarted (WidgetDragEventArgs args)

Called when dragging begins.

virtual void OnDragged (WidgetDragEventArgs args)

Called after the widget moves during dragging.

virtual void OnDragEnded (WidgetDragEventArgs args)

Called when dragging ends.

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 ProcessShown ()

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

virtual void ProcessActivated ()

Performs processing when the widget is activated 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 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 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
bool	IsDragEnabled `[get, set]`
	Gets or sets whether new drag operations may begin.
bool	IsDragging `[get]`
	Gets whether a drag operation is active.
float	DragThresholdPx `[get, set]`
	Gets or sets the minimum pointer movement required to begin dragging.
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.

Events
Action< WidgetDragEventArgs >?	DragStarted
	Raised when pointer movement first crosses DragThresholdPx.
Action< WidgetDragEventArgs >?	Dragged
	Raised after the widget is repositioned during an active drag.
Action< WidgetDragEventArgs >?	DragEnded
	Raised when an active drag ends.
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.

Additional Inherited Members
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.

Detailed Description

Base type for leaf widgets that can be repositioned through pointer dragging.

Definition at line 12 of file DraggableWidgetBase.cs.

Constructor & Destructor Documentation

◆ DraggableWidgetBase()

Gondwana.Widgets.DraggableWidgetBase.DraggableWidgetBase	(	RenderSurfaceHostBase	renderSurfaceHost,
		DirectDrawingMode	mode,
		PointF	anchor = default,
		string?	nickname = null )

protected

Initializes a new instance of the DraggableWidgetBase class.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
mode	The mode.
anchor	The anchor.
nickname	An optional name used to identify the object.

Definition at line 38 of file DraggableWidgetBase.cs.

Member Function Documentation

◆ CanStartDrag()

virtual bool Gondwana.Widgets.DraggableWidgetBase.CanStartDrag ( WidgetPointerEventArgs args )

protectedvirtual

Determines whether a pointer-down event may begin drag tracking.

Parameters

args	The event data.

Returns: true if the pointer event can begin a drag; otherwise, false.

Definition at line 128 of file DraggableWidgetBase.cs.

◆ ConstrainDragPosition()

virtual Vector2 Gondwana.Widgets.DraggableWidgetBase.ConstrainDragPosition ( Vector2 proposedPositionPx )

protectedvirtual

Constrains a proposed anchor position before it is applied.

Parameters

proposedPositionPx The proposed position px.

Returns: The proposed position after applying the drag constraints.

Definition at line 150 of file DraggableWidgetBase.cs.

◆ ConvertScreenDeltaToPositionDelta()

virtual Vector2 Gondwana.Widgets.DraggableWidgetBase.ConvertScreenDeltaToPositionDelta	(	Vector2	totalScreenDeltaPx,
		View	view )

protectedvirtual

Converts total screen movement into this widget's coordinate space.

Parameters

totalScreenDeltaPx	The total screen delta px.
view	The view used for presentation and coordinate conversion.

Returns: The drag displacement converted into the widget position coordinate space.

Definition at line 139 of file DraggableWidgetBase.cs.

◆ OnDragEnded()

virtual void Gondwana.Widgets.DraggableWidgetBase.OnDragEnded ( WidgetDragEventArgs args )

protectedvirtual

Called when dragging ends.

Parameters

args	The event data.

Definition at line 175 of file DraggableWidgetBase.cs.

◆ OnDragged()

virtual void Gondwana.Widgets.DraggableWidgetBase.OnDragged ( WidgetDragEventArgs args )

protectedvirtual

Called after the widget moves during dragging.

Parameters

args	The event data.

Definition at line 167 of file DraggableWidgetBase.cs.

◆ OnDragStarted()

virtual void Gondwana.Widgets.DraggableWidgetBase.OnDragStarted ( WidgetDragEventArgs args )

protectedvirtual

Called when dragging begins.

Parameters

args	The event data.

Definition at line 159 of file DraggableWidgetBase.cs.

◆ ProcessCancelled()

override void Gondwana.Widgets.DraggableWidgetBase.ProcessCancelled ( )

sealedprotectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 78 of file DraggableWidgetBase.cs.

◆ ProcessHidden()

override void Gondwana.Widgets.DraggableWidgetBase.ProcessHidden ( )

sealedprotectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 71 of file DraggableWidgetBase.cs.

◆ ProcessPointerDown()

override void Gondwana.Widgets.DraggableWidgetBase.ProcessPointerDown ( WidgetPointerEventArgs args )

sealedprotectedvirtual

Performs processing when a pointer press begins on the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 85 of file DraggableWidgetBase.cs.

◆ ProcessPointerMove()

override void Gondwana.Widgets.DraggableWidgetBase.ProcessPointerMove ( WidgetPointerEventArgs args )

sealedprotectedvirtual

Performs processing when pointer movement is routed to the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 92 of file DraggableWidgetBase.cs.

◆ ProcessPointerUp()

override void Gondwana.Widgets.DraggableWidgetBase.ProcessPointerUp ( WidgetPointerEventArgs args )

sealedprotectedvirtual

Performs processing when a pointer press is released for the widget before notification callbacks are invoked.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 105 of file DraggableWidgetBase.cs.

◆ ShouldDispatchPointerClick()

override bool Gondwana.Widgets.DraggableWidgetBase.ShouldDispatchPointerClick ( WidgetPointerEventArgs args )

sealedprotectedvirtual

Determines whether a pointer-click event should be dispatched for the specified pointer event data.

Parameters

args	The pointer event data.

Returns: true if the pointer-click event should be dispatched; otherwise, false.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 117 of file DraggableWidgetBase.cs.

Property Documentation

◆ DragThresholdPx

float Gondwana.Widgets.DraggableWidgetBase.DragThresholdPx

getset

Gets or sets the minimum pointer movement required to begin dragging.

Definition at line 64 of file DraggableWidgetBase.cs.

◆ IsDragEnabled

bool Gondwana.Widgets.DraggableWidgetBase.IsDragEnabled

getset

Gets or sets whether new drag operations may begin.

Definition at line 50 of file DraggableWidgetBase.cs.

◆ IsDragging

bool Gondwana.Widgets.DraggableWidgetBase.IsDragging

get

Gets whether a drag operation is active.

Definition at line 59 of file DraggableWidgetBase.cs.

Event Documentation

◆ DragEnded

Action<WidgetDragEventArgs>? Gondwana.Widgets.DraggableWidgetBase.DragEnded

Raised when an active drag ends.

Definition at line 29 of file DraggableWidgetBase.cs.

◆ Dragged

Action<WidgetDragEventArgs>? Gondwana.Widgets.DraggableWidgetBase.Dragged

Raised after the widget is repositioned during an active drag.

Definition at line 24 of file DraggableWidgetBase.cs.

◆ DragStarted

Action<WidgetDragEventArgs>? Gondwana.Widgets.DraggableWidgetBase.DragStarted

Raised when pointer movement first crosses DragThresholdPx.

Definition at line 19 of file DraggableWidgetBase.cs.

Protected Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DraggableWidgetBase()

Member Function Documentation

◆ CanStartDrag()

◆ ConstrainDragPosition()

◆ ConvertScreenDeltaToPositionDelta()

◆ OnDragEnded()

◆ OnDragged()

◆ OnDragStarted()

◆ ProcessCancelled()

◆ ProcessHidden()

◆ ProcessPointerDown()

◆ ProcessPointerMove()

◆ ProcessPointerUp()

◆ ShouldDispatchPointerClick()

Property Documentation

◆ DragThresholdPx

◆ IsDragEnabled

◆ IsDragging

Event Documentation

◆ DragEnded

◆ Dragged

◆ DragStarted