UGizmoTransformChangeStateTarget

[UGizmoTransformChangeStateTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoTransformChangeStateTarget) is an implementation of [IGizmoStateTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoStateTarget) that emits an [FComponentWorldTransformChange](API\Runtime\InteractiveToolsFramework\Changes\FComponentWorldTransformChange) on a target [USceneComponent](API\Runtime\Engine\Components\USceneComponent).

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGizmoTransformChangeStateTarget

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/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

Name Description

Public variable

FText

 

ChangeDescription

Localized text description of the transaction (will be visible in Editor on undo/redo)

Public variable

TArray < TUnique ...

 

DependentChangeSources

Dependent-change generators.

Public variable

TArray < IToolCo ...

 

ExternalDependentChangeSources

Dependent-change generators that are not owned by this class, otherwise handled identically to DependentChangeSources

Public variable

FTransform

 

FinalTransform

End Transform, saved on EndUpdate()

Public variable

FTransform

 

InitialTransform

Start Transform, saved on BeginUpdate()

Public variable

TWeakObjectPtr <...

 

TargetComponent

The object that will be changed, ie have Modify() called on it on BeginUpdate()

Public variable

TScriptInterfac ...

 

TransactionManager

Pointer to the GizmoManager or ToolManager that is used to open/close the transaction

Functions

Name Description

Public function Static

UGizmoTransf ...

 

Construct

(
    USceneComponent * TargetCompone...,
    const FText & DescriptionIn,
    IToolContextTransactionProvider ...,
    UObject * Outer
)

Create and initialize an standard instance of UGizmoTransformChangeStateTarget

Overridden from IGizmoStateTarget

Name Description

Public function Virtual

void

 

BeginUpdate()

BeginUpdate is called before a standard Gizmo begins changing a parameter (via a ParameterSource)

Public function Virtual

void

 

EndUpdate()

EndUpdate is called when a standard Gizmo is finished changing a parameter (via a ParameterSource)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback