Core utils. More...

#include <RRCoreUtils.h>

Inheritance diagram for URRCoreUtils:

Collaboration diagram for URRCoreUtils:

Static Public Member Functions
template<class T , std::size_t N>
constexpr static std::size_t	GetArraySize (const T(&)[N])

template<bool bInBoolPreprocessor>
static constexpr const FORCEINLINE TCHAR *	GetBoolPreprocessorText ()

static FORCEINLINE FString	GetSanitizedXMLString (const FString &InXMLString)

static FORCEINLINE FString	StdToFString (const std::string &InStdString)

static FORCEINLINE std::string	FToStdString (const FString &InUEString)

static const FORCEINLINE TCHAR *	GetSimFileExt (const ERRFileType InFileType)
	Return the file extension for the given file type from SimFileExts. More...

static FString	GetFileTypeFilter (const ERRFileType InFileType)

static FORCEINLINE ERRFileType	GetFileType (const FString &InFilePath)

static FORCEINLINE bool	IsFileType (const FString &InFilePath, const TArray< ERRFileType > &InFileTypes)

template<typename TCmdlet >
static bool	IsRunningSimCommandlet ()

static void	ExecuteConsoleCommand (const UObject *InContextObject, const FString &InCommandText)

template<typename T >
static constexpr FORCEINLINE bool	GetCommandLineArgumentValue (const TCHAR *InArgName, T &OutArgValue, bool bIsLogged=false)

template<typename T >
static constexpr FORCEINLINE bool	ParseCommandLineParams (const FString &InParams, const TCHAR *InArgName, T &OutArgValue, bool bIsLogged=false)

static UWorld *	GetEditorWorld ()

static bool	IsPIE ()

template<typename T >
static T *	GetGameMode (const UObject *InContextObject=nullptr)

template<typename T >
static T *	GetGameInstance (const UObject *InContextObject=nullptr)

template<typename T >
static T *	GetGameState (const UObject *InContextObject=nullptr)

template<typename T >
static T *	GetPlayerController (int8 InSceneInstanceId, const UObject *InContextObject=nullptr)

template<typename T >
static void	GetPlayerControllerList (TArray< T > &OutPlayerControllerList, const UObject *InContextObject=nullptr)

template<typename T >
static T *	CreatePlayerController (int32 ControllerId, const UObject *InContextObject)

template<typename T >
static void	CreatePlayerControllerList (TArray< T > &OutPlayerControllerList, int32 InNumOfPlayers, const UObject *InContextObject)

static bool	HasPlayerControllerListInitialized (const UObject *InContextObject, bool bIsLogged=false)

static int32	GetMaxSplitscreenPlayers (const UObject *InContextObject)
	This value could be configured in [DefaultEngine.ini]. More...

template<typename TRRObject >
static bool	IsDefaultSimSceneInstance (TRRObject *InSimObject)

static FString	GetSimDefaultConfigFileName (const UObject *InContextObject)

static FString	GetSimConfigFileName (const UObject *InContextObject)

static bool	IsSimProfiling ()

static bool	HasSimInitialized (const UObject *InContextObject, bool bIsLogged=false)
	Check ARRGameState is initialized or not. More...

static URRSceneInstance *	GetSceneInstance (const UObject *InContextObject, int8 InSceneInstanceId)
	Get the Scene Instance. Works only with ARRGameState. More...

static ARRSceneDirector *	GetSceneDirector (const UObject *InContextObject, int8 InSceneInstanceId)

static FVector	GetSceneInstanceLocation (int8 InSceneInstanceId)

static bool	HasEnoughDiskSpace (const FString &InPath, uint64 InRequiredMemorySizeInBytes)

static bool	ShutDownSim (const UObject *InContextObject, uint64 InSimCompletionTimeoutInSecs)

static void	ExecuteSimQuitCommand (const UObject *InContextObject)

static uint32	GetNewGuid ()

static ULevelStreamingDynamic *	CreateStreamingLevel (const UObject *InContextObject, const FRRStreamingLevelInfo &InLevelInfo)
	Create a Streaming Level object. More...

static void	StreamLevel (const UObject InContextObject, const FString &InLevelName, UObject InTargetObject=nullptr, const FName &InExecuteFunctionName=NAME_None)
	LoadStreamLevel. More...

static void	UnstreamLevel (const UObject *InContextObject, const FName &InLevelName)
	UnloadStreamLevel. More...

