UGizmoObjectModifyStateTarget

[UGizmoObjectModifyStateTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoObjectModifyStateTarget) is an implementation of [IGizmoStateTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoStateTarget) that opens and closes change transactions on a target [UObject](API\Runtime\CoreUObject\UObject\UObject) via a GizmoManager.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGizmoObjectModifyStateTarget

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/StateTargets.h

Include

#include "BaseGizmos/StateTargets.h"

Syntax

class UGizmoObjectModifyStateTarget :
    public UObject,
    public IGizmoStateTarget

Remarks

UGizmoObjectModifyStateTarget is an implementation of IGizmoStateTarget that opens and closes change transactions on a target UObject via a GizmoManager.

Variables

Name Description

Public variable

TWeakObjectPtr<...

 

GizmoManager

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

Public variable

TWeakObjectPtr<...

 

ModifyObject

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

Public variable

FText

 

TransactionDescription

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

Functions

Name Description

Public function Static

UGizmoObject...

 

Construct

(
    UObject* ModifyObjectIn,
    const FText& DescriptionIn,
    UInteractiveGizmoManager* Gizm...,
    UObject* Outer
)

Create and initialize an standard instance of UGizmoObjectModifyStateTarget

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)