Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/TransformProxy.h |
Include |
#include "BaseGizmos/TransformProxy.h" |
class UTransformProxy : public UObject
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.
Name | Description | ||
---|---|---|---|
|
bRotatePerObject |
If true, relative rotation of shared transform is applied to objects before relative translation (ie they rotate in place) |
|
|
bSetPivotMode |
If true, then on SetTransform() the components are not moved, and their local transforms are recalculated |
|
|
InitialSharedTransform |
The main transform |
|
|
Objects |
List of sub-objects |
|
|
OnBeginPivotEdit |
||
|
OnBeginTransformEdit |
||
|
OnEndPivotEdit |
||
|
OnEndTransformEdit |
||
|
OnPivotChanged |
||
|
OnTransformChanged |
||
|
OnTransformChangedUndoRedo |
This delegate is fired whenever the transform is changed by a FTransformProxyChange, ie on undo/redo. |
|
|
SharedTransform |
The main transform |
Name | Description | ||
---|---|---|---|
|
AddComponent ( |
Add a component sub-object to the proxy set. |
|
|
AddComponentCustom ( |
Add a component sub-object to the proxy set with custom transform access functions. |
|
|
BeginPivotEditSequence() |
Clients should call this before a sequence of SetTransform calls that have bSetPivotMode as true (see comment in BeginTransformEditSequence). |
|
|
BeginTransformEditSequence() |
In some use cases SetTransform() will be called repeatedly (eg during an interactive gizmo edit). |
|
|
EndPivotEditSequence() |
Clients should call this when done with a sequence of SetTransform that have bSetPivotMode as true (see comment in BeginTransformEditSequence). |
|
|
EndTransformEditSequence() |
External clients should call this when done a sequence of SetTransform calls (see BeginTransformEditSequence) |
|
|
GetTransform() |
||
|
SetTransform ( |
Update the main transform and then update the sub-objects based on their relative transformations |
|
|
UpdateObjects() |
Propagate a transform update to the sub-objects |
|
|
UpdateObjectTransforms() |
Recalculate per-object relative transforms |
|
|
UpdateSharedTransform() |
Recalculate main SharedTransform when object set changes |
Name |
Description |
|
---|---|---|
|
FRelativeObject |
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. |