Attempt to make interactive popup Windows ("Continue/Restart/Next...

Attempt to make interactive popup Windows ("Continue/Restart/Next Participant", Custom Participant ID, Indep Variables) cluster safe. This version runs on a normal machine, has not been tested on cluster yet

Source/StudyFrameworkPlugin/Private/SFGameInstance.cpp

@@ -9,6 +9,7 @@
 #include "HUD/SFGlobalFadeGameViewportClient.h"
 
 #include "Help/SFUtils.h"
+#include "Kismet/KismetStringLibrary.h"
 #include "Logging/SFLoggingBPLibrary.h"
 #include "Logging/SFLoggingUtils.h"
 
@@ -248,7 +249,34 @@ void USFGameInstance::PrepareWithStudySetup(ASFStudySetup* Setup)
 			"Next Participant",
 			"Restart Study"
 		};
-		int Answer = FSFUtils::OpenCustomDialog(MessageTitle, MessageText, Buttons);
+		int Answer;
+		if(!FSFUtils::IsPrimary())
+		{
+			while (!bResultBufferSet)
+			{
+				//Wait for Dialog to be completed on primary node
+			};
+			Answer = ResultBuffer;
+			ResultBuffer = -1;
+			bResultBufferSet = false;
+		}
+		else
+		{
+			Answer = FSFUtils::OpenCustomDialog(MessageTitle, MessageText, Buttons);
+			// Broadcast result to secondary nodes
+			if (IDisplayCluster::Get().GetOperationMode() == EDisplayClusterOperationMode::Cluster)
+			{
+				IDisplayClusterClusterManager* const Manager = IDisplayCluster::Get().GetClusterMgr();
+				FDisplayClusterClusterEventJson Event;
+				TMap<FString, FString> Params;
+				Params.Add("Result", FString::FromInt(Answer));
+				Event.Type = "SFGameInstanceEvent";
+				Event.Name = "CustomDialogCompleted";
+				Event.Parameters = Params;
+				Manager->EmitClusterEventJson(Event, false);
+			}
+		}
+		
 		
 		switch (Answer)
 		{
@@ -289,7 +317,37 @@ void USFGameInstance::PrepareWithStudySetup(ASFStudySetup* Setup)
 		while(!bValidIDEntered)
 		{
 			FString IDGiven;
-			int Result = FSFUtils::OpenCustomDialogText("Participant ID", "Please type in your ID:", "", IDGiven);
+			int Result;
+			if (!FSFUtils::IsPrimary())
+			{
+				while (!bResultBufferSet)
+				{
+					//Wait for Dialog to be completed on primary node
+				};
+				Result = ResultBuffer;
+				ResultBuffer = -1;
+				bResultBufferSet = false;
+				IDGiven = TextBuffer;
+				TextBuffer = "";
+				bTextBufferSet = false;
+			}
+			else
+			{
+				Result = FSFUtils::OpenCustomDialogText("Participant ID", "Please type in your ID:", "", IDGiven);
+				// Broadcast result to secondary nodes
+				if (IDisplayCluster::Get().GetOperationMode() == EDisplayClusterOperationMode::Cluster)
+				{
+					IDisplayClusterClusterManager* const Manager = IDisplayCluster::Get().GetClusterMgr();
+					FDisplayClusterClusterEventJson Event;
+					TMap<FString, FString> Params;
+					Params.Add("Result", FString::FromInt(Result));
+					Params.Add("Text", IDGiven);
+					Event.Type = "SFGameInstanceEvent";
+					Event.Name = "CustomDialogTextCompleted";
+					Event.Parameters = Params;
+					Manager->EmitClusterEventJson(Event, false);
+				}
+			}
 			if (Result < 0) {
 				FSFLoggingUtils::Log("[USFGameInstance::PrepareWithStudySetup] The window for entering the participant ID was closed without giving an answer, repeat question!", false);
 				continue;
@@ -526,6 +584,24 @@ void USFGameInstance::HandleClusterEvent(const FDisplayClusterClusterEventJson&
 			}
 			HandleGoToConditionSynced(Event.Parameters["ConditionName"], Event.Parameters["bForced"] == "true", Fade);
 		}
+	    else if (Event.Name == "CustomDialogCompleted")
+	    {
+			if(!FSFUtils::IsPrimary())
+			{
+				ResultBuffer = UKismetStringLibrary::Conv_StringToInt(Event.Parameters["Result"]);
+				bResultBufferSet = true;
+			}	        
+	    }
+	    else if (Event.Name == "CustomDialogTextCompleted")
+	    {
+			if (!FSFUtils::IsPrimary())
+			{
+				TextBuffer = Event.Parameters["Text"];
+				bTextBufferSet = true;
+				ResultBuffer = UKismetStringLibrary::Conv_StringToInt(Event.Parameters["Result"]);
+				bResultBufferSet = true;
+			}
+	    }
 	}
 }
 

