A library of custom functions related to PixoVR. More...

#include <PixoVRFunctionLibrary.h>

Inheritance diagram for UPixoVRFunctionLibrary:

Static Public Member Functions
static USceneComponent *	AddSceneComponentByClass (UObject *Outer, TSubclassOf< USceneComponent > Class, const FTransform &ComponentRelativeTransform)
	Adds a scene component based on the specified class to the given outer object.

static bool	CheckAuthJSON ()
	Checks if the authentication cache file exists.

static bool	CompareAuthJSON (const FPixoLoginInfo &LoginInfo)
	Compares the credentials of the authentication.

static bool	DeleteAuthJSON ()
	Deletes the authentication cache file from the disk.

static FPixoLoginInfo	EncryptLoginInfo (const FPixoLoginInfo &LoginInfo, const FString &Password)
	Encrypts the login information using the specified password.

static bool	ExportToCSVToProjectRootDirectory (FString Textbody, FString FileName, FString OptionalFolderName, bool OverwriteFile)
	Exports the specified text as a CSV file to the project root directory.

static bool	ExportToCSVToSpecifiedPath (FString FilePath, FString Textbody, FString FileName, FString OptionalFolderName, bool OverwriteFile)
	Exports the specified text as a CSV file to the specified file path.

static FName	GetFullCultureName (FString Culture)
	Retrieves the full culture name based on the specified culture.

static FString	GetHMDFullDeviceName ()
	Retrieves the full device name of the HMD (Head-Mounted Display).

static bool	GetIsOfflineModeEnabled ()
	Retrieves the flag indicating whether offline mode is enabled.

static bool	GetKillSwitchValues (FString &MonthDayYear)
	Retrieves the kill switch values from the configuration file.

static FName	GetMapAfterIntro ()
	Retrieves the map name to load after the introduction.

static FName	GetMapAfterLogin ()
	Retrieves the map name to load after login.

static FString	GetMasterServiceIP ()
	Retrieves the IP address of the master service. Probably not used.

static float	GetOfflineTime ()
	Retrieves the time in seconds for offline mode.

static FString	GetTestServerIP ()
	Retrieves the IP address of the test server.

static void	GetVersionName (FString &Version)
	Retrieves the version name.

static bool	LoadAuthFromJSON (FPixoLoginInfo &LoginInfo)
	Loads the cached authentication from a JSON file and fills the necessary UMG fields.

static FString	NewLineCharacter ()
	Retrieves the newline character used in the current platform.

static bool	SaveAuthToJSON (const FPixoLoginInfo &LoginInfo)
	Caches the authentication fields from the UMG widget to a JSON file.

static void	SetLocalizationCulture (FString Culture)
	Sets the localization culture.

Private Member Functions
	GENERATED_BODY ()

Detailed Description

A library of custom functions related to PixoVR.

Todo: Check if we need all this functions.

UCLASS()

Definition at line 18 of file PixoVRFunctionLibrary.h.

Member Function Documentation

◆ AddSceneComponentByClass()

USceneComponent * UPixoVRFunctionLibrary::AddSceneComponentByClass	(	UObject *	Outer,
		TSubclassOf< USceneComponent >	Class,
		const FTransform &	ComponentRelativeTransform )

staticBlueprintCallable

Adds a scene component based on the specified class to the given outer object.

Parameters

Outer	The outer object to which the scene component will be added.
Class	The class of the scene component to add.
ComponentRelativeTransform	The relative transform of the scene component.

Returns: The added scene component.

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Add Scene Component By Class"), Category = "Pixo Custom Functions")

Definition at line 30 of file PixoVRFunctionLibrary.cpp.

◆ CheckAuthJSON()

bool UPixoVRFunctionLibrary::CheckAuthJSON ( )

staticBlueprintCallable

Checks if the authentication cache file exists.

Returns: True if the authentication cache file exists, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 177 of file PixoVRFunctionLibrary.cpp.

◆ CompareAuthJSON()

bool UPixoVRFunctionLibrary::CompareAuthJSON ( const FPixoLoginInfo & LoginInfo )

staticBlueprintCallable

Compares the credentials of the authentication.

Parameters

LoginInfo The login information to compare with.

Returns: True if the credentials match, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 159 of file PixoVRFunctionLibrary.cpp.

◆ DeleteAuthJSON()