static void	MoveStreamingLevelBetweenSceneInstances (ULevelStreaming *InStreamingLevel, int8 InStartSceneInstanceId, int8 InTargetSceneInstanceId)

static bool	LoadFullFilePaths (const FString &FolderPath, TArray< FString > &OutFilePaths, const TArray< ERRFileType > &InFileTypes, const bool bInRecursive=true)

static bool	CreateDirectoryIfNotExisting (const FString &DirPath)

static void	VerifyDirPathAbsoluteAndExist (const FString &InDirPath)

static FORCEINLINE float	GetSeconds ()

template<typename T , typename = TEnableIf<TIsFloatingPoint<T>::Value>>
static void	MarkCurrentTime (T &OutTimestamp)

template<typename T , typename = TEnableIf<TIsFloatingPoint<T>::Value>>
static T	GetElapsedTimeSecs (const T &InLastTimestamp)

static bool	WaitUntilThenAct (TFunctionRef< bool()> InCond, TFunctionRef< void()> InPassedCondAct, float InTimeoutInSec, float InIntervalTimeInSec=0.5f)
	It was observed that with high polling frequency as [0.01] or sometimes [0.1] second, we got crash on AutomationTest. More...

static bool	CheckWithTimeOut (const TFunctionRef< bool()> &InCondition, const TFunctionRef< void()> &InActionUponTimeout, float InBeginTimeInSec, float InTimeoutInSec)

static void	StopRegisteredTimer (UWorld *InWorld, FTimerHandle &InTimerHandle)

template<typename T , typename TDelegate >
static FORCEINLINE FTimerHandle	PlanToExecuteOnNextTick (T *InObj, typename TDelegate::template TMethodPtr< T > InMethod)

static FORCEINLINE FTimerHandle	PlanToExecuteOnNextTick (UWorld *InWorld, const FTimerDelegate &InTimerDelegate)

static FORCEINLINE FTimerHandle	PlanToExecuteOnNextTick (UWorld *InWorld, TFunction< void()> InCallback)

template<typename T >
static FORCEINLINE void	RegisterRepeatedExecution (T *InObj, FTimerHandle &InTimerHandle, typename FTimerDelegate::template TMethodPtr< T >::FMethodPtr InMethod, float InRate=0.5f)

template<typename T >
static FORCEINLINE void	RegisterRepeatedExecution (T *InObj, FTimerHandle &InTimerHandle, TFunction< void()> Callback, float InRate=0.5f)

static void	StopRegisteredExecution (UWorld *InWorld, FTimerHandle &InTimerHandle)

static int32	RunMonitoredProcess (FMonitoredProcess *InProcess, const float InTimeOutSecs, const FString &InProcessName=EMPTY_STR)

static void	LoadImageWrapperModule ()

static UTexture2D *	LoadImageToTexture (const FString &InFullFilePath, const FString &InTextureName, const bool bInSaveToAsset=false)
	Load image to texture. More...

static bool	LoadImagesFromFolder (const FString &InImageFolderPath, const TArray< ERRFileType > &InImageFileTypes, TArray< UTexture * > &OutImageTextureList, bool bIsLogged=false)

static UTextureLightProfile *	LoadIESProfile (const FString &InFullFilePath, const FString &InLightProfileName)

static bool	LoadIESProfilesFromFolder (const FString &InFolderPath, TArray< UTextureLightProfile * > &OutLightProfileList, bool bIsLogged=false)

static bool	IsValidBitDepth (int32 InBitDepth)

template<int8 InBitDepth>
static FORCEINLINE void	GetCompressedImageData (const ERRFileType InImageFileType, const FRRColorArray &InImageData, const FIntPoint &ImageSize, const int8 BitDepth, const ERGBFormat RGBFormat, TArray64< uint8 > &OutCompressedData)

static bool	GenerateThumbnail (UObject *InObject, uint32 InImageWidth, uint32 InImageHeight, const FString &InSaveImagePath)
	Generate a thumbnail for an object (eg skeletal/static mesh, texture) & save to an image file on disk. More...

static FORCEINLINE bool	ScreenMsg (const FColor &InColor, const FString &InMessage, float InTimeToDisplay=50000.f)

static FORCEINLINE void	PrintMessage (const FString &InMessage, bool bInError=false, float InTimeOnScreen=100.f)
	Print message. More...

Static Public Attributes
static constexpr const TCHAR *	CMD_SIM_QUIT = TEXT("quit")

