UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::TransformGizmoUtil Namespace Reference

Functions

INTERACTIVETOOLSFRAMEWORK_API bool RegisterTransformGizmoContextObject (UInteractiveToolsContext *ToolsContext)
 
INTERACTIVETOOLSFRAMEWORK_API bool DeregisterTransformGizmoContextObject (UInteractiveToolsContext *ToolsContext)
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreate3AxisTransformGizmo (UInteractiveGizmoManager *GizmoManager, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreate3AxisTransformGizmo (UInteractiveToolManager *ToolManager, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomTransformGizmo (UInteractiveGizmoManager *GizmoManager, ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomTransformGizmo (UInteractiveToolManager *ToolManager, ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomRepositionableTransformGizmo (UInteractiveGizmoManager *GizmoManager, ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomRepositionableTransformGizmo (UInteractiveToolManager *ToolManager, ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 

Function Documentation

◆ Create3AxisTransformGizmo() [1/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::Create3AxisTransformGizmo ( UInteractiveGizmoManager GizmoManager,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new standard 3-axis Transform gizmo (see UCombinedTransformGizmoContextObject::Create3AxisTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ Create3AxisTransformGizmo() [2/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::Create3AxisTransformGizmo ( UInteractiveToolManager ToolManager,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new standard 3-axis Transform gizmo (see UCombinedTransformGizmoContextObject::Create3AxisTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ CreateCustomRepositionableTransformGizmo() [1/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::CreateCustomRepositionableTransformGizmo ( UInteractiveGizmoManager GizmoManager,
ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ CreateCustomRepositionableTransformGizmo() [2/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::CreateCustomRepositionableTransformGizmo ( UInteractiveToolManager ToolManager,
ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomRepositionableTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ CreateCustomTransformGizmo() [1/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::CreateCustomTransformGizmo ( UInteractiveGizmoManager GizmoManager,
ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ CreateCustomTransformGizmo() [2/2]

UCombinedTransformGizmo * UE::TransformGizmoUtil::CreateCustomTransformGizmo ( UInteractiveToolManager ToolManager,
ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)

Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details)

◆ DeregisterTransformGizmoContextObject()

bool UE::TransformGizmoUtil::DeregisterTransformGizmoContextObject ( UInteractiveToolsContext ToolsContext)

Remove any existing UCombinedTransformGizmoContextObject from the ToolsContext's ContextObjectStore

Returns
true if the ContextObjectStore no longer has a UCombinedTransformGizmoContextObject (whether it was removed, or did not exist)

◆ RegisterTransformGizmoContextObject()

bool UE::TransformGizmoUtil::RegisterTransformGizmoContextObject ( UInteractiveToolsContext ToolsContext)

If one does not already exist, create a new instance of UCombinedTransformGizmoContextObject and add it to the ToolsContext's ContextObjectStore

Returns
true if the ContextObjectStore now has a UCombinedTransformGizmoContextObject (whether it already existed, or was created)