Source/StudyFrameworkPlugin/Private/SFParticipant.cpp

@@ -11,6 +11,7 @@
 #include "Logging/SFLoggingBPLibrary.h"
 #include "Logging/SFLoggingUtils.h"
 #include "JsonUtilities.h"
+#include "Kismet/KismetStringLibrary.h"
 
 USFParticipant::USFParticipant()
 {
@@ -27,12 +28,45 @@ bool USFParticipant::Initialize(int SequenceNumber, FString ID)
 
 	StartTime = FPlatformTime::Seconds();
 
+	IDisplayClusterClusterManager* ClusterManager = IDisplayCluster::Get().GetClusterMgr();
+	if (ClusterManager && !ClusterEventListenerDelegate.IsBound())
+	{
+		ClusterEventListenerDelegate = FOnClusterEventJsonListener::CreateUObject(this, &USFParticipant::HandleClusterEvent);
+		ClusterManager->AddClusterEventJsonListener(ClusterEventListenerDelegate);
+	}
 	ParticipantLoggingInfix = "LogParticipant-" + ParticipantID + "_" + FDateTime::Now().ToString();
 	FSFLoggingUtils::SetupParticipantLoggingStream(ParticipantLoggingInfix);
 
+
 	return true;
 }
 
+
+void USFParticipant::HandleClusterEvent(const FDisplayClusterClusterEventJson & Event) {
+	if (Event.Type == "SFParticipantEvent") {
+		//now we actually react on all cluster nodes:
+		if (Event.Name == "CustomDialogCompleted")
+		{
+			if (!FSFUtils::IsPrimary())
+			{
+				ResultBuffer = UKismetStringLibrary::Conv_StringToInt(Event.Parameters["Result"]);
+				bResultBufferSet = true;
+			}
+		}
+		else if (Event.Name == "CustomDialogTextCompleted")
+		{
+			if (!FSFUtils::IsPrimary())
+			{
+				TextBuffer = Event.Parameters["Text"];
+				bTextBufferSet = true;
+				ResultBuffer = UKismetStringLibrary::Conv_StringToInt(Event.Parameters["Result"]);
+				bResultBufferSet = true;
+			}
+		}
+	}
+}
+
+
 void USFParticipant::SetStudyConditions(TArray<USFCondition*> NewConditions)
 {
 	Conditions = NewConditions;
@@ -606,7 +640,37 @@ void USFParticipant::SetIndependentVariablesFromStudySetup(ASFStudySetup* Setup)
 			case EValType::TEXT:
 			{
 				FString Answer;
-				int Result = FSFUtils::OpenCustomDialogText(Var->Name, Var->Prompt, "", Answer);
+				int Result;
+				if (!FSFUtils::IsPrimary())
+				{
+					while (!bResultBufferSet)
+					{
+						//Wait for Dialog to be completed on primary node
+					};
+					Answer = TextBuffer;
+					TextBuffer = "";
+					bTextBufferSet = false;
+					Result = ResultBuffer;
+					ResultBuffer = -1;
+					bResultBufferSet = false;
+				}
+				else
+				{
+					Result = FSFUtils::OpenCustomDialogText(Var->Name, Var->Prompt, "", Answer);
+					// Broadcast result to secondary nodes
+					if (IDisplayCluster::Get().GetOperationMode() == EDisplayClusterOperationMode::Cluster)
+					{
+						IDisplayClusterClusterManager* const Manager = IDisplayCluster::Get().GetClusterMgr();
+						FDisplayClusterClusterEventJson Event;
+						TMap<FString, FString> Params;
+						Params.Add("Result", FString::FromInt(Result));
+						Params.Add("Text", Answer);
+						Event.Type = "SFParticipantEvent";
+						Event.Name = "CustomDialogTextCompleted";
+						Event.Parameters = Params;
+						Manager->EmitClusterEventJson(Event, false);
+					}
+				}
 				if (Result < 0) {
 					FSFLoggingUtils::Log("[USFParticipant::SetIndependentVariablesFromStudySetup] The window for the variable was closed without giving an answer!", false);
 				}
@@ -618,7 +682,33 @@ void USFParticipant::SetIndependentVariablesFromStudySetup(ASFStudySetup* Setup)
 
 			case EValType::MULTIPLECHOICE:
 			{
-				int Answer = FSFUtils::OpenCustomDialog(Var->Name, Var->Prompt, Var->Options);
+				int Answer;
+				if (!FSFUtils::IsPrimary())
+				{
+					while (!bResultBufferSet)
+					{
+						//Wait for Dialog to be completed on primary node
+					};
+					Answer = ResultBuffer;
+					ResultBuffer = -1;
+					bResultBufferSet = false;
+				}
+				else
+				{
+					Answer = FSFUtils::OpenCustomDialog(Var->Name, Var->Prompt, Var->Options);
+					// Broadcast result to secondary nodes
+					if (IDisplayCluster::Get().GetOperationMode() == EDisplayClusterOperationMode::Cluster)
+					{
+						IDisplayClusterClusterManager* const Manager = IDisplayCluster::Get().GetClusterMgr();
+						FDisplayClusterClusterEventJson Event;
+						TMap<FString, FString> Params;
+						Params.Add("Result", FString::FromInt(Answer));
+						Event.Type = "SFParticipantEvent";
+						Event.Name = "CustomDialogCompleted";
+						Event.Parameters = Params;
+						Manager->EmitClusterEventJson(Event, false);
+					}
+				}
 				if (Answer < 0) {
 					FSFLoggingUtils::Log("[USFParticipant::SetIndependentVariablesFromStudySetup] The window for the variable was closed without selecting anything!", false);
 				}

Source/StudyFrameworkPlugin/Public/SFGameInstance.h

@@ -249,5 +249,17 @@ protected:
 	//Controls central logging functionality, stores logging parameters
 	UPROPERTY()
 	USFLogObject* LogObject;
+
+private:
+	//Use this to write result from primary node
+	UPROPERTY()
+	FString TextBuffer = "";
+	UPROPERTY()
+	bool bTextBufferSet = false;
+	UPROPERTY()
+	int ResultBuffer  = -1;
+	UPROPERTY()
+	bool bResultBufferSet = false;
+
 };
 

Source/StudyFrameworkPlugin/Public/SFParticipant.h

@@ -10,6 +10,9 @@
 #include "SFCondition.h"
 #include "SFMultipleTrialDependentVariable.h"
 
+#include "Cluster/IDisplayClusterClusterManager.h"
+#include "Cluster/DisplayClusterClusterEvent.h"
+
 
 #include "SFParticipant.generated.h"
 
@@ -123,4 +126,18 @@ protected:
 	double StartTime = 0.0;
 
 	FString ParticipantLoggingInfix;
+
+	FOnClusterEventJsonListener ClusterEventListenerDelegate;
+	void HandleClusterEvent(const FDisplayClusterClusterEventJson& Event);
+
+private:
+	//Use this to write result from primary node
+	UPROPERTY()
+	FString TextBuffer = "";
+	UPROPERTY()
+	bool bTextBufferSet = false;
+	UPROPERTY()
+	int ResultBuffer = -1;
+	UPROPERTY()
+	bool bResultBufferSet = false;
 };