static constexpr const TCHAR *	CMD_STATS_START = TEXT("stat startfile")

static constexpr const TCHAR *	CMD_STATS_STOP = TEXT("stat stopfile")

static constexpr const TCHAR *	CMD_MEMORY_REPORT = TEXT("memreport")

static constexpr const TCHAR *	CMD_MEMORY_REPORT_FULL = TEXT("memreport -full")

static constexpr const TCHAR *	CMD_GC_DUMP_POOL_STATS = TEXT("gc.DumpPoolStats")

static constexpr const TCHAR *	CMD_RHI_GPU_CAPTURE_OPTIONS_ENABLE = TEXT("r.RHISetGPUCaptureOptions 1")

static constexpr const TCHAR *	CMD_RENDER_DOC_CAPTURE_FRAME = TEXT("renderdoc.CaptureFrame")

static constexpr const TCHAR *	CMD_SHADOW_MAP_CACHING_TURN_OFF = TEXT("r.Shadow.CacheWholeSceneShadows 0")

static constexpr const TCHAR *	CMD_AO_USE_HISTORY_DISABLE = TEXT("r.AOUseHistory 0")

static constexpr const TCHAR *	CMD_OCCLUDED_PRIMITIVES_VISUALIZE = TEXT("r.VisualizeOccludedPrimitives 1")

static constexpr const TCHAR *	CMD_CUSTOM_DEPTH_STENCIL_ENABLE = TEXT("r.CustomDepth 3")

static constexpr const TCHAR *	CMD_FORWARD_SHADING_ENABLE = TEXT("r.ForwardShading 1")

static constexpr const TCHAR *	CMD_HIGHRES_SCREENSHOT_DELAY = TEXT("r.HighResScreenshotDelay")

static constexpr const TCHAR *	CMD_AUDIO_MIXER_DISABLE = TEXT("au.IsUsingAudioMixer 0")

static constexpr const TCHAR *	SimFileExts []
	Sim file extentions. Corresponds to ERRFileType. More...

static constexpr const TCHAR *	PIXEL_STREAMER_PLAYER_NAME = TEXT("pixelstreamer")

static constexpr const TCHAR *	CIMAGE_WRAPPER_MODULE_NAME = TEXT("ImageWrapper")

static IImageWrapperModule *	SImageWrapperModule

static TMap< ERRFileType, TSharedPtr< IImageWrapper > >	SImageWrappers

static FRRLightProfileData	SLightProfileData

static TFunction< void(uint8 , const FUpdateTextureRegion2D )>	CleanupLightProfileData

Detailed Description

Core utils.

Todo:: add documentation

UCLASS()

Member Function Documentation

◆ CheckWithTimeOut()

static bool URRCoreUtils::CheckWithTimeOut	(	const TFunctionRef< bool()> &	InCondition,
		const TFunctionRef< void()> &	InActionUponTimeout,
		float	InBeginTimeInSec,
		float	InTimeoutInSec
	)

static

Parameters

InCondition
InActionUponTimeout
InBeginTimeInSec
InTimeoutInSec

Returns: true; false

◆ CreateDirectoryIfNotExisting()

static bool URRCoreUtils::CreateDirectoryIfNotExisting ( const FString & DirPath )

inlinestatic

◆ CreatePlayerController()

template<typename T >

static T* URRCoreUtils::CreatePlayerController	(	int32	ControllerId,
		const UObject *	InContextObject
	)

inlinestatic

◆ CreatePlayerControllerList()

template<typename T >

static void URRCoreUtils::CreatePlayerControllerList	(	TArray< T > &	OutPlayerControllerList,
		int32	InNumOfPlayers,
		const UObject *	InContextObject
	)

inlinestatic

◆ CreateStreamingLevel()

static ULevelStreamingDynamic* URRCoreUtils::CreateStreamingLevel	(	const UObject *	InContextObject,
		const FRRStreamingLevelInfo &	InLevelInfo
	)

inlinestatic

Create a Streaming Level object.

Each level could be streamed into an unique [ULevelStreaming]

Refer to ULevelStreamingDynamic::LoadLevelInstance() for creating multiple streaming instances of the same level

See also: ULevelStreamingDynamic

Parameters

InContextObject
InLevelInfo

Returns: ULevelStreamingDynamic*

◆ ExecuteConsoleCommand()

