Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UGizmoTransformChangeStateTarget is an implementation of IGizmoStateTarget that emits an FComponentWorldTransformChange on a target USceneComponent. This StateTarget also opens/closes an undo transaction via GizmoManager.
The DependentChangeSources and ExternalDependentChangeSources lists allow additional FChange objects to be inserted into the transaction, provided by IToolCommandChangeSource implementations.
| Name | UGizmoTransformChangeStateTarget |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/StateTargets.h |
| Include Path | #include "BaseGizmos/StateTargets.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoTransformChangeStateTarget :
public UObject ,
public IGizmoStateTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoTransformChangeStateTarget
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChangeDescription | FText | Localized text description of the transaction (will be visible in Editor on undo/redo) | BaseGizmos/StateTargets.h | |
| DependentChangeSources | TArray< TUniquePtr< IToolCommandChangeSource > > | Dependent-change generators. | BaseGizmos/StateTargets.h | |
| ExternalDependentChangeSources | TArray< IToolCommandChangeSource * > | Dependent-change generators that are not owned by this class, otherwise handled identically to DependentChangeSources | BaseGizmos/StateTargets.h | |
| FinalTransform | FTransform | End Transform, saved on EndUpdate() | BaseGizmos/StateTargets.h | |
| InitialTransform | FTransform | Start Transform, saved on BeginUpdate() | BaseGizmos/StateTargets.h | |
| TargetComponent | TWeakObjectPtr< USceneComponent > | The object that will be changed, ie have Modify() called on it on BeginUpdate() | BaseGizmos/StateTargets.h | |
| TransactionManager | TScriptInterface< IToolContextTransactionProvider > | Pointer to the GizmoManager or ToolManager that is used to open/close the transaction | BaseGizmos/StateTargets.h |
Functions
Public
Overridden from IGizmoStateTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginUpdate() |
BeginUpdate is called before a standard Gizmo begins changing a parameter (via a ParameterSource) | BaseGizmos/StateTargets.h | |
virtual void EndUpdate() |
EndUpdate is called when a standard Gizmo is finished changing a parameter (via a ParameterSource) | BaseGizmos/StateTargets.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UGizmoTransformChangeStateTarget * Construct
(
USceneComponent* TargetComponentIn, |
Create and initialize an standard instance of UGizmoTransformChangeStateTarget | BaseGizmos/StateTargets.h |