// Copyright Epic Games, Inc. All Rights Reserved. #include "BaseGizmos/RepositionableTransformGizmo.h" #include "BaseBehaviors/ClickDragBehavior.h" #include "BaseGizmos/AxisAngleGizmo.h" #include "BaseGizmos/AxisPositionGizmo.h" #include "BaseGizmos/GizmoViewContext.h" #include "BaseGizmos/HitTargets.h" #include "BaseGizmos/PlanePositionGizmo.h" #include "BaseGizmos/TransformProxy.h" #include "BaseGizmos/TransformSources.h" #include "ContextObjectStore.h" #include "InteractiveGizmo.h" #define LOCTEXT_NAMESPACE "URepositionableTransformGizmo" UInteractiveGizmo* URepositionableTransformGizmoBuilder::BuildGizmo(const FToolBuilderState& SceneState) const { UCombinedTransformGizmo* NewGizmo = NewObject(SceneState.GizmoManager); NewGizmo->SetWorld(SceneState.World); UGizmoViewContext* GizmoViewContext = SceneState.ToolManager->GetContextObjectStore()->FindContext(); check(GizmoViewContext && GizmoViewContext->IsValidLowLevel()); // use default gizmo actor if client has not given us a new builder NewGizmo->SetGizmoActorBuilder(GizmoActorBuilder ? GizmoActorBuilder : MakeShared(GizmoViewContext)); NewGizmo->SetSubGizmoBuilderIdentifiers(AxisPositionBuilderIdentifier, PlanePositionBuilderIdentifier, AxisAngleBuilderIdentifier); // override default hover function if proposed if (UpdateHoverFunction) { NewGizmo->SetUpdateHoverFunction(UpdateHoverFunction); } if (UpdateCoordSystemFunction) { NewGizmo->SetUpdateCoordSystemFunction(UpdateCoordSystemFunction); } return NewGizmo; } void URepositionableTransformGizmo::SetActiveTarget(UTransformProxy* Target, IToolContextTransactionProvider* TransactionProvider) { // We're going to add on to the original transform gizmo, adding extra gizmos centered around // existing gizmo components. These will respond to middle clicks and take "set pivot" code // paths in their transform source and state target. UCombinedTransformGizmo::SetActiveTarget(Target, TransactionProvider); // Create the alternate transform source. UGizmoTransformProxyTransformSource* ProxyTransformSource = UGizmoTransformProxyTransformSource::Construct(ActiveTarget, this); ProxyTransformSource->bOverrideSetPivotMode = true; USceneComponent* GizmoComponent = GizmoActor->GetRootComponent(); UGizmoScaledAndUnscaledTransformSources* TransformSource = UGizmoScaledAndUnscaledTransformSources::Construct( ProxyTransformSource, GizmoComponent, this); // The state target gives a different name to the transactions and issues different begin/end calls. RepositionStateTarget = UGizmoTransformChangeStateTarget::Construct(GizmoComponent, LOCTEXT("TransformGizmoTransaction", "Reposition Pivot"), Cast(StateTarget->TransactionManager.GetObject()), this); TUniquePtr ProxyChangeSource = MakeUnique(Target); ProxyChangeSource->bOverrideSetPivotMode = true; RepositionStateTarget->DependentChangeSources.Add(MoveTemp(ProxyChangeSource)); // Add on the extra gizmos to existing components. We use the base class addition functions and // then go back to tweak the parts that need changing using our own "Modify..." functions. // We also store the repositioning gizmos in an additional separate list so that we can // modify their alignment functions separately if we need to. if (GizmoActor->TranslateX != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisTranslationGizmo(GizmoActor->TranslateX, GizmoComponent, AxisXSource, TransformSource, RepositionStateTarget); ModifyPivotAxisGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->TranslateY != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisTranslationGizmo(GizmoActor->TranslateY, GizmoComponent, AxisYSource, TransformSource, RepositionStateTarget); ModifyPivotAxisGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->TranslateZ != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisTranslationGizmo(GizmoActor->TranslateZ, GizmoComponent, AxisZSource, TransformSource, RepositionStateTarget); ModifyPivotAxisGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->TranslateYZ != nullptr) { UInteractiveGizmo* SubGizmo = AddPlaneTranslationGizmo(GizmoActor->TranslateYZ, GizmoComponent, AxisXSource, TransformSource, RepositionStateTarget); ModifyPivotPlaneGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->TranslateXZ != nullptr) { UInteractiveGizmo* SubGizmo = AddPlaneTranslationGizmo(GizmoActor->TranslateXZ, GizmoComponent, AxisYSource, TransformSource, RepositionStateTarget); ModifyPivotPlaneGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->TranslateXY != nullptr) { UInteractiveGizmo* SubGizmo = AddPlaneTranslationGizmo(GizmoActor->TranslateXY, GizmoComponent, AxisZSource, TransformSource, RepositionStateTarget); ModifyPivotPlaneGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->RotateX != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisRotationGizmo(GizmoActor->RotateX, GizmoComponent, AxisXSource, TransformSource, RepositionStateTarget); ModifyPivotRotateGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->RotateY != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisRotationGizmo(GizmoActor->RotateY, GizmoComponent, AxisYSource, TransformSource, RepositionStateTarget); ModifyPivotRotateGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } if (GizmoActor->RotateZ != nullptr) { UInteractiveGizmo* SubGizmo = AddAxisRotationGizmo(GizmoActor->RotateZ, GizmoComponent, AxisZSource, TransformSource, RepositionStateTarget); ModifyPivotRotateGizmo(SubGizmo); PivotAlignmentGizmos.Add(SubGizmo); } } /** * Modifies a UAxisPositionGizmo after its addition via AddAxisTranslationGizmo for use in * gizmo repositioning. */ void URepositionableTransformGizmo::ModifyPivotAxisGizmo(UInteractiveGizmo* SubGizmoIn) { UAxisPositionGizmo* SubGizmo = Cast(SubGizmoIn); check(SubGizmo); SubGizmo->MouseBehavior->SetUseMiddleMouseButton(); SubGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; SubGizmo->CustomDestinationFunc = [this](const UAxisPositionGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; UGizmoComponentHitTarget* HitTarget = Cast(SubGizmo->HitTarget.GetObject()); check(HitTarget); HitTarget->UpdateHoverFunction = nullptr; // Already taken care of by the normal gizmo } /** * Modifies a UPlanePositionGizmo after its addition via AddPlaneTranslationGizmo for use in * gizmo repositioning. */ void URepositionableTransformGizmo::ModifyPivotPlaneGizmo(UInteractiveGizmo* SubGizmoIn) { UPlanePositionGizmo* SubGizmo = Cast(SubGizmoIn); check(SubGizmo); SubGizmo->MouseBehavior->SetUseMiddleMouseButton(); SubGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; SubGizmo->CustomDestinationFunc = [this](const UPlanePositionGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; UGizmoComponentHitTarget* HitTarget = Cast(SubGizmo->HitTarget.GetObject()); check(HitTarget); HitTarget->UpdateHoverFunction = nullptr; // Already taken care of by the normal gizmo } /** * Modifies a UAxisAngleGizmo after its addition via AddAxisRotationGizmo for use in * gizmo repositioning. */ void URepositionableTransformGizmo::ModifyPivotRotateGizmo(UInteractiveGizmo* SubGizmoIn) { UAxisAngleGizmo* SubGizmo = Cast(SubGizmoIn); check(SubGizmo); SubGizmo->MouseBehavior->SetUseMiddleMouseButton(); SubGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; SubGizmo->CustomDestinationFunc = [this](const UAxisAngleGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; UGizmoComponentHitTarget* HitTarget = Cast(SubGizmo->HitTarget.GetObject()); check(HitTarget); HitTarget->UpdateHoverFunction = nullptr; // Already taken care of by the normal gizmo // We don't want to be able to reposition the rotation of the gizmo when using the world coordinate system, // since the axes must stay aligned with world axes. However we can't hide the component either because it // is used for regular rotation. Thus, we add a check that disables the reposition gizmo hit testing if // the coordinate system is not local. HitTarget->Condition = [this](const FInputDeviceRay&) { return (CurrentCoordinateSystem == EToolContextCoordinateSystem::Local); }; } void URepositionableTransformGizmo::SetWorldAlignmentFunctions( TUniqueFunction&& ShouldAlignTranslationIn, TUniqueFunction&& TranslationAlignmentRayCasterIn) { // The base class function will do most of what we want. UCombinedTransformGizmo::SetWorldAlignmentFunctions(MoveTemp(ShouldAlignTranslationIn), MoveTemp(TranslationAlignmentRayCasterIn)); // However, we need to adjust our saved pivot alignment functions so changes of the gizmo target keep the settings. // Since the functions are TUniqueFunction, we can't actually copy them here, we need to create new functors that // forward to the other ones. ShouldAlignPivot = [this]() { return ShouldAlignDestination(); }; PivotAlignmentRayCaster = [this](const FRay& WorldRay, FVector& OutputPoint) { return DestinationAlignmentRayCaster(WorldRay, OutputPoint); }; } void URepositionableTransformGizmo::SetPivotAlignmentFunctions( TUniqueFunction&& ShouldAlignPivotIn, TUniqueFunction&& PivotAlignmentRayCasterIn) { // Save these so that later changes of gizmo target keep the settings. ShouldAlignPivot = MoveTemp(ShouldAlignPivotIn); PivotAlignmentRayCaster = MoveTemp(PivotAlignmentRayCasterIn); // We allow this function to be called after Setup(), so modify any existing translation sub gizmos. for (UInteractiveGizmo* SubGizmo : PivotAlignmentGizmos) { if (UAxisPositionGizmo* CastGizmo = Cast(SubGizmo)) { CastGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; CastGizmo->CustomDestinationFunc = [this](const UAxisPositionGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; } if (UPlanePositionGizmo* CastGizmo = Cast(SubGizmo)) { CastGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; CastGizmo->CustomDestinationFunc = [this](const UPlanePositionGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; } if (UAxisAngleGizmo* CastGizmo = Cast(SubGizmo)) { CastGizmo->ShouldUseCustomDestinationFunc = [this]() { return ShouldAlignPivot(); }; CastGizmo->CustomDestinationFunc = [this](const UAxisAngleGizmo::FCustomDestinationParams& Params, FVector& OutputPoint) { return PivotAlignmentRayCaster(*Params.WorldRay, OutputPoint); }; } } } #undef LOCTEXT_NAMESPACE