static void URRCoreUtils::ExecuteConsoleCommand	(	const UObject *	InContextObject,
		const FString &	InCommandText
	)

inlinestatic

◆ ExecuteSimQuitCommand()

static void URRCoreUtils::ExecuteSimQuitCommand ( const UObject * InContextObject )

static

◆ FToStdString()

static FORCEINLINE std::string URRCoreUtils::FToStdString ( const FString & InUEString )

inlinestatic

◆ GenerateThumbnail()

static bool URRCoreUtils::GenerateThumbnail	(	UObject *	InObject,
		uint32	InImageWidth,
		uint32	InImageHeight,
		const FString &	InSaveImagePath
	)

static

Generate a thumbnail for an object (eg skeletal/static mesh, texture) & save to an image file on disk.

Parameters

InObject
InImageWidth
InImageHeight
InSaveImagePath

◆ GetArraySize()

template<class T , std::size_t N>

constexpr static std::size_t URRCoreUtils::GetArraySize ( const T(&)[N] )

inlinestaticconstexpr

◆ GetBoolPreprocessorText()

template<bool bInBoolPreprocessor>

static constexpr const FORCEINLINE TCHAR* URRCoreUtils::GetBoolPreprocessorText ( )

inlinestaticconstexpr

◆ GetCommandLineArgumentValue()

template<typename T >

static constexpr FORCEINLINE bool URRCoreUtils::GetCommandLineArgumentValue	(	const TCHAR *	InArgName,
		T &	OutArgValue,
		bool	bIsLogged = `false`
	)

inlinestaticconstexpr

◆ GetCompressedImageData()

template<int8 InBitDepth>

static FORCEINLINE void URRCoreUtils::GetCompressedImageData	(	const ERRFileType	InImageFileType,
		const FRRColorArray &	InImageData,
		const FIntPoint &	ImageSize,
		const int8	BitDepth,
		const ERGBFormat	RGBFormat,
		TArray64< uint8 > &	OutCompressedData
	)

inlinestatic

◆ GetEditorWorld()

static UWorld* URRCoreUtils::GetEditorWorld ( )

inlinestatic

◆ GetElapsedTimeSecs()

template<typename T , typename = TEnableIf<TIsFloatingPoint<T>::Value>>

static T URRCoreUtils::GetElapsedTimeSecs ( const T & InLastTimestamp )

inlinestatic

◆ GetFileType()

static FORCEINLINE ERRFileType URRCoreUtils::GetFileType ( const FString & InFilePath )

inlinestatic

◆ GetFileTypeFilter()

static FString URRCoreUtils::GetFileTypeFilter ( const ERRFileType InFileType )

static

◆ GetGameInstance()

template<typename T >

static T* URRCoreUtils::GetGameInstance ( const UObject * InContextObject = nullptr )

inlinestatic

◆ GetGameMode()

template<typename T >

static T* URRCoreUtils::GetGameMode ( const UObject * InContextObject = nullptr )

inlinestatic

◆ GetGameState()

template<typename T >

static T* URRCoreUtils::GetGameState ( const UObject * InContextObject = nullptr )

inlinestatic

◆ GetMaxSplitscreenPlayers()

static int32 URRCoreUtils::GetMaxSplitscreenPlayers ( const UObject * InContextObject )

static

This value could be configured in [DefaultEngine.ini].

◆ GetNewGuid()

static uint32 URRCoreUtils::GetNewGuid ( )

inlinestatic

◆ GetPlayerController()

template<typename T >

static T* URRCoreUtils::GetPlayerController	(	int8	InSceneInstanceId,
		const UObject *	InContextObject = `nullptr`
	)

inlinestatic

◆ GetPlayerControllerList()

template<typename T >

static void URRCoreUtils::GetPlayerControllerList	(	TArray< T > &	OutPlayerControllerList,
		const UObject *	InContextObject = `nullptr`
	)

inlinestatic

◆ GetSanitizedXMLString()

static FORCEINLINE FString URRCoreUtils::GetSanitizedXMLString ( const FString & InXMLString )

inlinestatic

◆ GetSceneDirector()

static ARRSceneDirector* URRCoreUtils::GetSceneDirector	(	const UObject *	InContextObject,
		int8	InSceneInstanceId
	)

static

◆ GetSceneInstance()

static URRSceneInstance* URRCoreUtils::GetSceneInstance	(	const UObject *	InContextObject,
		int8	InSceneInstanceId
	)

static

Get the Scene Instance. Works only with ARRGameState.

