| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InteractiveGizmoManager.h |
Include |
#include "InteractiveGizmoManager.h" |
class UInteractiveGizmoManager :
public UObject,
public IToolContextTransactionProvider
UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances. For each Gizmo, a (string,GizmoBuilder) pair is registered with the GizmoManager. Gizmos can then be activated via the string identifier.
Name | Description | ||
---|---|---|---|
|
ActiveGizmos |
Set of Currently-active Gizmos |
|
|
bDefaultGizmosRegistered |
||
|
CustomThreeAxisBuilder |
||
|
GizmoBuilders |
Current set of named GizmoBuilders |
|
|
UInputRouter &#... |
InputRouter |
Current InputRouter (Context owns this) |
|
QueriesAPI |
Current Context-Queries implementation |
|
|
TransactionsAPI |
Current Transactions implementation |
Name | Description | |
---|---|---|
|
UInteractiveGizmoManager() |
Name | Description | ||
---|---|---|---|
|
UTransformGi... |
Create3AxisTransformGizmo |
Activate a new instance of the default 3-axis transformation Gizmo. |
|
UTransformGi... |
CreateCustomTransformGizmo ( |
Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included. |
|
UInteractive... |
CreateGizmo |
Try to activate a new Gizmo instance |
|
GizmoType &#... |
CreateGizmo |
Try to activate a new Gizmo instance |
|
DeregisterGizmoType ( |
Remove a GizmoBuilder from the set of known GizmoBuilders |
|
|
DestroyAllGizmosByOwner ( |
Destroy all Gizmos that are owned by the given pointer |
|
|
DestroyAllGizmosOfType ( |
Destroy all Gizmos that were created by the identified GizmoBuilder |
|
|
DestroyGizmo ( |
Shutdown and remove a Gizmo |
|
|
DisplayMessage ( |
Functions that Gizmos can call to interact with Transactions APIPost a message via the Transactions API |
|
|
DrawHUD ( |
Let active Gizmos do screen space drawing. |
|
|
FindAllGizmosOfType ( |
Find all the existing Gizmo instances that were created by the identified GizmoBuilder |
|
|
UInteractive... |
FindGizmoByInstanceIdentifier ( |
Find the Gizmo that was created with the given instance identifier |
|
IToolsContex... |
GetContextQueriesAPI() |
Access to APIs, etc |
|
Initialize ( |
Initialize the GizmoManager with the necessary Context-level state. |
|
|
PostInvalidation() |
Request an Invalidation via the Transactions API (ie to cause a repaint, etc) |
|
|
RegisterDefaultGizmos() |
Standard Gizmos Register default gizmo types |
|
|
RegisterGizmoType ( |
GizmoBuilder Registration and Gizmo Creation/Shutdown Register a new GizmoBuilder |
|
|
Render ( |
Render any active Gizmos. |
|
|
Shutdown() |
Shutdown the GizmoManager. |
|
|
Tick ( |
State control (Tick any active Gizmos. Called by UInteractiveToolsContext |
Name | Description | ||
---|---|---|---|
|
BeginUndoTransaction ( |
Request that the Context open a Transaction, whatever that means to the current Context |
|
|
EmitObjectChange ( |
Forward an FChange object to the Context |
|
|
EndUndoTransaction() |
Request that the Context close and commit the open Transaction |
Name |
Description |
---|---|
CustomThreeAxisTransformBuilderIdentifier |
|
DefaultAxisAngleBuilderIdentifier |
|
DefaultAxisPositionBuilderIdentifier |
Builder identifiers for default gizmo types. Perhaps should have an API for this... |
DefaultPlanePositionBuilderIdentifier |
|
DefaultThreeAxisTransformBuilderIdentifier |