UTransformProxy

[UTransformProxy](API\Runtime\InteractiveToolsFramework\BaseGizmos\UTransformProxy) is used to transform a set of sub-ojects.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/TransformProxy.h"

Syntax

class UTransformProxy : public UObject

Remarks

UTransformProxy is used to transform a set of sub-ojects. An internal FTransform is generated based on the sub-object set, and the relative FTransform of each sub-object is stored. Then as this main transform is updated, the sub-objects are also updated.

Currently only USceneComponent sub-objects are supported.

If only one sub-object is set, the main transform is the sub-object transform. Otherwise the main transform is centered at the average origin and has no rotation.

Variables

Name Description

Public variable

bool

 

bRotatePerObject

If true, relative rotation of shared transform is applied to objects before relative translation (ie they rotate in place)

Public variable

bool

 

bSetPivotMode

If true, then on SetTransform() the components are not moved, and their local transforms are recalculated

Protected variable

FTransform

 

InitialSharedTransform

The main transform

Protected variable

TArray< FRelati...

 

Objects

List of sub-objects

Public variable

FOnBeginPivotEd...

 

OnBeginPivotEdit

Public variable

FOnBeginTransfo...

 

OnBeginTransformEdit

Public variable

FOnEndPivotEdit

 

OnEndPivotEdit

Public variable

FOnEndTransform...

 

OnEndTransformEdit

Public variable

FOnPivotChanged

 

OnPivotChanged

Public variable

FOnTransformCha...

 

OnTransformChanged

Public variable

FOnTransformCha...

 

OnTransformChangedUndoRedo

This delegate is fired whenever the transform is changed by a FTransformProxyChange, ie on undo/redo.

Protected variable

FTransform

 

SharedTransform

The main transform

Functions

Name Description

Public function Virtual

void

 

AddComponent

(
    USceneComponent* Component,
    bool bModifyComponentOnTransform
)

Add a component sub-object to the proxy set.

Public function Virtual

void

 

AddComponentCustom

(
    USceneComponent* Component,
    TUniqueFunction< FTransform)> ...,
    TUniqueFunction< void)> ...,
    int64 UserDefinedIndex,
    bool bModifyComponentOnTransform
)

Add a component sub-object to the proxy set with custom transform access functions.

Public function Virtual

void

 

BeginPivotEditSequence()

Clients should call this before a sequence of SetTransform calls that have bSetPivotMode as true (see comment in BeginTransformEditSequence).

Public function Virtual

void

 

BeginTransformEditSequence()

In some use cases SetTransform() will be called repeatedly (eg during an interactive gizmo edit).

Public function Virtual

void

 

EndPivotEditSequence()

Clients should call this when done with a sequence of SetTransform that have bSetPivotMode as true (see comment in BeginTransformEditSequence).

Public function Virtual

void

 

EndTransformEditSequence()

External clients should call this when done a sequence of SetTransform calls (see BeginTransformEditSequence)

Public function Virtual Const

FTransform

 

GetTransform()

Public function Virtual

void

 

SetTransform

(
    const FTransform& Transform
)

Update the main transform and then update the sub-objects based on their relative transformations

Protected function Virtual

void

 

UpdateObjects()

Propagate a transform update to the sub-objects

Protected function Virtual

void

 

UpdateObjectTransforms()

Recalculate per-object relative transforms

Protected function Virtual

void

 

UpdateSharedTransform()

Recalculate main SharedTransform when object set changes

Classes

Name

Description

Protected struct

FRelativeObject

Typedefs

Name

Description

FOnBeginPivotEdit

This delegate is fired when BeginTransformEditSequence() is called to indicate that a sequence of pivot updates has started

FOnBeginTransformEdit

This delegate is fired when BeginTransformEditSequence() is called to indicate that a sequence of transform updates has started

FOnEndPivotEdit

This delegate is fired when EndTransformEditSequence() is called to indicate that a sequence of pivot updates has ended

FOnEndTransformEdit

This delegate is fired when EndTransformEditSequence() is called to indicate that a sequence of transform updates has ended

FOnPivotChanged

This delegate is fired whenever the internal transform changes due to a pivot reposition, ie on AddComponent and when SetTransform is called with bSetPivotMode being true.

FOnTransformChanged

This delegate is fired whenever the transform changes in a way that updates the contained components.