Parameters

InContextObject
InSceneInstanceId

Returns: URRSceneInstance*

◆ GetSceneInstanceLocation()

static FVector URRCoreUtils::GetSceneInstanceLocation ( int8 InSceneInstanceId )

static

◆ GetSeconds()

static FORCEINLINE float URRCoreUtils::GetSeconds ( )

inlinestatic

◆ GetSimConfigFileName()

static FString URRCoreUtils::GetSimConfigFileName ( const UObject * InContextObject )

inlinestatic

◆ GetSimDefaultConfigFileName()

static FString URRCoreUtils::GetSimDefaultConfigFileName ( const UObject * InContextObject )

inlinestatic

◆ GetSimFileExt()

static const FORCEINLINE TCHAR* URRCoreUtils::GetSimFileExt ( const ERRFileType InFileType )

inlinestatic

Return the file extension for the given file type from SimFileExts.

Parameters

InFileType

Returns: FORCEINLINE const* TCHAR*

◆ HasEnoughDiskSpace()

static bool URRCoreUtils::HasEnoughDiskSpace	(	const FString &	InPath,
		uint64	InRequiredMemorySizeInBytes
	)

static

◆ HasPlayerControllerListInitialized()

static bool URRCoreUtils::HasPlayerControllerListInitialized	(	const UObject *	InContextObject,
		bool	bIsLogged = `false`
	)

static

◆ HasSimInitialized()

static bool URRCoreUtils::HasSimInitialized	(	const UObject *	InContextObject,
		bool	bIsLogged = `false`
	)

static

Check ARRGameState is initialized or not.

Parameters

InContextObject
bIsLogged

Returns: true; false

◆ IsDefaultSimSceneInstance()

template<typename TRRObject >

static bool URRCoreUtils::IsDefaultSimSceneInstance ( TRRObject * InSimObject )

inlinestatic

◆ IsFileType()

static FORCEINLINE bool URRCoreUtils::IsFileType	(	const FString &	InFilePath,
		const TArray< ERRFileType > &	InFileTypes
	)

inlinestatic

◆ IsPIE()

static bool URRCoreUtils::IsPIE ( )

inlinestatic

◆ IsRunningSimCommandlet()

template<typename TCmdlet >

static bool URRCoreUtils::IsRunningSimCommandlet ( )

inlinestatic

◆ IsSimProfiling()

static bool URRCoreUtils::IsSimProfiling ( )

static

◆ IsValidBitDepth()

static bool URRCoreUtils::IsValidBitDepth ( int32 InBitDepth )

inlinestatic

◆ LoadFullFilePaths()

static bool URRCoreUtils::LoadFullFilePaths	(	const FString &	FolderPath,
		TArray< FString > &	OutFilePaths,
		const TArray< ERRFileType > &	InFileTypes,
		const bool	bInRecursive = `true`
	)

static

◆ LoadIESProfile()

static UTextureLightProfile* URRCoreUtils::LoadIESProfile	(	const FString &	InFullFilePath,
		const FString &	InLightProfileName
	)

static

◆ LoadIESProfilesFromFolder()

static bool URRCoreUtils::LoadIESProfilesFromFolder	(	const FString &	InFolderPath,
		TArray< UTextureLightProfile * > &	OutLightProfileList,
		bool	bIsLogged = `false`
	)

static

◆ LoadImagesFromFolder()

static bool URRCoreUtils::LoadImagesFromFolder	(	const FString &	InImageFolderPath,
		const TArray< ERRFileType > &	InImageFileTypes,
		TArray< UTexture * > &	OutImageTextureList,
		bool	bIsLogged = `false`
	)

static

◆ LoadImageToTexture()

static UTexture2D* URRCoreUtils::LoadImageToTexture	(	const FString &	InFullFilePath,
		const FString &	InTextureName,
		const bool	bInSaveToAsset = `false`
	)

static

Load image to texture.

Parameters

InFullFilePath
InTextureName
bInSaveToAsset	if True -> use ImportObject(), otherwise FImageUtils::ImportFileAsTexture2D()

Returns: UTexture2D*

◆ LoadImageWrapperModule()

static void URRCoreUtils::LoadImageWrapperModule ( )

static

◆ MarkCurrentTime()

template<typename T , typename = TEnableIf<TIsFloatingPoint<T>::Value>>

static void URRCoreUtils::MarkCurrentTime ( T & OutTimestamp )