bool UPixoVRFunctionLibrary::DeleteAuthJSON ( )

staticBlueprintCallable

Deletes the authentication cache file from the disk.

Returns: True if the authentication cache file is successfully deleted, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 170 of file PixoVRFunctionLibrary.cpp.

◆ EncryptLoginInfo()

FPixoLoginInfo UPixoVRFunctionLibrary::EncryptLoginInfo	(	const FPixoLoginInfo &	LoginInfo,
		const FString &	Password )

staticBlueprintCallable

Encrypts the login information using the specified password.

Parameters

LoginInfo	The login information to encrypt.
Password	The password used for encryption.

Returns: The encrypted login information.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 114 of file PixoVRFunctionLibrary.cpp.

Here is the call graph for this function:

◆ ExportToCSVToProjectRootDirectory()

bool UPixoVRFunctionLibrary::ExportToCSVToProjectRootDirectory	(	FString	Textbody,
		FString	FileName,
		FString	OptionalFolderName,
		bool	OverwriteFile )

staticBlueprintCallable

Exports the specified text as a CSV file to the project root directory.

Parameters

Textbody	The text content to export.
FileName	The name of the CSV file.
OptionalFolderName	The name of the optional folder to store the CSV file.
OverwriteFile	Indicates whether to overwrite an existing file with the same name.

Returns: True if the export is successful, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | File IO")

Definition at line 182 of file PixoVRFunctionLibrary.cpp.

Here is the call graph for this function:

◆ ExportToCSVToSpecifiedPath()

bool UPixoVRFunctionLibrary::ExportToCSVToSpecifiedPath	(	FString	FilePath,
		FString	Textbody,
		FString	FileName,
		FString	OptionalFolderName,
		bool	OverwriteFile )

staticBlueprintCallable

Exports the specified text as a CSV file to the specified file path.

Parameters

FilePath	The path where the CSV file will be exported.
Textbody	The text content to export.
FileName	The name of the CSV file.
OptionalFolderName	The name of the optional folder to store the CSV file.
OverwriteFile	Indicates whether to overwrite an existing file with the same name.

Returns: True if the export is successful, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | File IO")

Definition at line 59 of file PixoVRFunctionLibrary.cpp.

Here is the call graph for this function:

◆ GENERATED_BODY()

UPixoVRFunctionLibrary::GENERATED_BODY ( )

private

◆ GetFullCultureName()

FName UPixoVRFunctionLibrary::GetFullCultureName ( FString Culture )

staticBlueprintCallable

Retrieves the full culture name based on the specified culture.

Parameters

Culture The culture to get the full name for.

Returns: The full culture name.

UFUNCTION(BlueprintCallable, Category = "Localization")

Definition at line 244 of file PixoVRFunctionLibrary.cpp.

◆ GetHMDFullDeviceName()

FString UPixoVRFunctionLibrary::GetHMDFullDeviceName ( )

staticBlueprintPure

Retrieves the full device name of the HMD (Head-Mounted Display).

Returns: The full device name of the HMD. Possible values: SteamVR, Vive Focus Plus, VIVE Focus 3, Quest, Pico Neo 2, Pico Neo 3.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions")

Definition at line 66 of file PixoVRFunctionLibrary.cpp.

◆ GetIsOfflineModeEnabled()

bool UPixoVRFunctionLibrary::GetIsOfflineModeEnabled ( )

staticBlueprintPure

Retrieves the flag indicating whether offline mode is enabled.

Returns: True if offline mode is enabled, false otherwise.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions | Login")

Definition at line 214 of file PixoVRFunctionLibrary.cpp.

◆ GetKillSwitchValues()

bool UPixoVRFunctionLibrary::GetKillSwitchValues ( FString & MonthDayYear )

staticBlueprintPure

Retrieves the kill switch values from the configuration file.

Parameters

MonthDayYear The output string to store the MonthDayYear value.

Returns: True if the kill switch is enabled, false otherwise.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions | Kill Switch")

Definition at line 92 of file PixoVRFunctionLibrary.cpp.

◆ GetMapAfterIntro()

FName UPixoVRFunctionLibrary::GetMapAfterIntro ( )

staticBlueprintPure

Retrieves the map name to load after the introduction.

Returns: The map name to load after the introduction.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions | Login")

Definition at line 229 of file PixoVRFunctionLibrary.cpp.

