Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
ACombinedTransformGizmoActor is an Actor type intended to be used with UCombinedTransformGizmo, as the in-scene visual representation of the Gizmo.
FCombinedTransformGizmoActorFactory returns an instance of this Actor type (or a subclass), and based on which Translate and Rotate UProperties are initialized, will associate those Components with UInteractiveGizmo's that implement Axis Translation, Plane Translation, and Axis Rotation.
If a particular sub-Gizmo is not required, simply set that FProperty to null.
The static factory method ConstructDefault3AxisGizmo() creates and initializes an Actor suitable for use in a standard 3-axis Transformation Gizmo.
| Name | ACombinedTransformGizmoActor |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/CombinedTransformGizmo.h |
| Include Path | #include "BaseGizmos/CombinedTransformGizmo.h" |
Syntax
UCLASS (Transient, NotPlaceable, Hidden, NotBlueprintable, NotBlueprintType, MinimalAPI)
class ACombinedTransformGizmoActor : public AGizmoActor
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AInternalToolFrameworkActor → AGizmoActor → ACombinedTransformGizmoActor
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ACombinedTransformGizmoActor() |
BaseGizmos/CombinedTransformGizmo.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AxisScaleX | TObjectPtr< UPrimitiveComponent > | X Axis Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| AxisScaleY | TObjectPtr< UPrimitiveComponent > | Y Axis Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| AxisScaleZ | TObjectPtr< UPrimitiveComponent > | Z Axis Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| FreeRotateHandle | TObjectPtr< UPrimitiveComponent > | BaseGizmos/CombinedTransformGizmo.h | ||
| FreeTranslateHandle | TObjectPtr< UPrimitiveComponent > | BaseGizmos/CombinedTransformGizmo.h | ||
| PlaneScaleXY | TObjectPtr< UPrimitiveComponent > | XY Plane Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| PlaneScaleXZ | TObjectPtr< UPrimitiveComponent > | XZ Plane Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| PlaneScaleYZ | TObjectPtr< UPrimitiveComponent > | YZ Plane Scale Component | BaseGizmos/CombinedTransformGizmo.h | |
| RotateX | TObjectPtr< UPrimitiveComponent > | Rotation Components X Axis Rotation Component | BaseGizmos/CombinedTransformGizmo.h | |
| RotateY | TObjectPtr< UPrimitiveComponent > | Y Axis Rotation Component | BaseGizmos/CombinedTransformGizmo.h | |
| RotateZ | TObjectPtr< UPrimitiveComponent > | Z Axis Rotation Component | BaseGizmos/CombinedTransformGizmo.h | |
| RotationSphere | TObjectPtr< UPrimitiveComponent > | Circle that gets drawn around the outside of the gizmo to make it look like a sphere | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateX | TObjectPtr< UPrimitiveComponent > | Translation Components X Axis Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateXY | TObjectPtr< UPrimitiveComponent > | XY Plane Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateXZ | TObjectPtr< UPrimitiveComponent > | XZ Plane Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateY | TObjectPtr< UPrimitiveComponent > | Y Axis Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateYZ | TObjectPtr< UPrimitiveComponent > | YZ Plane Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| TranslateZ | TObjectPtr< UPrimitiveComponent > | Z Axis Translation Component | BaseGizmos/CombinedTransformGizmo.h | |
| UniformScale | TObjectPtr< UPrimitiveComponent > | Scaling Components Uniform Scale Component | BaseGizmos/CombinedTransformGizmo.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdjustersThatMirrorOnlyInCombinedMode | TArray< TWeakPtr< UE::GizmoRenderingUtil::FSubGizmoTransformAdjuster > > | BaseGizmos/CombinedTransformGizmo.h | ||
| FullAxisScaleX | TObjectPtr< UPrimitiveComponent > | These store versions of the axis scale components that can be used when not using a combined gizmo, if they differ. | BaseGizmos/CombinedTransformGizmo.h | |
| FullAxisScaleY | TObjectPtr< UPrimitiveComponent > | BaseGizmos/CombinedTransformGizmo.h | ||
| FullAxisScaleZ | TObjectPtr< UPrimitiveComponent > | BaseGizmos/CombinedTransformGizmo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ReplaceSubGizmoComponent
(
ETransformGizmoSubElements Element, |
Replaces the component corresponding to the given element with a new component. | BaseGizmos/CombinedTransformGizmo.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ACombinedTransformGizmoActor * ConstructCustom3AxisGizmo
(
UWorld* World, |
Create a new instance of ACombinedTransformGizmoActor. | BaseGizmos/CombinedTransformGizmo.h | |
static ACombinedTransformGizmoActor * ConstructDefault3AxisGizmo
(
UWorld* World, |
Create a new instance of ACombinedTransformGizmoActor and populate the various sub-components with standard GizmoXComponent instances suitable for a 3-axis transformer Gizmo | BaseGizmos/CombinedTransformGizmo.h |