Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCombinedTransformGizmoContextObject
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/TransformGizmoUtil.h |
| Include | #include "BaseGizmos/TransformGizmoUtil.h" |
Syntax
class UCombinedTransformGizmoContextObject : public UObject
Remarks
UCombinedTransformGizmoContextObject is a utility object that registers a set of Gizmo Builders for UCombinedTransformGizmo and variants. The intended usage is to call RegisterGizmosWithManager(), and then the UCombinedTransformGizmoContextObject will register itself as a ContextObject in the InteractiveToolsContext's ContextObjectStore. Then the Create3AxisTransformGizmo()/etc functions will spawn different variants of UCombinedTransformGizmo. The above UE::TransformGizmoUtil:: functions will look up the UCombinedTransformGizmoContextObject instance in the ContextObjectStore and then call the associated function below.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bDefaultGizmosRegistered | |
 |
TSharedPtr< FCombinedTransformGizmoActorFactory > | GizmoActorBuilder | |
 |
FOnGizmoCreated | OnGizmoCreated |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UCombinedTransformGizmo * | Create3AxisTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Activate a new instance of the default 3-axis transformation Gizmo. |
  |
UCombinedTransformGizmo * | CreateCustomRepositionableTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Variant of CreateCustomTransformGizmo that creates a URepositionableTransformGizmo, which is an extension to UCombinedTransformGizmo that supports various snapping interactions |
  |
UCombinedTransformGizmo * | CreateCustomTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included. |
 |
void | DeregisterGizmosWithManager
(
UInteractiveToolManager* ToolManager |
|
 |
void | RegisterGizmosWithManager
(
UInteractiveToolManager* ToolManager |
Typedefs
| Name | Description |
|---|---|
| FOnGizmoCreated |
Constants
| Name | Description |
|---|---|
| CustomRepositionableThreeAxisTransformBuilderIdentifier | |
| CustomThreeAxisTransformBuilderIdentifier | |
| DefaultAxisAngleBuilderIdentifier | |
| DefaultAxisPositionBuilderIdentifier | Builder identifiers for default gizmo types. Perhaps should have an API for this... |
| DefaultPlanePositionBuilderIdentifier | |
| DefaultThreeAxisTransformBuilderIdentifier |