inlinestatic

◆ MoveStreamingLevelBetweenSceneInstances()

static void URRCoreUtils::MoveStreamingLevelBetweenSceneInstances	(	ULevelStreaming *	InStreamingLevel,
		int8	InStartSceneInstanceId,
		int8	InTargetSceneInstanceId
	)

inlinestatic

◆ ParseCommandLineParams()

template<typename T >

static constexpr FORCEINLINE bool URRCoreUtils::ParseCommandLineParams	(	const FString &	InParams,
		const TCHAR *	InArgName,
		T &	OutArgValue,
		bool	bIsLogged = `false`
	)

inlinestaticconstexpr

◆ PlanToExecuteOnNextTick() [1/3]

template<typename T , typename TDelegate >

static FORCEINLINE FTimerHandle URRCoreUtils::PlanToExecuteOnNextTick	(	T *	InObj,
		typename TDelegate::template TMethodPtr< T >	InMethod
	)

inlinestatic

◆ PlanToExecuteOnNextTick() [2/3]

static FORCEINLINE FTimerHandle URRCoreUtils::PlanToExecuteOnNextTick	(	UWorld *	InWorld,
		const FTimerDelegate &	InTimerDelegate
	)

inlinestatic

◆ PlanToExecuteOnNextTick() [3/3]

static FORCEINLINE FTimerHandle URRCoreUtils::PlanToExecuteOnNextTick	(	UWorld *	InWorld,
		TFunction< void()>	InCallback
	)

inlinestatic

◆ PrintMessage()

static FORCEINLINE void URRCoreUtils::PrintMessage	(	const FString &	InMessage,
		bool	bInError = `false`,
		float	InTimeOnScreen = `100.f`
	)

inlinestatic

Print message.

Parameters

InMessage
bInError
InTimeOnScreen	(secs)

◆ RegisterRepeatedExecution() [1/2]

template<typename T >

static FORCEINLINE void URRCoreUtils::RegisterRepeatedExecution	(	T *	InObj,
		FTimerHandle &	InTimerHandle,
		TFunction< void()>	Callback,
		float	InRate = `0.5f`
	)

inlinestatic

◆ RegisterRepeatedExecution() [2/2]

template<typename T >

static FORCEINLINE void URRCoreUtils::RegisterRepeatedExecution	(	T *	InObj,
		FTimerHandle &	InTimerHandle,
		typename FTimerDelegate::template TMethodPtr< T >::FMethodPtr	InMethod,
		float	InRate = `0.5f`
	)

inlinestatic

◆ RunMonitoredProcess()

static int32 URRCoreUtils::RunMonitoredProcess	(	FMonitoredProcess *	InProcess,
		const float	InTimeOutSecs,
		const FString &	InProcessName = `EMPTY_STR`
	)

inlinestatic

◆ ScreenMsg()

static FORCEINLINE bool URRCoreUtils::ScreenMsg	(	const FColor &	InColor,
		const FString &	InMessage,
		float	InTimeToDisplay = `50000.f`
	)

inlinestatic

◆ ShutDownSim()

static bool URRCoreUtils::ShutDownSim	(	const UObject *	InContextObject,
		uint64	InSimCompletionTimeoutInSecs
	)

static

◆ StdToFString()

static FORCEINLINE FString URRCoreUtils::StdToFString ( const std::string & InStdString )

inlinestatic

◆ StopRegisteredExecution()

static void URRCoreUtils::StopRegisteredExecution	(	UWorld *	InWorld,
		FTimerHandle &	InTimerHandle
	)

inlinestatic

◆ StopRegisteredTimer()

static void URRCoreUtils::StopRegisteredTimer	(	UWorld *	InWorld,
		FTimerHandle &	InTimerHandle
	)

inlinestatic

◆ StreamLevel()

static void URRCoreUtils::StreamLevel	(	const UObject *	InContextObject,
		const FString &	InLevelName,
		UObject *	InTargetObject = `nullptr`,
		const FName &	InExecuteFunctionName = `NAME_None`
	)

inlinestatic

LoadStreamLevel.

See also: Loading and Unloading Levels using C++

Parameters

InContextObject
InLevelName
InTargetObject
InExecuteFunctionName

◆ UnstreamLevel()

static void URRCoreUtils::UnstreamLevel	(	const UObject *	InContextObject,
		const FName &	InLevelName
	)

inlinestatic

UnloadStreamLevel.

