Merge branch 'dev/5.3' into '5.3'

UE5.3-2023.1-rc2

Closes #644

See merge request vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit!80

Author: davidyrgilbert

.gitlab-ci.yml

@@ -7,7 +7,7 @@
 
 include:
   - project: '${UNREAL_CI_PROJECT}'
-    ref: master 
+    ref: master
     file: '/shared_scripts.yml'
 
 # In this file you are able to configure your plugins pipeline.
@@ -36,6 +36,11 @@ include:
 #
 # You can uncomment the deploy lines to deploy your project to the CAVE/VRDev. This only makes sense, if your plugin works
 # with a generated project.
+#
+# Use the UNREAL_VERSION variable to adjust to your preferred Unreal version.
+
+variables:
+    UNREAL_VERSION: "5.3"
 
 stages:
   - analyze
@@ -58,7 +63,7 @@ clang-format:
     allow_failure: false
     script:
         - clang-format --version
-        - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME --depth 1
+        - git fetch --depth 1 origin $CI_MERGE_REQUEST_DIFF_BASE_SHA
         - echo $CI_MERGE_REQUEST_DIFF_BASE_SHA 
         - linter_errors=$(unbuffer git-clang-format --commit "$CI_MERGE_REQUEST_DIFF_BASE_SHA" *.h *.cpp -q --diff | grep -v --color=always "no modified files to format" || true)
         - echo "$linter_errors"
@@ -68,10 +73,12 @@ Generate_Project:
     rules: 
       - if: $CI_PIPELINE_SOURCE == "web"
       - if: $CI_PIPELINE_SOURCE == "schedule"
+      - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      - if: $CI_COMMIT_TAG
+      - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
     extends: .Generate_Project_
     variables:
         RUN_SETUP: "false"
-        GEN_TEMPLATE_BRANCH: "5.3"
         GEN_DEPENDENCIES: "(
             [master@UnrealDTrackPlugin]='https://github.com/VRGroupRWTH/UnrealDTrackPlugin.git')"
 
@@ -80,6 +87,9 @@ Build_Windows:
     rules: 
       - if: $CI_PIPELINE_SOURCE == "web"
       - if: $CI_PIPELINE_SOURCE == "schedule"
+      - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      - if: $CI_COMMIT_TAG
+      - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
     extends: .Build_Windows_
     tags:
         - windows
@@ -97,6 +107,9 @@ Build_Linux:
     rules: 
       - if: $CI_PIPELINE_SOURCE == "web"
       - if: $CI_PIPELINE_SOURCE == "schedule"
+      - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      - if: $CI_COMMIT_TAG
+      - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
     extends: .Build_Linux_
     tags:
         - linux
@@ -111,6 +124,7 @@ Build_Linux:
         - job: "Generate_Project"
           artifacts: true
 
+# Deploys to vrdev
 Deploy_Windows:
     rules: 
       - if: $CI_PIPELINE_SOURCE == "web"
@@ -120,6 +134,7 @@ Deploy_Windows:
         - job: "Build_Windows"
           artifacts: true          
 
+# Deploys to vrdemo instead of av006de. Use extends: .Deploy_CAVE_ to deploy to legacy av006de
 Deploy_CAVE:
     rules: 
       - if: $CI_PIPELINE_SOURCE == "web"

Config/DefaultRWTHVRToolkit.ini

@@ -4,4 +4,18 @@
 +StructRedirects = (OldName="/Script/RWTHVRToolkit.VRTransformRep",NewName="/Script/RWTHVRToolkit.ReplicatedTransform")
 +ClassRedirects = (OldName="/Script/RWTHVRToolkit.VRWidgetInteractionComponent",NewName="/Script/RWTHVRToolkit.RWTHVRWidgetInteractionComponent")
 +PropertyRedirects = (OldName="/Script/RWTHVRToolkit.RWTHVRPawn.PawnMovement",NewName="/Script/RWTHVRToolkit.RWTHVRPawn.CollisionHandlingMovement")
