Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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.
| Name | UCombinedTransformGizmoContextObject |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/TransformGizmoUtil.h |
| Include Path | #include "BaseGizmos/TransformGizmoUtil.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UCombinedTransformGizmoContextObject : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCombinedTransformGizmoContextObject
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGizmoCreated | TMulticastDelegate_OneParam< void, UCombinedTransformGizmo * > | BaseGizmos/TransformGizmoUtil.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CustomRepositionableThreeAxisTransformBuilderIdentifier | const FString | BaseGizmos/TransformGizmoUtil.h | |
| CustomThreeAxisTransformBuilderIdentifier | const FString | BaseGizmos/TransformGizmoUtil.h | |
| DefaultAxisAngleBuilderIdentifier | const FString | BaseGizmos/TransformGizmoUtil.h | |
| DefaultAxisPositionBuilderIdentifier | const FString | Builder identifiers for default gizmo types. Perhaps should have an API for this... | BaseGizmos/TransformGizmoUtil.h |
| DefaultPlanePositionBuilderIdentifier | const FString | BaseGizmos/TransformGizmoUtil.h | |
| DefaultThreeAxisTransformBuilderIdentifier | const FString | BaseGizmos/TransformGizmoUtil.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnGizmoCreated | FOnGizmoCreated | BaseGizmos/TransformGizmoUtil.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UCombinedTransformGizmo * Create3AxisTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Activate a new instance of the default 3-axis transformation Gizmo. | BaseGizmos/TransformGizmoUtil.h | |
virtual UCombinedTransformGizmo * CreateCustomRepositionableTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Variant of CreateCustomTransformGizmo that creates a URepositionableTransformGizmo, which is an extension to UCombinedTransformGizmo that supports various snapping interactions | BaseGizmos/TransformGizmoUtil.h | |
virtual UCombinedTransformGizmo * CreateCustomTransformGizmo
(
UInteractiveGizmoManager* GizmoManager, |
Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included. | BaseGizmos/TransformGizmoUtil.h | |
void DeregisterGizmosWithManager
(
UInteractiveToolManager* ToolManager |
BaseGizmos/TransformGizmoUtil.h | ||
void RegisterGizmosWithManager
(
UInteractiveToolManager* ToolManager |
BaseGizmos/TransformGizmoUtil.h |