See also: Loading and Unloading Levels using C++

Parameters

InContextObject
InLevelName

◆ VerifyDirPathAbsoluteAndExist()

static void URRCoreUtils::VerifyDirPathAbsoluteAndExist ( const FString & InDirPath )

inlinestatic

◆ WaitUntilThenAct()

static bool URRCoreUtils::WaitUntilThenAct	(	TFunctionRef< bool()>	InCond,
		TFunctionRef< void()>	InPassedCondAct,
		float	InTimeoutInSec,
		float	InIntervalTimeInSec = `0.5f`
	)

static

It was observed that with high polling frequency as [0.01] or sometimes [0.1] second, we got crash on AutomationTest.

module. Thus, [IntervalTimeInSec] as [0.5] sec is used for now.

Parameters

InCond
InPassedCondAct
InTimeoutInSec
InIntervalTimeInSec

Returns: true; false

Member Data Documentation

◆ CIMAGE_WRAPPER_MODULE_NAME

constexpr const TCHAR* URRCoreUtils::CIMAGE_WRAPPER_MODULE_NAME = TEXT("ImageWrapper")

staticconstexpr

◆ CleanupLightProfileData

TFunction<void(uint8*, const FUpdateTextureRegion2D*)> URRCoreUtils::CleanupLightProfileData

static

◆ CMD_AO_USE_HISTORY_DISABLE

constexpr const TCHAR* URRCoreUtils::CMD_AO_USE_HISTORY_DISABLE = TEXT("r.AOUseHistory 0")

staticconstexpr

◆ CMD_AUDIO_MIXER_DISABLE

constexpr const TCHAR* URRCoreUtils::CMD_AUDIO_MIXER_DISABLE = TEXT("au.IsUsingAudioMixer 0")

staticconstexpr

◆ CMD_CUSTOM_DEPTH_STENCIL_ENABLE

constexpr const TCHAR* URRCoreUtils::CMD_CUSTOM_DEPTH_STENCIL_ENABLE = TEXT("r.CustomDepth 3")

staticconstexpr

◆ CMD_FORWARD_SHADING_ENABLE

constexpr const TCHAR* URRCoreUtils::CMD_FORWARD_SHADING_ENABLE = TEXT("r.ForwardShading 1")

staticconstexpr

◆ CMD_GC_DUMP_POOL_STATS

constexpr const TCHAR* URRCoreUtils::CMD_GC_DUMP_POOL_STATS = TEXT("gc.DumpPoolStats")

staticconstexpr

◆ CMD_HIGHRES_SCREENSHOT_DELAY

constexpr const TCHAR* URRCoreUtils::CMD_HIGHRES_SCREENSHOT_DELAY = TEXT("r.HighResScreenshotDelay")

staticconstexpr

◆ CMD_MEMORY_REPORT

constexpr const TCHAR* URRCoreUtils::CMD_MEMORY_REPORT = TEXT("memreport")

staticconstexpr

◆ CMD_MEMORY_REPORT_FULL

constexpr const TCHAR* URRCoreUtils::CMD_MEMORY_REPORT_FULL = TEXT("memreport -full")

staticconstexpr

◆ CMD_OCCLUDED_PRIMITIVES_VISUALIZE

constexpr const TCHAR* URRCoreUtils::CMD_OCCLUDED_PRIMITIVES_VISUALIZE = TEXT("r.VisualizeOccludedPrimitives 1")

staticconstexpr

◆ CMD_RENDER_DOC_CAPTURE_FRAME

constexpr const TCHAR* URRCoreUtils::CMD_RENDER_DOC_CAPTURE_FRAME = TEXT("renderdoc.CaptureFrame")

staticconstexpr

◆ CMD_RHI_GPU_CAPTURE_OPTIONS_ENABLE

constexpr const TCHAR* URRCoreUtils::CMD_RHI_GPU_CAPTURE_OPTIONS_ENABLE = TEXT("r.RHISetGPUCaptureOptions 1")

staticconstexpr

◆ CMD_SHADOW_MAP_CACHING_TURN_OFF

constexpr const TCHAR* URRCoreUtils::CMD_SHADOW_MAP_CACHING_TURN_OFF = TEXT("r.Shadow.CacheWholeSceneShadows 0")

staticconstexpr

◆ CMD_SIM_QUIT

constexpr const TCHAR* URRCoreUtils::CMD_SIM_QUIT = TEXT("quit")