-+PropertyRedirects = (OldName="/Script/RWTHVRToolkit.RWTHVRPawn.PawnMovement",NewName="/Script/RWTHVRToolkit.RWTHVRPawn.CollisionHandlingMovement")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.RWTHVRPawn.PawnMovement",NewName="/Script/RWTHVRToolkit.RWTHVRPawn.CollisionHandlingMovement")
++ClassRedirects = (OldName="/Script/RWTHVRToolkit.RaycastSelectionComponent",NewName="/Script/RWTHVRToolkit.RaycastInteractionComponent")
++ClassRedirects = (OldName="/Script/RWTHVRToolkit.GrabComponent",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent")
++FunctionRedirects = (OldName="/Script/RWTHVRToolkit.RaycastInteractionComponent.OnBeginSelect",NewName="/Script/RWTHVRToolkit.RaycastInteractionComponent.OnBeginInteraction")
++FunctionRedirects = (OldName="/Script/RWTHVRToolkit.RaycastInteractionComponent.OnEndSelect",NewName="/Script/RWTHVRToolkit.RaycastInteractionComponent.OnEndInteraction")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.RaycastInteractionComponent.RayCastSelectInputAction",NewName="/Script/RWTHVRToolkit.RaycastInteractionComponent.RayCastInteractionInputAction")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.RaycastInteractionComponent.RayCastInteractionInputAction",NewName="/Script/RWTHVRToolkit.RaycastInteractionComponent.InteractionInputAction")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.PreviousGrabbablesInRange",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.PreviousInteractableComponentsInRange")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.GrabInputAction",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.InteractionInputAction")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.GrabSphereRadius",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.InteractionSphereRadius")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.bOnlyGrabClosestActor",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.bOnlyInteractWithClosestActor")
++FunctionRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.OnBeginGrab",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.OnBeginInteraction")
++FunctionRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.OnEndGrab",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.OnEndInteraction")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.PreviousGrabBehavioursInRange",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.PreviousInteractableComponentsInRange")
++PropertyRedirects = (OldName="/Script/RWTHVRToolkit.DirectInteractionComponent.CurrentGrabBehavioursInRange",NewName="/Script/RWTHVRToolkit.DirectInteractionComponent.CurrentInteractableComponentsInRange")

Content/BP_RWTHVRGameModeBase.uasset

@@ -2,7 +2,6 @@
 
 #include "CoreMinimal.h"
 #include "EnhancedInputComponent.h"
-#include "EnhancedInputSubsystems.h"
 #include "IDisplayCluster.h"
 #include "MotionControllerComponent.h"
 #include "Camera/CameraComponent.h"
@@ -165,7 +164,7 @@ void ACAVEOverlayController::BeginPlay()
 	// Input config
 	if (URWTHVRUtilities::IsPrimaryNode())
 	{
-		if (CycleDoorTypeInputAction == nullptr || IMCCaveOverlayInputMapping == nullptr)
+		if (CycleDoorTypeInputAction == nullptr)
 		{
 			UE_LOGFMT(LogCAVEOverlay, Error, "Input action and mapping not set in CaveOverlayController!");
 			return;
@@ -174,15 +173,6 @@ void ACAVEOverlayController::BeginPlay()
 		UEnhancedInputComponent* Input = Cast<UEnhancedInputComponent>(PC->InputComponent);
 		Input->BindAction(CycleDoorTypeInputAction, ETriggerEvent::Triggered, this,
 						  &ACAVEOverlayController::CycleDoorType);
-
-		if (const ULocalPlayer* LocalPlayer = PC->GetLocalPlayer())
-		{
-			if (UEnhancedInputLocalPlayerSubsystem* InputSystem =
-					LocalPlayer->GetSubsystem<UEnhancedInputLocalPlayerSubsystem>())
-			{
-				InputSystem->AddMappingContext(IMCCaveOverlayInputMapping, 0);
-			}
-		}
 	}
 
 	// Bind the cluster events that manage the door state.

Content/BP_RWTHVRPawn.uasset

@@ -128,9 +128,6 @@ class RWTHVRCLUSTER_API ACAVEOverlayController : public AActor
 	UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "CAVEOverlay")
 	UInputAction* CycleDoorTypeInputAction;
 
-	UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "CAVEOverlay")
-	UInputMappingContext* IMCCaveOverlayInputMapping;
-
 	UPROPERTY()
 	UDoorOverlayData* Overlay;
 

Content/Components/DirectInteraction/BP_DirectInteractionComponent.uasset

@@ -3,8 +3,9 @@
 
 #include "Interaction/Interactables/GrabBehavior.h"
 #include "Interaction/Interactables/InteractableComponent.h"
-#include "Kismet/GameplayStatics.h"
+#include "Logging/StructuredLog.h"
 #include "Serialization/JsonTypes.h"
