UCombinedTransformGizmo::SetWorldAlignmentFunctions

If used, binds alignment functions to the sub gizmos that they can use to align to geometry in the scene.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

UCombinedTransformGizmo::SetWorldAlignmentFunctions()

URepositionableTransformGizmo::SetWorldAlignmentFunctions()

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/CombinedTransformGizmo.h"

Source

/Engine/Source/Runtime/InteractiveToolsFramework/Private/BaseGizmos/CombinedTransformGizmo.cpp

Syntax

virtual void SetWorldAlignmentFunctions
(
    TUniqueFunction< bool()> && ShouldAlignDestination,
    TUniqueFunction< bool &, FVector &)> && DestinationAlignmentRayCaster
)

Remarks

If used, binds alignment functions to the sub gizmos that they can use to align to geometry in the scene. Specifically, translation and rotation gizmos will check ShouldAlignDestination() to see if they should use the custom ray caster (this allows the behavior to respond to modifier key presses, for instance), and then use DestinationAlignmentRayCaster() to find a point to align to. Subgizmos align to the point in different ways, usually by projecting onto the axis or plane that they operate in.