staticconstexpr

◆ CMD_STATS_START

constexpr const TCHAR* URRCoreUtils::CMD_STATS_START = TEXT("stat startfile")

staticconstexpr

◆ CMD_STATS_STOP

constexpr const TCHAR* URRCoreUtils::CMD_STATS_STOP = TEXT("stat stopfile")

staticconstexpr

◆ PIXEL_STREAMER_PLAYER_NAME

constexpr const TCHAR* URRCoreUtils::PIXEL_STREAMER_PLAYER_NAME = TEXT("pixelstreamer")

staticconstexpr

◆ SImageWrapperModule

IImageWrapperModule* URRCoreUtils::SImageWrapperModule

static

◆ SImageWrappers

TMap<ERRFileType, TSharedPtr<IImageWrapper> > URRCoreUtils::SImageWrappers

static

◆ SimFileExts

constexpr const TCHAR* URRCoreUtils::SimFileExts[]

staticconstexpr

Sim file extentions. Corresponds to ERRFileType.

◆ SLightProfileData

FRRLightProfileData URRCoreUtils::SLightProfileData

static

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

/home/docs/checkouts/readthedocs.org/user_builds/rapyutasimulationplugins/checkouts/devel/Source/RapyutaSimulationPlugins/Public/Core/RRCoreUtils.h

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ CheckWithTimeOut()

◆ CreateDirectoryIfNotExisting()

◆ CreatePlayerController()

◆ CreatePlayerControllerList()

◆ CreateStreamingLevel()

◆ ExecuteConsoleCommand()

◆ ExecuteSimQuitCommand()

◆ FToStdString()

◆ GenerateThumbnail()

◆ GetArraySize()

◆ GetBoolPreprocessorText()

◆ GetCommandLineArgumentValue()

◆ GetCompressedImageData()

◆ GetEditorWorld()

◆ GetElapsedTimeSecs()

◆ GetFileType()

◆ GetFileTypeFilter()

◆ GetGameInstance()

◆ GetGameMode()

◆ GetGameState()

◆ GetMaxSplitscreenPlayers()

◆ GetNewGuid()

◆ GetPlayerController()

◆ GetPlayerControllerList()

◆ GetSanitizedXMLString()

◆ GetSceneDirector()

◆ GetSceneInstance()

◆ GetSceneInstanceLocation()

◆ GetSeconds()

◆ GetSimConfigFileName()

◆ GetSimDefaultConfigFileName()

◆ GetSimFileExt()

◆ HasEnoughDiskSpace()

◆ HasPlayerControllerListInitialized()

◆ HasSimInitialized()

◆ IsDefaultSimSceneInstance()

◆ IsFileType()

◆ IsPIE()

◆ IsRunningSimCommandlet()

◆ IsSimProfiling()

◆ IsValidBitDepth()

◆ LoadFullFilePaths()

◆ LoadIESProfile()

◆ LoadIESProfilesFromFolder()

◆ LoadImagesFromFolder()

◆ LoadImageToTexture()

◆ LoadImageWrapperModule()

◆ MarkCurrentTime()

◆ MoveStreamingLevelBetweenSceneInstances()

◆ ParseCommandLineParams()

◆ PlanToExecuteOnNextTick() [1/3]

◆ PlanToExecuteOnNextTick() [2/3]

◆ PlanToExecuteOnNextTick() [3/3]

◆ PrintMessage()

◆ RegisterRepeatedExecution() [1/2]

◆ RegisterRepeatedExecution() [2/2]

◆ RunMonitoredProcess()

◆ ScreenMsg()

◆ ShutDownSim()

◆ StdToFString()

◆ StopRegisteredExecution()

◆ StopRegisteredTimer()

◆ StreamLevel()

◆ UnstreamLevel()

◆ VerifyDirPathAbsoluteAndExist()

◆ WaitUntilThenAct()

Member Data Documentation

◆ CIMAGE_WRAPPER_MODULE_NAME

◆ CleanupLightProfileData

◆ CMD_AO_USE_HISTORY_DISABLE

◆ CMD_AUDIO_MIXER_DISABLE

◆ CMD_CUSTOM_DEPTH_STENCIL_ENABLE

◆ CMD_FORWARD_SHADING_ENABLE

◆ CMD_GC_DUMP_POOL_STATS

◆ CMD_HIGHRES_SCREENSHOT_DELAY

◆ CMD_MEMORY_REPORT