Here is the caller graph for this function:

◆ GetMapAfterLogin()

FName UPixoVRFunctionLibrary::GetMapAfterLogin ( )

staticBlueprintPure

Retrieves the map name to load after login.

Returns: The map name to load after login.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions | Login")

Definition at line 224 of file PixoVRFunctionLibrary.cpp.

◆ GetMasterServiceIP()

FString UPixoVRFunctionLibrary::GetMasterServiceIP ( )

staticBlueprintPure

Retrieves the IP address of the master service. Probably not used.

Returns: The IP address of the master service.

UFUNCTION(BlueprintPure, Category="Pixo|OnlineSubsystem")

Definition at line 254 of file PixoVRFunctionLibrary.cpp.

◆ GetOfflineTime()

float UPixoVRFunctionLibrary::GetOfflineTime ( )

staticBlueprintPure

Retrieves the time in seconds for offline mode.

Returns: The time in seconds for offline mode.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions | Login")

Definition at line 219 of file PixoVRFunctionLibrary.cpp.

◆ GetTestServerIP()

FString UPixoVRFunctionLibrary::GetTestServerIP ( )

staticBlueprintPure

Retrieves the IP address of the test server.

Returns: The IP address of the test server.

UFUNCTION(BlueprintPure, Category="FallPrevention")

Definition at line 234 of file PixoVRFunctionLibrary.cpp.

◆ GetVersionName()

void UPixoVRFunctionLibrary::GetVersionName ( FString & Version )

staticBlueprintPure

Retrieves the version name.

Parameters

Version The output version name.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions")

Definition at line 79 of file PixoVRFunctionLibrary.cpp.

◆ LoadAuthFromJSON()

bool UPixoVRFunctionLibrary::LoadAuthFromJSON ( FPixoLoginInfo & LoginInfo )

staticBlueprintCallable

Loads the cached authentication from a JSON file and fills the necessary UMG fields.

Parameters

LoginInfo The output structure to store the loaded login information.

Returns: True if the authentication is successfully loaded, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 138 of file PixoVRFunctionLibrary.cpp.

◆ NewLineCharacter()

FString UPixoVRFunctionLibrary::NewLineCharacter ( )

staticBlueprintPure

Retrieves the newline character used in the current platform.

Returns: The newline character.

UFUNCTION(BlueprintPure, Category = "Pixo Custom Functions")

Definition at line 54 of file PixoVRFunctionLibrary.cpp.

◆ SaveAuthToJSON()

bool UPixoVRFunctionLibrary::SaveAuthToJSON ( const FPixoLoginInfo & LoginInfo )

staticBlueprintCallable

Caches the authentication fields from the UMG widget to a JSON file.

Parameters

LoginInfo The login information to cache.

Returns: True if the authentication is successfully cached, false otherwise.

UFUNCTION(BlueprintCallable, Category = "Pixo Custom Functions | Auth")

Definition at line 150 of file PixoVRFunctionLibrary.cpp.

◆ SetLocalizationCulture()

void UPixoVRFunctionLibrary::SetLocalizationCulture ( FString Culture )

staticBlueprintCallable

Sets the localization culture.

Parameters

Culture The culture to set.

UFUNCTION(BlueprintCallable, Category = "Localization")

Definition at line 239 of file PixoVRFunctionLibrary.cpp.

The documentation for this class was generated from the following files:

SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Public/Utilities/PixoVRFunctionLibrary.h
SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Private/Utilities/PixoVRFunctionLibrary.cpp

Static Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ AddSceneComponentByClass()

◆ CheckAuthJSON()

◆ CompareAuthJSON()

◆ DeleteAuthJSON()

◆ EncryptLoginInfo()

◆ ExportToCSVToProjectRootDirectory()

◆ ExportToCSVToSpecifiedPath()

◆ GENERATED_BODY()

◆ GetFullCultureName()

◆ GetHMDFullDeviceName()

◆ GetIsOfflineModeEnabled()

◆ GetKillSwitchValues()

◆ GetMapAfterIntro()

◆ GetMapAfterLogin()

◆ GetMasterServiceIP()

◆ GetOfflineTime()

◆ GetTestServerIP()

◆ GetVersionName()

◆ LoadAuthFromJSON()

◆ NewLineCharacter()

◆ SaveAuthToJSON()

◆ SetLocalizationCulture()