Base widget class for interaction prompt UI. It receives projection bundles, surface entries, control entries, focus/proximity changes, progress, outcomes, route state, paging, input family, and widget payload updates.
UCLASS(Abstract, BlueprintType, Blueprintable)
class INTERACTIONFRAMEWORKUI_API UInteractionUIWidgetBase : public UUserWidgetMembers
OnWidgetReleaseRequested
Broadcast when the widget requests release back to the UI manager pool.
ClearProjectionSettingsOverride
Clears any widget-instance projection settings override.
ClearViewModel
Clears the current projection/view model and notifies Blueprint via OnViewModelCleared.
GetCurrentCanonicalHandleProjection
Returns canonical handle data for the current projection.
GetCurrentCanonicalRouteProjection
Returns canonical route data for the current projection.
GetCurrentProjectionBundle
Returns the full projection bundle currently displayed by this widget.
GetCurrentProjectionHandle
Returns the point handle represented by the current projection.
GetProjectionAlignmentVector
Returns alignment as a normalized vector used during projection placement.
GetScreenSpaceAnchorOffsetNormalized
Returns the normalized screen-space anchor offset override.
HasProjectedScreenPosition
Returns true when the widget has a cached projected screen position.
OnInputFamilyChanged
Blueprint event fired on a widget when that widget receives a different resolved input family.
OnInteractionProgressChanged
Blueprint event fired when active interaction progress changes.
OnPagingStateChanged
Fires when paging availability changes so widgets can show page controls or indicators.
OnProjectedScreenPositionUpdated
Blueprint event fired after the projected screen position updates.
OnProjectionBundleApplied
Blueprint event fired after a full projection bundle is applied.
OnProjectionsApplied
Blueprint event fired after focus, progress, surface, state, and outcome projections are applied.
OnStatePresentationChanged
Blueprint event fired when high-level widget state presentation changes.
SetAnchorWorldLocation
Sets the world location used by projection when the widget has a valid anchor.
SetProjectedScreenPosition
Sets the widget's projected screen position, optionally removing DPI scale first.
SetProjectionSettingsOverride
Overrides projection clamp settings for this widget instance.
SetScreenSpaceAnchorOverride
Enables or disables a normalized screen-space anchor offset override.
TryGetControlEntryPresentationByTag
Finds the first control entry with the supplied control tag.
TryGetEntryPresentationById
Finds a surface or control entry by id in the current projection.
TryGetFirstControlEntryPresentation
Returns the first control entry in the current projection.
TryGetPrimaryCommandEntryPresentation
Returns the first command entry in the current surface projection.
TryGetPrimaryCommandPromptPresentation
Returns the prompt presentation for the first command entry.
UpdateProjectionNow
Recomputes projection immediately instead of waiting for the next tick.
WasLastProjectionBehindCamera
Returns true when the last projection was behind the camera.
Use Cases
- Create project prompt widgets that react to projection bundles, entries, payloads, progress, outcomes, and route state.
- Request widget release back to the UI manager when the widget should be hidden or pooled.
Notes
- Widgets display projected runtime state; they should not become the authority owner of shared interaction state.