+#include "Utility/RWTHVRUtilities.h"
 
 UPrimitiveComponent* UGrabBehavior::GetFirstComponentSimulatingPhysics(const AActor* TargetActor)
 {
@@ -29,34 +30,42 @@ UPrimitiveComponent* UGrabBehavior::GetHighestParentSimulatingPhysics(UPrimitive
 	{
 		return GetHighestParentSimulatingPhysics(Cast<UPrimitiveComponent>(Comp->GetAttachParent()));
 	}
-	else
-	{
-		return Comp;
-	}
+
+	return Comp;
 }
 
 void UGrabBehavior::OnActionStart(USceneComponent* TriggeredComponent, const UInputAction* InputAction,
 								  const FInputActionValue& Value)
 {
-	const APawn* Player = UGameplayStatics::GetPlayerPawn(GetWorld(), 0);
-
-	USceneComponent* Hand = Cast<USceneComponent>(TriggeredComponent->GetAttachParent());
+	if (bObjectGrabbed)
+	{
+		return;
+	}
 
+	USceneComponent* CurrentAttachParent = Cast<USceneComponent>(TriggeredComponent->GetAttachParent());
 	const FAttachmentTransformRules Rules = FAttachmentTransformRules(EAttachmentRule::KeepWorld, false);
 
-	MyPhysicsComponent = GetFirstComponentSimulatingPhysics(GetOwner());
-
-	if (MyPhysicsComponent)
+	if (MyPhysicsComponent = GetFirstComponentSimulatingPhysics(GetOwner()); MyPhysicsComponent != nullptr)
 	{
+		bWasSimulatingPhysics = MyPhysicsComponent->IsSimulatingPhysics();
 		MyPhysicsComponent->SetSimulatePhysics(false);
-		MyPhysicsComponent->AttachToComponent(Hand, Rules);
+		bObjectGrabbed = MyPhysicsComponent->AttachToComponent(CurrentAttachParent, Rules);
 	}
 	else
 	{
-		GetOwner()->GetRootComponent()->AttachToComponent(Hand, Rules);
+		bObjectGrabbed = GetOwner()->GetRootComponent()->AttachToComponent(CurrentAttachParent, Rules);
 	}
 
+	if (!bObjectGrabbed)
+	{
+		UE_LOGFMT(Toolkit, Warning, "Grab failed! Cannot attach grabbed component to attach parent ({Parent})",
+				  CurrentAttachParent->GetName());
+		return;
+	}
 
+	// If we want to restrict other interactions while this component is grabbed we add the component
+	// that triggered the interaction to the whitelist of all interactables that are attached to the
+	// affected actor
 	if (bBlockOtherInteractionsWhileGrabbed)
 	{
 		TArray<UInteractableComponent*> Interactables;
@@ -66,21 +75,28 @@ void UGrabBehavior::OnActionStart(USceneComponent* TriggeredComponent, const UIn
 			Interactable->RestrictInteractionToComponent(TriggeredComponent);
 		}
 	}
+
+	OnGrabStartEvent.Broadcast(CurrentAttachParent, MyPhysicsComponent);
 }
 
 void UGrabBehavior::OnActionEnd(USceneComponent* TriggeredComponent, const UInputAction* InputAction,
 								const FInputActionValue& Value)
 {
-	if (MyPhysicsComponent)
-	{
-		MyPhysicsComponent->DetachFromComponent(FDetachmentTransformRules::KeepWorldTransform);
-		MyPhysicsComponent->SetSimulatePhysics(true);
-	}
-	else
+
+	USceneComponent* CurrentAttachParent = Cast<USceneComponent>(TriggeredComponent->GetAttachParent());
+
+	// We try to release the attached component. If it is not succesful we log and return. Otherwise, we continue.
+	if (!TryRelease())
 	{
-		GetOwner()->GetRootComponent()->DetachFromComponent(FDetachmentTransformRules::KeepWorldTransform);
+		UE_LOGFMT(Toolkit, Display,
+				  "UGrabBehavior::OnActionEnd: TryRelease failed to release with AttachParent {Parent}",
+				  CurrentAttachParent->GetName());
+		return;
 	}
 
+	OnGrabEndEvent.Broadcast(CurrentAttachParent, MyPhysicsComponent);
+
+	// Release the interation restriction on all component
 	if (bBlockOtherInteractionsWhileGrabbed)
 	{
 		TArray<UInteractableComponent*> Interactables;
@@ -91,3 +107,23 @@ void UGrabBehavior::OnActionEnd(USceneComponent* TriggeredComponent, const UInpu
 		}
 	}
 }
+
+bool UGrabBehavior::TryRelease()
+{
+	if (!bObjectGrabbed)
+	{
+		return false;
+	}
+
+	if (MyPhysicsComponent)
+	{
+		MyPhysicsComponent->DetachFromComponent(FDetachmentTransformRules::KeepWorldTransform);
+		MyPhysicsComponent->SetSimulatePhysics(bWasSimulatingPhysics);
+	}
+	else
+	{
+		GetOwner()->GetRootComponent()->DetachFromComponent(FDetachmentTransformRules::KeepWorldTransform);
+	}
+	bObjectGrabbed = false;
+	return true;
+}

Content/Components/DirectInteraction/IA_DirectInteractionLeft.uasset

@@ -0,0 +1,116 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+#include "Interaction/Interactables/IntenSelect/IntenSelectable.h"
+
+#include "Interaction/Interactables/IntenSelect/IntenSelectableScoring.h"
+#include "Interaction/Interactables/IntenSelect/IntenSelectableSinglePointScoring.h"
+#include "Kismet/KismetSystemLibrary.h"
+#include "Misc/MessageDialog.h"
+#include "Pawn/IntenSelectComponent.h"
+
+UIntenSelectable::UIntenSelectable() { PrimaryComponentTick.bCanEverTick = true; }
+
+TPair<FHitResult, float> UIntenSelectable::GetBestPointScorePair(const FVector& ConeOrigin,
+																 const FVector& ConeForwardDirection,
+																 const float ConeBackwardShiftDistance,
+																 const float ConeAngle, const float LastValue,
+																 const float DeltaTime) const
+{
+	checkf(ScoringBehaviour, TEXT("%s"), *GetOwner()->GetName()) return ScoringBehaviour->GetBestPointScorePair(
+		ConeOrigin, ConeForwardDirection, ConeBackwardShiftDistance, ConeAngle, LastValue, DeltaTime);
+}
+
+void UIntenSelectable::HandleOnSelectStartEvents(const UIntenSelectComponent* IntenSelect, const FHitResult& HitResult)
+{
+	for (const UHoverBehaviour* b : OnSelectBehaviours)
+	{
+		b->OnHoverStartEvent.Broadcast(IntenSelect, HitResult);
+	}
+}
+
+void UIntenSelectable::HandleOnSelectEndEvents(const UIntenSelectComponent* IntenSelect)
+{
+	for (const UHoverBehaviour* b : OnSelectBehaviours)
+	{
+		b->OnHoverEndEvent.Broadcast(IntenSelect);
+	}
+}
+
+void UIntenSelectable::HandleOnClickStartEvents(UIntenSelectComponent* IntenSelect)
+{
+	for (const UActionBehaviour* b : OnClickBehaviours)
+	{
+		FInputActionValue v{};
+		const UInputAction* a{};
+		b->OnActionBeginEvent.Broadcast(IntenSelect, a, v);
+	}
+}
+
+void UIntenSelectable::HandleOnClickEndEvents(UIntenSelectComponent* IntenSelect, FInputActionValue& InputValue)
+{
+	for (const UActionBehaviour* b : OnClickBehaviours)
+	{
+		const UInputAction* a{};
+		b->OnActionEndEvent.Broadcast(IntenSelect, a, InputValue);
+	}
+}
+
+void UIntenSelectable::InitDefaultBehaviourReferences()
+{
+	// Scoring
+	if (UIntenSelectableScoring* AttachedScoring =
+			Cast<UIntenSelectableScoring>(GetOwner()->GetComponentByClass(UIntenSelectableScoring::StaticClass())))
+	{
+		ScoringBehaviour = AttachedScoring;
+	}
+	else
+	{
+		ScoringBehaviour = NewObject<UIntenSelectableSinglePointScoring>(
+			this, UIntenSelectableSinglePointScoring::StaticClass(), "Default Scoring");
+		ScoringBehaviour->SetWorldLocation(GetOwner()->GetActorLocation());
+		ScoringBehaviour->AttachToComponent(GetOwner()->GetRootComponent(),
+											FAttachmentTransformRules::SnapToTargetNotIncludingScale);
+	}
+
+	// Selecting
+	TInlineComponentArray<UHoverBehaviour*> AttachedSelectionBehaviours;
+	GetOwner()->GetComponents(AttachedSelectionBehaviours, true);
+
+	this->OnSelectBehaviours = AttachedSelectionBehaviours;
+
+	// Clicking
+	TInlineComponentArray<UActionBehaviour*> AttachedClickBehaviours;
+	GetOwner()->GetComponents(AttachedClickBehaviours, true);
+
+	this->OnClickBehaviours = AttachedClickBehaviours;
+}
+
+void UIntenSelectable::ShowErrorAndQuit(const FString& Message) const
+{
+	UE_LOG(LogTemp, Error, TEXT("%s"), *Message)
+#if WITH_EDITOR
+	FMessageDialog::Open(EAppMsgType::Ok, FText::FromString(FString("RUNTIME ERROR")));
+#endif
+	UKismetSystemLibrary::QuitGame(this, nullptr, EQuitPreference::Quit, false);
+}
+
+void UIntenSelectable::BeginPlay()
+{
+	Super::BeginPlay();
+
+	TInlineComponentArray<UIntenSelectable*> AttachedIntenSelectables;
+	GetOwner()->GetComponents(AttachedIntenSelectables, false);
+
+	if (AttachedIntenSelectables.Num() > 1)
+	{
+		if (!ScoringBehaviour)
+		{
+			ShowErrorAndQuit(
+				"Please assign the Scoring Behaviour manually when using more than one IntenSelectable Component!");
+		}
+	}
+	else
+	{
+		InitDefaultBehaviourReferences();
+	}
+}