Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoTransformChangeStateTarget
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/StateTargets.h |
| Include | #include "BaseGizmos/StateTargets.h" |
Syntax
class UGizmoTransformChangeStateTarget :
public UObject,
public IGizmoStateTarget
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FText | ChangeDescription | Localized text description of the transaction (will be visible in Editor on undo/redo) | |
| TArray< TUniquePtr< IToolCommandChangeSource > > | DependentChangeSources | Dependent-change generators. | |
| TArray< IToolCommandChangeSource * > | ExternalDependentChangeSources | Dependent-change generators that are not owned by this class, otherwise handled identically to DependentChangeSources | |
| FTransform | FinalTransform | End Transform, saved on EndUpdate() | |
| FTransform | InitialTransform | Start Transform, saved on BeginUpdate() | |
| TWeakObjectPtr< USceneComponent > | TargetComponent | The object that will be changed, ie have Modify() called on it on BeginUpdate() | |
| TScriptInterface< IToolContextTransactionProvider > | TransactionManager | Pointer to the GizmoManager or ToolManager that is used to open/close the transaction |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UGizmoTransformChangeStateTarget * | Construct
(
USceneComponent* TargetComponentIn, |
Create and initialize an standard instance of UGizmoTransformChangeStateTarget |
Overridden from IGizmoStateTarget
| Type | Name | Description | |
|---|---|---|---|
| void | BeginUpdate () |
BeginUpdate is called before a standard Gizmo begins changing a parameter (via a ParameterSource) | |
| void | EndUpdate () |
EndUpdate is called when a standard Gizmo is finished changing a parameter (via a ParameterSource) |