// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved. #include "SplineComponentVisualizer.h" #include "Framework/Application/SlateApplication.h" #include "Framework/Commands/InputChord.h" #include "Framework/Commands/Commands.h" #include "Framework/Commands/UICommandList.h" #include "Framework/MultiBox/MultiBoxBuilder.h" #include "EditorStyleSet.h" #include "UnrealWidget.h" #include "Editor.h" #include "EditorViewportClient.h" #include "Components/SplineComponent.h" #include "ScopedTransaction.h" #include "ActorEditorUtils.h" IMPLEMENT_HIT_PROXY(HSplineVisProxy, HComponentVisProxy); IMPLEMENT_HIT_PROXY(HSplineKeyProxy, HSplineVisProxy); IMPLEMENT_HIT_PROXY(HSplineSegmentProxy, HSplineVisProxy); IMPLEMENT_HIT_PROXY(HSplineTangentHandleProxy, HSplineVisProxy); #define LOCTEXT_NAMESPACE "SplineComponentVisualizer" #define VISUALIZE_SPLINE_UPVECTORS 0 /** Define commands for the spline component visualizer */ class FSplineComponentVisualizerCommands : public TCommands { public: FSplineComponentVisualizerCommands() : TCommands ( "SplineComponentVisualizer", // Context name for fast lookup LOCTEXT("SplineComponentVisualizer", "Spline Component Visualizer"), // Localized context name for displaying NAME_None, // Parent FEditorStyle::GetStyleSetName() ) { } virtual void RegisterCommands() override { UI_COMMAND(DeleteKey, "Delete Spline Point", "Delete the currently selected spline point.", EUserInterfaceActionType::Button, FInputChord(EKeys::Delete)); UI_COMMAND(DuplicateKey, "Duplicate Spline Point", "Duplicate the currently selected spline point.", EUserInterfaceActionType::Button, FInputChord()); UI_COMMAND(AddKey, "Add Spline Point Here", "Add a new spline point at the cursor location.", EUserInterfaceActionType::Button, FInputChord()); UI_COMMAND(ResetToUnclampedTangent, "Unclamped Tangent", "Reset the tangent for this spline point to its default unclamped value.", EUserInterfaceActionType::Button, FInputChord()); UI_COMMAND(ResetToClampedTangent, "Clamped Tangent", "Reset the tangent for this spline point to its default clamped value.", EUserInterfaceActionType::Button, FInputChord()); UI_COMMAND(SetKeyToCurve, "Curve", "Set spline point to Curve type", EUserInterfaceActionType::RadioButton, FInputChord()); UI_COMMAND(SetKeyToLinear, "Linear", "Set spline point to Linear type", EUserInterfaceActionType::RadioButton, FInputChord()); UI_COMMAND(SetKeyToConstant, "Constant", "Set spline point to Constant type", EUserInterfaceActionType::RadioButton, FInputChord()); UI_COMMAND(VisualizeRollAndScale, "Visualize Roll and Scale", "Whether the visualization should show roll and scale on this spline.", EUserInterfaceActionType::ToggleButton, FInputChord()); UI_COMMAND(DiscontinuousSpline, "Allow Discontinuous Splines", "Whether the visualization allows Arrive and Leave tangents to be set separately.", EUserInterfaceActionType::ToggleButton, FInputChord()); UI_COMMAND(ResetToDefault, "Reset to Default", "Reset this spline to its archetype default.", EUserInterfaceActionType::Button, FInputChord()); } public: /** Delete key */ TSharedPtr DeleteKey; /** Duplicate key */ TSharedPtr DuplicateKey; /** Add key */ TSharedPtr AddKey; /** Reset to unclamped tangent */ TSharedPtr ResetToUnclampedTangent; /** Reset to clamped tangent */ TSharedPtr ResetToClampedTangent; /** Set spline key to Curve type */ TSharedPtr SetKeyToCurve; /** Set spline key to Linear type */ TSharedPtr SetKeyToLinear; /** Set spline key to Constant type */ TSharedPtr SetKeyToConstant; /** Whether the visualization should show roll and scale */ TSharedPtr VisualizeRollAndScale; /** Whether we allow separate Arrive / Leave tangents, resulting in a discontinuous spline */ TSharedPtr DiscontinuousSpline; /** Reset this spline to its default */ TSharedPtr ResetToDefault; }; FSplineComponentVisualizer::FSplineComponentVisualizer() : FComponentVisualizer() , LastKeyIndexSelected(INDEX_NONE) , SelectedSegmentIndex(INDEX_NONE) , SelectedTangentHandle(INDEX_NONE) , SelectedTangentHandleType(ESelectedTangentHandle::None) , bAllowDuplication(true) { FSplineComponentVisualizerCommands::Register(); SplineComponentVisualizerActions = MakeShareable(new FUICommandList); SplineCurvesProperty = FindField(USplineComponent::StaticClass(), GET_MEMBER_NAME_CHECKED(USplineComponent, SplineCurves)); } void FSplineComponentVisualizer::OnRegister() { const auto& Commands = FSplineComponentVisualizerCommands::Get(); SplineComponentVisualizerActions->MapAction( Commands.DeleteKey, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnDeleteKey), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::CanDeleteKey)); SplineComponentVisualizerActions->MapAction( Commands.DuplicateKey, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnDuplicateKey), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::IsKeySelectionValid)); SplineComponentVisualizerActions->MapAction( Commands.AddKey, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnAddKey), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::CanAddKey)); SplineComponentVisualizerActions->MapAction( Commands.ResetToUnclampedTangent, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnResetToAutomaticTangent, CIM_CurveAuto), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::CanResetToAutomaticTangent, CIM_CurveAuto)); SplineComponentVisualizerActions->MapAction( Commands.ResetToClampedTangent, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnResetToAutomaticTangent, CIM_CurveAutoClamped), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::CanResetToAutomaticTangent, CIM_CurveAutoClamped)); SplineComponentVisualizerActions->MapAction( Commands.SetKeyToCurve, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnSetKeyType, CIM_CurveAuto), FCanExecuteAction(), FIsActionChecked::CreateSP(this, &FSplineComponentVisualizer::IsKeyTypeSet, CIM_CurveAuto)); SplineComponentVisualizerActions->MapAction( Commands.SetKeyToLinear, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnSetKeyType, CIM_Linear), FCanExecuteAction(), FIsActionChecked::CreateSP(this, &FSplineComponentVisualizer::IsKeyTypeSet, CIM_Linear)); SplineComponentVisualizerActions->MapAction( Commands.SetKeyToConstant, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnSetKeyType, CIM_Constant), FCanExecuteAction(), FIsActionChecked::CreateSP(this, &FSplineComponentVisualizer::IsKeyTypeSet, CIM_Constant)); SplineComponentVisualizerActions->MapAction( Commands.VisualizeRollAndScale, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnSetVisualizeRollAndScale), FCanExecuteAction(), FIsActionChecked::CreateSP(this, &FSplineComponentVisualizer::IsVisualizingRollAndScale)); SplineComponentVisualizerActions->MapAction( Commands.DiscontinuousSpline, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnSetDiscontinuousSpline), FCanExecuteAction(), FIsActionChecked::CreateSP(this, &FSplineComponentVisualizer::IsDiscontinuousSpline)); SplineComponentVisualizerActions->MapAction( Commands.ResetToDefault, FExecuteAction::CreateSP(this, &FSplineComponentVisualizer::OnResetToDefault), FCanExecuteAction::CreateSP(this, &FSplineComponentVisualizer::CanResetToDefault)); } FSplineComponentVisualizer::~FSplineComponentVisualizer() { FSplineComponentVisualizerCommands::Unregister(); } static float GetDashSize(const FSceneView* View, const FVector& Start, const FVector& End, float Scale) { const float StartW = View->WorldToScreen(Start).W; const float EndW = View->WorldToScreen(End).W; const float WLimit = 10.0f; if (StartW > WLimit || EndW > WLimit) { return FMath::Max(StartW, EndW) * Scale; } return 0.0f; } void FSplineComponentVisualizer::DrawVisualization(const UActorComponent* Component, const FSceneView* View, FPrimitiveDrawInterface* PDI) { if (const USplineComponent* SplineComp = Cast(Component)) { const FInterpCurveVector& SplineInfo = SplineComp->GetSplinePointsPosition(); const USplineComponent* EditedSplineComp = GetEditedSplineComponent(); const USplineComponent* Archetype = CastChecked(SplineComp->GetArchetype()); const bool bIsSplineEditable = !SplineComp->bModifiedByConstructionScript; // bSplineHasBeenEdited || SplineInfo == Archetype->SplineCurves.Position || SplineComp->bInputSplinePointsToConstructionScript; const FColor ReadOnlyColor = FColor(255, 0, 255, 255); const FColor NormalColor = bIsSplineEditable ? FColor(SplineComp->EditorUnselectedSplineSegmentColor.ToFColor(true)) : ReadOnlyColor; const FColor SelectedColor = bIsSplineEditable ? FColor(SplineComp->EditorSelectedSplineSegmentColor.ToFColor(true)) : ReadOnlyColor; const float GrabHandleSize = 12.0f; const float TangentHandleSize = 10.0f; // Draw the tangent handles before anything else so they will not overdraw the rest of the spline if (SplineComp == EditedSplineComp) { for (int32 SelectedKey : SelectedKeys) { if (SplineInfo.Points[SelectedKey].IsCurveKey()) { const FVector Location = SplineComp->GetLocationAtSplinePoint(SelectedKey, ESplineCoordinateSpace::World); const FVector LeaveTangent = SplineComp->GetLeaveTangentAtSplinePoint(SelectedKey, ESplineCoordinateSpace::World); const FVector ArriveTangent = SplineComp->bAllowDiscontinuousSpline ? SplineComp->GetArriveTangentAtSplinePoint(SelectedKey, ESplineCoordinateSpace::World) : LeaveTangent; PDI->SetHitProxy(NULL); const float DashSize1 = GetDashSize(View, Location, Location + LeaveTangent, 0.01f); if (DashSize1 > 0.0f) { DrawDashedLine(PDI, Location, Location + LeaveTangent, SelectedColor, DashSize1, SDPG_Foreground); } const float DashSize2 = GetDashSize(View, Location, Location - ArriveTangent, 0.01f); if (DashSize2 > 0.0f) { DrawDashedLine(PDI, Location, Location - ArriveTangent, SelectedColor, DashSize2, SDPG_Foreground); } if (bIsSplineEditable) { PDI->SetHitProxy(new HSplineTangentHandleProxy(Component, SelectedKey, false)); } PDI->DrawPoint(Location + LeaveTangent, SelectedColor, TangentHandleSize, SDPG_Foreground); if (bIsSplineEditable) { PDI->SetHitProxy(new HSplineTangentHandleProxy(Component, SelectedKey, true)); } PDI->DrawPoint(Location - ArriveTangent, SelectedColor, TangentHandleSize, SDPG_Foreground); PDI->SetHitProxy(NULL); } } } const bool bShouldVisualizeScale = SplineComp->bShouldVisualizeScale; const float DefaultScale = SplineComp->ScaleVisualizationWidth; FVector OldKeyPos(0); FVector OldKeyRightVector(0); FVector OldKeyScale(0); const int32 NumPoints = SplineInfo.Points.Num(); const int32 NumSegments = SplineInfo.bIsLooped ? NumPoints : NumPoints - 1; for (int32 KeyIdx = 0; KeyIdx < NumSegments + 1; KeyIdx++) { const FVector NewKeyPos = SplineComp->GetLocationAtSplinePoint(KeyIdx, ESplineCoordinateSpace::World); const FVector NewKeyRightVector = SplineComp->GetRightVectorAtSplinePoint(KeyIdx, ESplineCoordinateSpace::World); const FVector NewKeyUpVector = SplineComp->GetUpVectorAtSplinePoint(KeyIdx, ESplineCoordinateSpace::World); const FVector NewKeyScale = SplineComp->GetScaleAtSplinePoint(KeyIdx) * DefaultScale; const FColor KeyColor = (SplineComp == EditedSplineComp && SelectedKeys.Contains(KeyIdx)) ? SelectedColor : NormalColor; // Draw the keypoint and up/right vectors if (KeyIdx < NumPoints) { if (bShouldVisualizeScale) { PDI->SetHitProxy(NULL); PDI->DrawLine(NewKeyPos, NewKeyPos - NewKeyRightVector * NewKeyScale.Y, KeyColor, SDPG_Foreground); PDI->DrawLine(NewKeyPos, NewKeyPos + NewKeyRightVector * NewKeyScale.Y, KeyColor, SDPG_Foreground); PDI->DrawLine(NewKeyPos, NewKeyPos + NewKeyUpVector * NewKeyScale.Z, KeyColor, SDPG_Foreground); const int32 ArcPoints = 20; FVector OldArcPos = NewKeyPos + NewKeyRightVector * NewKeyScale.Y; for (int32 ArcIndex = 1; ArcIndex <= ArcPoints; ArcIndex++) { float Sin; float Cos; FMath::SinCos(&Sin, &Cos, ArcIndex * PI / ArcPoints); const FVector NewArcPos = NewKeyPos + Cos * NewKeyRightVector * NewKeyScale.Y + Sin * NewKeyUpVector * NewKeyScale.Z; PDI->DrawLine(OldArcPos, NewArcPos, KeyColor, SDPG_Foreground); OldArcPos = NewArcPos; } } if (bIsSplineEditable) { PDI->SetHitProxy(new HSplineKeyProxy(Component, KeyIdx)); } PDI->DrawPoint(NewKeyPos, KeyColor, GrabHandleSize, SDPG_Foreground); PDI->SetHitProxy(NULL); } // If not the first keypoint, draw a line to the previous keypoint. if (KeyIdx > 0) { const FColor LineColor = (SplineComp == EditedSplineComp && SelectedKeys.Contains(KeyIdx - 1)) ? SelectedColor : NormalColor; if (bIsSplineEditable) { PDI->SetHitProxy(new HSplineSegmentProxy(Component, KeyIdx - 1)); } // For constant interpolation - don't draw ticks - just draw dotted line. if (SplineInfo.Points[KeyIdx - 1].InterpMode == CIM_Constant) { const float DashSize = GetDashSize(View, OldKeyPos, NewKeyPos, 0.03f); if (DashSize > 0.0f) { DrawDashedLine(PDI, OldKeyPos, NewKeyPos, LineColor, DashSize, SDPG_World); } } else { // Find position on first keyframe. FVector OldPos = OldKeyPos; FVector OldRightVector = OldKeyRightVector; FVector OldScale = OldKeyScale; // Then draw a line for each substep. const int32 NumSteps = 20; for (int32 StepIdx = 1; StepIdx <= NumSteps; StepIdx++) { const float Key = (KeyIdx - 1) + (StepIdx / static_cast(NumSteps)); const FVector NewPos = SplineComp->GetLocationAtSplineInputKey(Key, ESplineCoordinateSpace::World); const FVector NewRightVector = SplineComp->GetRightVectorAtSplineInputKey(Key, ESplineCoordinateSpace::World); const FVector NewScale = SplineComp->GetScaleAtSplineInputKey(Key) * DefaultScale; PDI->DrawLine(OldPos, NewPos, LineColor, SDPG_Foreground); if (bShouldVisualizeScale) { PDI->DrawLine(OldPos - OldRightVector * OldScale.Y, NewPos - NewRightVector * NewScale.Y, LineColor, SDPG_Foreground); PDI->DrawLine(OldPos + OldRightVector * OldScale.Y, NewPos + NewRightVector * NewScale.Y, LineColor, SDPG_Foreground); #if VISUALIZE_SPLINE_UPVECTORS const FVector NewUpVector = SplineComp->GetUpVectorAtSplineInputKey(Key, ESplineCoordinateSpace::World); PDI->DrawLine(NewPos, NewPos + NewUpVector * SplineComp->ScaleVisualizationWidth * 0.5f, LineColor, SDPG_Foreground); PDI->DrawLine(NewPos, NewPos + NewRightVector * SplineComp->ScaleVisualizationWidth * 0.5f, LineColor, SDPG_Foreground); #endif } OldPos = NewPos; OldRightVector = NewRightVector; OldScale = NewScale; } } PDI->SetHitProxy(NULL); } OldKeyPos = NewKeyPos; OldKeyRightVector = NewKeyRightVector; OldKeyScale = NewKeyScale; } } } void FSplineComponentVisualizer::ChangeSelectionState(int32 Index, bool bIsCtrlHeld) { if (Index == INDEX_NONE) { SelectedKeys.Empty(); LastKeyIndexSelected = INDEX_NONE; } else if (!bIsCtrlHeld) { SelectedKeys.Empty(); SelectedKeys.Add(Index); LastKeyIndexSelected = Index; } else { // Add or remove from selection if Ctrl is held if (SelectedKeys.Contains(Index)) { // If already in selection, toggle it off SelectedKeys.Remove(Index); if (LastKeyIndexSelected == Index) { if (SelectedKeys.Num() == 0) { // Last key selected: clear last key index selected LastKeyIndexSelected = INDEX_NONE; } else { // Arbitarily set last key index selected to first member of the set (so that it is valid) LastKeyIndexSelected = *SelectedKeys.CreateConstIterator(); } } } else { // Add to selection SelectedKeys.Add(Index); LastKeyIndexSelected = Index; } } } bool FSplineComponentVisualizer::VisProxyHandleClick(FEditorViewportClient* InViewportClient, HComponentVisProxy* VisProxy, const FViewportClick& Click) { if(VisProxy && VisProxy->Component.IsValid()) { const USplineComponent* SplineComp = CastChecked(VisProxy->Component.Get()); SplineCompPropName = GetComponentPropertyName(SplineComp); if(SplineCompPropName.IsValid()) { AActor* OldSplineOwningActor = SplineOwningActor.Get(); SplineOwningActor = SplineComp->GetOwner(); if (OldSplineOwningActor != SplineOwningActor) { // Reset selection state if we are selecting a different actor to the one previously selected ChangeSelectionState(INDEX_NONE, false); SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; } if (VisProxy->IsA(HSplineKeyProxy::StaticGetType())) { // Control point clicked HSplineKeyProxy* KeyProxy = (HSplineKeyProxy*)VisProxy; // Modify the selection state, unless right-clicking on an already selected key if (Click.GetKey() != EKeys::RightMouseButton || !SelectedKeys.Contains(KeyProxy->KeyIndex)) { ChangeSelectionState(KeyProxy->KeyIndex, InViewportClient->IsCtrlPressed()); } SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; if (LastKeyIndexSelected == INDEX_NONE) { SplineOwningActor = nullptr; return false; } CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); return true; } else if (VisProxy->IsA(HSplineSegmentProxy::StaticGetType())) { // Spline segment clicked // Divide segment into subsegments and test each subsegment against ray representing click position and camera direction. // Closest encounter with the spline determines the spline position. const int32 NumSubdivisions = 16; HSplineSegmentProxy* SegmentProxy = (HSplineSegmentProxy*)VisProxy; ChangeSelectionState(SegmentProxy->SegmentIndex, InViewportClient->IsCtrlPressed()); SelectedSegmentIndex = SegmentProxy->SegmentIndex; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; if (LastKeyIndexSelected == INDEX_NONE) { SplineOwningActor = nullptr; return false; } CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); float SubsegmentStartKey = static_cast(SelectedSegmentIndex); FVector SubsegmentStart = SplineComp->GetLocationAtSplineInputKey(SubsegmentStartKey, ESplineCoordinateSpace::World); float ClosestDistance = TNumericLimits::Max(); FVector BestLocation = SubsegmentStart; for (int32 Step = 1; Step < NumSubdivisions; Step++) { const float SubsegmentEndKey = SelectedSegmentIndex + Step / static_cast(NumSubdivisions); const FVector SubsegmentEnd = SplineComp->GetLocationAtSplineInputKey(SubsegmentEndKey, ESplineCoordinateSpace::World); FVector SplineClosest; FVector RayClosest; FMath::SegmentDistToSegmentSafe(SubsegmentStart, SubsegmentEnd, Click.GetOrigin(), Click.GetOrigin() + Click.GetDirection() * 50000.0f, SplineClosest, RayClosest); const float Distance = FVector::DistSquared(SplineClosest, RayClosest); if (Distance < ClosestDistance) { ClosestDistance = Distance; BestLocation = SplineClosest; } SubsegmentStartKey = SubsegmentEndKey; SubsegmentStart = SubsegmentEnd; } SelectedSplinePosition = BestLocation; return true; } else if (VisProxy->IsA(HSplineTangentHandleProxy::StaticGetType())) { // Tangent handle clicked HSplineTangentHandleProxy* KeyProxy = (HSplineTangentHandleProxy*)VisProxy; // Note: don't change key selection when a tangent handle is clicked SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = KeyProxy->KeyIndex; SelectedTangentHandleType = KeyProxy->bArriveTangent ? ESelectedTangentHandle::Arrive : ESelectedTangentHandle::Leave; CachedRotation = SplineComp->GetQuaternionAtSplinePoint(SelectedTangentHandle, ESplineCoordinateSpace::World); return true; } } else { SplineOwningActor = nullptr; } } return false; } USplineComponent* FSplineComponentVisualizer::GetEditedSplineComponent() const { return Cast(GetComponentFromPropertyName(SplineOwningActor.Get(), SplineCompPropName)); } bool FSplineComponentVisualizer::GetWidgetLocation(const FEditorViewportClient* ViewportClient, FVector& OutLocation) const { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { const FInterpCurveVector& Position = SplineComp->GetSplinePointsPosition(); if (SelectedTangentHandle != INDEX_NONE) { // If tangent handle index is set, use that check(SelectedTangentHandle < Position.Points.Num()); const auto& Point = Position.Points[SelectedTangentHandle]; check(SelectedTangentHandleType != ESelectedTangentHandle::None); if (SelectedTangentHandleType == ESelectedTangentHandle::Leave) { OutLocation = SplineComp->GetComponentTransform().TransformPosition(Point.OutVal + Point.LeaveTangent); } else if (SelectedTangentHandleType == ESelectedTangentHandle::Arrive) { OutLocation = SplineComp->GetComponentTransform().TransformPosition(Point.OutVal - Point.ArriveTangent); } return true; } else if (LastKeyIndexSelected != INDEX_NONE) { // Otherwise use the last key index set check(LastKeyIndexSelected < Position.Points.Num()); check(SelectedKeys.Contains(LastKeyIndexSelected)); const auto& Point = Position.Points[LastKeyIndexSelected]; OutLocation = SplineComp->GetComponentTransform().TransformPosition(Point.OutVal); return true; } } return false; } bool FSplineComponentVisualizer::GetCustomInputCoordinateSystem(const FEditorViewportClient* ViewportClient, FMatrix& OutMatrix) const { if (ViewportClient->GetWidgetCoordSystemSpace() == COORD_Local || ViewportClient->GetWidgetMode() == FWidget::WM_Rotate) { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { OutMatrix = FRotationMatrix::Make(CachedRotation); return true; } } return false; } bool FSplineComponentVisualizer::IsVisualizingArchetype() const { USplineComponent* SplineComp = GetEditedSplineComponent(); return (SplineComp && SplineComp->GetOwner() && FActorEditorUtils::IsAPreviewOrInactiveActor(SplineComp->GetOwner())); } bool FSplineComponentVisualizer::HandleInputDelta(FEditorViewportClient* ViewportClient, FViewport* Viewport, FVector& DeltaTranslate, FRotator& DeltaRotate, FVector& DeltaScale) { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { FInterpCurveVector& SplinePosition = SplineComp->GetSplinePointsPosition(); FInterpCurveQuat& SplineRotation = SplineComp->GetSplinePointsRotation(); FInterpCurveVector& SplineScale = SplineComp->GetSplinePointsScale(); const int32 NumPoints = SplinePosition.Points.Num(); if (SelectedTangentHandle != INDEX_NONE) { // When tangent handles are manipulated... check(SelectedTangentHandle < NumPoints); if (!DeltaTranslate.IsZero()) { check(SelectedTangentHandleType != ESelectedTangentHandle::None); SplineComp->Modify(); FInterpCurvePoint& EditedPoint = SplinePosition.Points[SelectedTangentHandle]; if (SplineComp->bAllowDiscontinuousSpline) { if (SelectedTangentHandleType == ESelectedTangentHandle::Leave) { EditedPoint.LeaveTangent += SplineComp->GetComponentTransform().InverseTransformVector(DeltaTranslate); } else { EditedPoint.ArriveTangent += SplineComp->GetComponentTransform().InverseTransformVector(-DeltaTranslate); } } else { const FVector Delta = (SelectedTangentHandleType == ESelectedTangentHandle::Leave) ? DeltaTranslate : -DeltaTranslate; const FVector Tangent = EditedPoint.LeaveTangent + SplineComp->GetComponentTransform().InverseTransformVector(Delta); EditedPoint.LeaveTangent = Tangent; EditedPoint.ArriveTangent = Tangent; } EditedPoint.InterpMode = CIM_CurveUser; } } else { // When spline keys are manipulated... check(LastKeyIndexSelected != INDEX_NONE); check(LastKeyIndexSelected < NumPoints); check(SelectedKeys.Num() > 0); SplineComp->Modify(); if (ViewportClient->IsAltPressed() && bAllowDuplication) { DuplicateKey(); // Don't duplicate again until we release LMB bAllowDuplication = false; } for (int32 SelectedKeyIndex : SelectedKeys) { FInterpCurvePoint& EditedPoint = SplinePosition.Points[SelectedKeyIndex]; FInterpCurvePoint& EditedRotPoint = SplineRotation.Points[SelectedKeyIndex]; FInterpCurvePoint& EditedScalePoint = SplineScale.Points[SelectedKeyIndex]; if (!DeltaTranslate.IsZero()) { // Find key position in world space const FVector CurrentWorldPos = SplineComp->GetComponentTransform().TransformPosition(EditedPoint.OutVal); // Move in world space const FVector NewWorldPos = CurrentWorldPos + DeltaTranslate; // Convert back to local space EditedPoint.OutVal = SplineComp->GetComponentTransform().InverseTransformPosition(NewWorldPos); } if (!DeltaRotate.IsZero()) { // Set point tangent as user controlled EditedPoint.InterpMode = CIM_CurveUser; // Rotate tangent according to delta rotation FVector NewTangent = SplineComp->GetComponentTransform().GetRotation().RotateVector(EditedPoint.LeaveTangent); // convert local-space tangent vector to world-space NewTangent = DeltaRotate.RotateVector(NewTangent); // apply world-space delta rotation to world-space tangent NewTangent = SplineComp->GetComponentTransform().GetRotation().Inverse().RotateVector(NewTangent); // convert world-space tangent vector back into local-space EditedPoint.LeaveTangent = NewTangent; EditedPoint.ArriveTangent = NewTangent; // Rotate spline rotation according to delta rotation FQuat NewRot = SplineComp->GetComponentTransform().GetRotation() * EditedRotPoint.OutVal; // convert local-space rotation to world-space NewRot = DeltaRotate.Quaternion() * NewRot; // apply world-space rotation NewRot = SplineComp->GetComponentTransform().GetRotation().Inverse() * NewRot; // convert world-space rotation to local-space EditedRotPoint.OutVal = NewRot; } if (DeltaScale.X != 0.0f) { // Set point tangent as user controlled EditedPoint.InterpMode = CIM_CurveUser; const FVector NewTangent = EditedPoint.LeaveTangent * (1.0f + DeltaScale.X); EditedPoint.LeaveTangent = NewTangent; EditedPoint.ArriveTangent = NewTangent; } if (DeltaScale.Y != 0.0f) { // Scale in Y adjusts the scale spline EditedScalePoint.OutVal.Y *= (1.0f + DeltaScale.Y); } if (DeltaScale.Z != 0.0f) { // Scale in Z adjusts the scale spline EditedScalePoint.OutVal.Z *= (1.0f + DeltaScale.Z); } } } SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); return true; } return false; } bool FSplineComponentVisualizer::HandleInputKey(FEditorViewportClient* ViewportClient, FViewport* Viewport, FKey Key, EInputEvent Event) { bool bHandled = false; if (Key == EKeys::LeftMouseButton && Event == IE_Released) { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { // Recache widget rotation int32 Index = SelectedTangentHandle; if (Index == INDEX_NONE) { // If not set, fall back to last key index selected Index = LastKeyIndexSelected; } CachedRotation = SplineComp->GetQuaternionAtSplinePoint(Index, ESplineCoordinateSpace::World); } // Reset duplication flag on LMB release bAllowDuplication = true; } if (Event == IE_Pressed) { bHandled = SplineComponentVisualizerActions->ProcessCommandBindings(Key, FSlateApplication::Get().GetModifierKeys(), false); } return bHandled; } void FSplineComponentVisualizer::EndEditing() { SplineOwningActor = NULL; SplineCompPropName.Clear(); ChangeSelectionState(INDEX_NONE, false); SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; } void FSplineComponentVisualizer::OnDuplicateKey() { const FScopedTransaction Transaction(LOCTEXT("DuplicateSplinePoint", "Duplicate Spline Point")); USplineComponent* SplineComp = GetEditedSplineComponent(); DuplicateKey(); SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); } void FSplineComponentVisualizer::DuplicateKey() { USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); check(LastKeyIndexSelected != INDEX_NONE); check(SelectedKeys.Num() > 0); check(SelectedKeys.Contains(LastKeyIndexSelected)); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } // Get a sorted list of all the selected indices, highest to lowest TArray SelectedKeysSorted; for (int32 SelectedKeyIndex : SelectedKeys) { SelectedKeysSorted.Add(SelectedKeyIndex); } SelectedKeysSorted.Sort([](int32 A, int32 B) { return A > B; }); // Insert duplicates into the list, highest index first, so that the lower indices remain the same FInterpCurveVector& SplinePosition = SplineComp->SplineCurves.Position; FInterpCurveQuat& SplineRotation = SplineComp->SplineCurves.Rotation; FInterpCurveVector& SplineScale = SplineComp->SplineCurves.Scale; for (int32 SelectedKeyIndex : SelectedKeysSorted) { // Insert duplicates into arrays. // It's necessary to take a copy because copying existing array items by reference isn't allowed (the array may reallocate) SplinePosition.Points.Insert(FInterpCurvePoint(SplinePosition.Points[SelectedKeyIndex]), SelectedKeyIndex); SplineRotation.Points.Insert(FInterpCurvePoint(SplineRotation.Points[SelectedKeyIndex]), SelectedKeyIndex); SplineScale.Points.Insert(FInterpCurvePoint(SplineScale.Points[SelectedKeyIndex]), SelectedKeyIndex); // Adjust input keys of subsequent points for (int Index = SelectedKeyIndex + 1; Index < SplinePosition.Points.Num(); Index++) { SplinePosition.Points[Index].InVal += 1.0f; SplineRotation.Points[Index].InVal += 1.0f; SplineScale.Points[Index].InVal += 1.0f; } } // Repopulate the selected keys SelectedKeys.Empty(); int32 Offset = SelectedKeysSorted.Num(); for (int32 SelectedKeyIndex : SelectedKeysSorted) { SelectedKeys.Add(SelectedKeyIndex + Offset); if (LastKeyIndexSelected == SelectedKeyIndex) { LastKeyIndexSelected += Offset; } Offset--; } // Unset tangent handle selection SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; GEditor->RedrawLevelEditingViewports(true); } bool FSplineComponentVisualizer::CanAddKey() const { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp == nullptr) { return false; } const int32 NumPoints = SplineComp->SplineCurves.Position.Points.Num(); const int32 NumSegments = SplineComp->IsClosedLoop() ? NumPoints : NumPoints - 1; return (SelectedSegmentIndex != INDEX_NONE && SelectedSegmentIndex < NumSegments); } void FSplineComponentVisualizer::OnAddKey() { const FScopedTransaction Transaction(LOCTEXT("AddSplinePoint", "Add Spline Point")); USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); check(LastKeyIndexSelected != INDEX_NONE); check(SelectedKeys.Num() > 0); check(SelectedKeys.Contains(LastKeyIndexSelected)); check(SelectedTangentHandle == INDEX_NONE); check(SelectedTangentHandleType == ESelectedTangentHandle::None); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } FInterpCurveVector& SplinePosition = SplineComp->GetSplinePointsPosition(); FInterpCurveQuat& SplineRotation = SplineComp->GetSplinePointsRotation(); FInterpCurveVector& SplineScale = SplineComp->GetSplinePointsScale(); FInterpCurvePoint NewPoint( SelectedSegmentIndex, SplineComp->GetComponentTransform().InverseTransformPosition(SelectedSplinePosition), FVector::ZeroVector, FVector::ZeroVector, CIM_CurveAuto); FInterpCurvePoint NewRotPoint( SelectedSegmentIndex, FQuat::Identity, FQuat::Identity, FQuat::Identity, CIM_CurveAuto); FInterpCurvePoint NewScalePoint( SelectedSegmentIndex, FVector(1.0f), FVector::ZeroVector, FVector::ZeroVector, CIM_CurveAuto); SplinePosition.Points.Insert(NewPoint, SelectedSegmentIndex + 1); SplineRotation.Points.Insert(NewRotPoint, SelectedSegmentIndex + 1); SplineScale.Points.Insert(NewScalePoint, SelectedSegmentIndex + 1); // Adjust input keys of subsequent points for (int Index = SelectedSegmentIndex + 1; Index < SplinePosition.Points.Num(); Index++) { SplinePosition.Points[Index].InVal += 1.0f; SplineRotation.Points[Index].InVal += 1.0f; SplineScale.Points[Index].InVal += 1.0f; } // Set selection to 'next' key ChangeSelectionState(SelectedSegmentIndex + 1, false); SelectedSegmentIndex = INDEX_NONE; SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); GEditor->RedrawLevelEditingViewports(true); } void FSplineComponentVisualizer::OnDeleteKey() { const FScopedTransaction Transaction(LOCTEXT("DeleteSplinePoint", "Delete Spline Point")); USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); check(LastKeyIndexSelected != INDEX_NONE); check(SelectedKeys.Num() > 0); check(SelectedKeys.Contains(LastKeyIndexSelected)); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } // Get a sorted list of all the selected indices, highest to lowest TArray SelectedKeysSorted; for (int32 SelectedKeyIndex : SelectedKeys) { SelectedKeysSorted.Add(SelectedKeyIndex); } SelectedKeysSorted.Sort([](int32 A, int32 B) { return A > B; }); // Delete selected keys from list, highest index first FInterpCurveVector& SplinePosition = SplineComp->SplineCurves.Position; FInterpCurveQuat& SplineRotation = SplineComp->SplineCurves.Rotation; FInterpCurveVector& SplineScale = SplineComp->SplineCurves.Scale; for (int32 SelectedKeyIndex : SelectedKeysSorted) { SplinePosition.Points.RemoveAt(SelectedKeyIndex); SplineRotation.Points.RemoveAt(SelectedKeyIndex); SplineScale.Points.RemoveAt(SelectedKeyIndex); for (int Index = SelectedKeyIndex; Index < SplinePosition.Points.Num(); Index++) { SplinePosition.Points[Index].InVal -= 1.0f; SplineRotation.Points[Index].InVal -= 1.0f; SplineScale.Points[Index].InVal -= 1.0f; } } // Select first key ChangeSelectionState(0, false); SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); GEditor->RedrawLevelEditingViewports(true); } bool FSplineComponentVisualizer::CanDeleteKey() const { USplineComponent* SplineComp = GetEditedSplineComponent(); return (SplineComp != nullptr && SelectedKeys.Num() > 0 && SelectedKeys.Num() != SplineComp->SplineCurves.Position.Points.Num() && LastKeyIndexSelected != INDEX_NONE); } bool FSplineComponentVisualizer::IsKeySelectionValid() const { USplineComponent* SplineComp = GetEditedSplineComponent(); return (SplineComp != nullptr && SelectedKeys.Num() > 0 && LastKeyIndexSelected != INDEX_NONE); } void FSplineComponentVisualizer::OnResetToAutomaticTangent(EInterpCurveMode Mode) { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { const FScopedTransaction Transaction(LOCTEXT("ResetToAutomaticTangent", "Reset to Automatic Tangent")); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } for (int32 SelectedKeyIndex : SelectedKeys) { auto& Point = SplineComp->SplineCurves.Position.Points[SelectedKeyIndex]; if (Point.IsCurveKey()) { Point.InterpMode = Mode; } } SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); } } bool FSplineComponentVisualizer::CanResetToAutomaticTangent(EInterpCurveMode Mode) const { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr && LastKeyIndexSelected != INDEX_NONE) { for (int32 SelectedKeyIndex : SelectedKeys) { const auto& Point = SplineComp->SplineCurves.Position.Points[SelectedKeyIndex]; if (Point.IsCurveKey() && Point.InterpMode != Mode) { return true; } } } return false; } void FSplineComponentVisualizer::OnSetKeyType(EInterpCurveMode Mode) { USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { const FScopedTransaction Transaction(LOCTEXT("SetSplinePointType", "Set Spline Point Type")); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } for (int32 SelectedKeyIndex : SelectedKeys) { SplineComp->SplineCurves.Position.Points[SelectedKeyIndex].InterpMode = Mode; } SplineComp->UpdateSpline(); SplineComp->bSplineHasBeenEdited = true; NotifyPropertyModified(SplineComp, SplineCurvesProperty); CachedRotation = SplineComp->GetQuaternionAtSplinePoint(LastKeyIndexSelected, ESplineCoordinateSpace::World); } } bool FSplineComponentVisualizer::IsKeyTypeSet(EInterpCurveMode Mode) const { if (IsKeySelectionValid()) { USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); for (int32 SelectedKeyIndex : SelectedKeys) { const auto& SelectedPoint = SplineComp->SplineCurves.Position.Points[SelectedKeyIndex]; if ((Mode == CIM_CurveAuto && SelectedPoint.IsCurveKey()) || SelectedPoint.InterpMode == Mode) { return true; } } } return false; } void FSplineComponentVisualizer::OnSetVisualizeRollAndScale() { USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } SplineComp->bShouldVisualizeScale = !SplineComp->bShouldVisualizeScale; NotifyPropertyModified(SplineComp, FindField(USplineComponent::StaticClass(), GET_MEMBER_NAME_CHECKED(USplineComponent, bShouldVisualizeScale))); GEditor->RedrawLevelEditingViewports(true); } bool FSplineComponentVisualizer::IsVisualizingRollAndScale() const { USplineComponent* SplineComp = GetEditedSplineComponent(); return SplineComp ? SplineComp->bShouldVisualizeScale : false; } void FSplineComponentVisualizer::OnSetDiscontinuousSpline() { USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); SplineComp->Modify(); if (AActor* Owner = SplineComp->GetOwner()) { Owner->Modify(); } SplineComp->bAllowDiscontinuousSpline = !SplineComp->bAllowDiscontinuousSpline; // If not allowed discontinuous splines, set all ArriveTangents to match LeaveTangents if (!SplineComp->bAllowDiscontinuousSpline) { for (int Index = 0; Index < SplineComp->SplineCurves.Position.Points.Num(); Index++) { SplineComp->SplineCurves.Position.Points[Index].ArriveTangent = SplineComp->SplineCurves.Position.Points[Index].LeaveTangent; } } TArray Properties; Properties.Add(SplineCurvesProperty); Properties.Add(FindField(USplineComponent::StaticClass(), GET_MEMBER_NAME_CHECKED(USplineComponent, bAllowDiscontinuousSpline))); NotifyPropertiesModified(SplineComp, Properties); GEditor->RedrawLevelEditingViewports(true); } bool FSplineComponentVisualizer::IsDiscontinuousSpline() const { USplineComponent* SplineComp = GetEditedSplineComponent(); return SplineComp ? SplineComp->bAllowDiscontinuousSpline : false; } void FSplineComponentVisualizer::OnResetToDefault() { USplineComponent* SplineComp = GetEditedSplineComponent(); check(SplineComp != nullptr); const FScopedTransaction Transaction(LOCTEXT("ResetToDefault", "Reset to Default")); SplineComp->Modify(); if (SplineOwningActor.IsValid()) { SplineOwningActor.Get()->Modify(); } SplineComp->bSplineHasBeenEdited = false; // Select first key ChangeSelectionState(0, false); SelectedSegmentIndex = INDEX_NONE; SelectedTangentHandle = INDEX_NONE; SelectedTangentHandleType = ESelectedTangentHandle::None; if (SplineOwningActor.IsValid()) { SplineOwningActor.Get()->PostEditMove(false); } GEditor->RedrawLevelEditingViewports(true); } bool FSplineComponentVisualizer::CanResetToDefault() const { USplineComponent* SplineComp = GetEditedSplineComponent(); if(SplineComp != nullptr) { return SplineComp->SplineCurves != CastChecked(SplineComp->GetArchetype())->SplineCurves; } else { return false; } } TSharedPtr FSplineComponentVisualizer::GenerateContextMenu() const { FMenuBuilder MenuBuilder(true, SplineComponentVisualizerActions); { MenuBuilder.BeginSection("SplinePointEdit", LOCTEXT("SplinePoint", "Spline Point")); { if (SelectedSegmentIndex != INDEX_NONE) { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().AddKey); } else if (LastKeyIndexSelected != INDEX_NONE) { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().DeleteKey); MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().DuplicateKey); MenuBuilder.AddSubMenu( LOCTEXT("SplinePointType", "Spline Point Type"), LOCTEXT("KeyTypeTooltip", "Define the type of the spline point."), FNewMenuDelegate::CreateSP(this, &FSplineComponentVisualizer::GenerateSplinePointTypeSubMenu)); // Only add the Automatic Tangents submenu if any of the keys is a curve type USplineComponent* SplineComp = GetEditedSplineComponent(); if (SplineComp != nullptr) { for (int32 SelectedKeyIndex : SelectedKeys) { const auto& Point = SplineComp->SplineCurves.Position.Points[SelectedKeyIndex]; if (Point.IsCurveKey()) { MenuBuilder.AddSubMenu( LOCTEXT("ResetToAutomaticTangent", "Reset to Automatic Tangent"), LOCTEXT("ResetToAutomaticTangentTooltip", "Reset the spline point tangent to an automatically generated value."), FNewMenuDelegate::CreateSP(this, &FSplineComponentVisualizer::GenerateTangentTypeSubMenu)); break; } } } } } MenuBuilder.EndSection(); MenuBuilder.BeginSection("Spline", LOCTEXT("Spline", "Spline")); { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().ResetToDefault); } MenuBuilder.EndSection(); MenuBuilder.BeginSection("Visualization", LOCTEXT("Visualization", "Visualization")); { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().VisualizeRollAndScale); MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().DiscontinuousSpline); } MenuBuilder.EndSection(); } TSharedPtr MenuWidget = MenuBuilder.MakeWidget(); return MenuWidget; } void FSplineComponentVisualizer::GenerateSplinePointTypeSubMenu(FMenuBuilder& MenuBuilder) const { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().SetKeyToCurve); MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().SetKeyToLinear); MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().SetKeyToConstant); } void FSplineComponentVisualizer::GenerateTangentTypeSubMenu(FMenuBuilder& MenuBuilder) const { MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().ResetToUnclampedTangent); MenuBuilder.AddMenuEntry(FSplineComponentVisualizerCommands::Get().ResetToClampedTangent); } #undef LOCTEXT_NAMESPACE