Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Common parameters needed for initializing a sub gizmo. Used in several sub gizmo reinitialization functions (such as UAxisPositionGizmo::InitializeAsTranslateGizmo).
| Name | FTransformSubGizmoCommonParams |
| Type | struct |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/TransformSubGizmoUtil.h |
| Include Path | #include "BaseGizmos/TransformSubGizmoUtil.h" |
Syntax
struct FTransformSubGizmoCommonParams
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Axis | EAxis::Type | BaseGizmos/TransformSubGizmoUtil.h | ||
| bAxisIsBasedOnRootComponent | bool | If true, we use the axis of the root gizmo component. | BaseGizmos/TransformSubGizmoUtil.h | |
| bManipulatesRootComponent | bool | If true, the gizmo moves the parent root component rather than just its own component, like the standard TRS sub gizmos do. | BaseGizmos/TransformSubGizmoUtil.h | |
| Component | UPrimitiveComponent * | BaseGizmos/TransformSubGizmoUtil.h | ||
| OuterForSubobjects | UObject * | Transient package is used if custom outer is not provided. | BaseGizmos/TransformSubGizmoUtil.h | |
| TransactionName | TOptional< FText > | Default transaction name and provider are used if not provided. | BaseGizmos/TransformSubGizmoUtil.h | |
| TransactionProvider | IToolContextTransactionProvider * | BaseGizmos/TransformSubGizmoUtil.h | ||
| TransformProxy | UTransformProxy * | BaseGizmos/TransformSubGizmoUtil.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int GetClampedAxisIndex() |
Returns the Axis parameter as an index in the range [0,2] where 0 corresponds to X (or None), 1 corresponds to Y, and 2 corresponds to Z. | BaseGizmos/TransformSubGizmoUtil.h |