RapyutaSimulationPlugins
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
ARRSceneDirector Class Reference

Execute Init/Run/Continue Sim type-specific operations (Data synthesizer/collection or Robot operations, etc. or compound) with #ARRSceneInstance. More...

#include <RRSceneDirector.h>

Inheritance diagram for ARRSceneDirector:
Inheritance graph
[legend]
Collaboration diagram for ARRSceneDirector:
Collaboration graph
[legend]

Public Member Functions

 ARRSceneDirector ()
 
bool HasSceneInitialized ()
 
virtual bool HasOperationCompleted (bool bIsLogged=false)
 
- Public Member Functions inherited from ARRBaseActor
 ARRBaseActor ()
 Construct a new ARRBaseActor object. More...
 
 ARRBaseActor (const FObjectInitializer &ObjectInitializer)
 Construct a new ARRBaseActor object. More...
 
void SetupDefaultBase ()
 Initialize default components being configurable in child BP classes. More...
 
void SetEntityModelName (const FString &InEntityModelName)
 
bool IsDataSynthEntity () const
 
template<typename TActorSpawnInfo >
bool InitializeWithSpawnInfo (const TActorSpawnInfo &InActorInfo)
 ACTOR INTIALIZING GENERAL INFO (Unique name, mesh list, material list, etc.) More...
 
virtual bool HasInitialized (bool bIsLogged=false) const
 
virtual void Reset ()
 Rest. Calls #ActorInfo::ClearMeshInfo. More...
 
void SetTickEnabled (bool bInIsTickEnabled)
 Use URRUObjectUtils::SetupActorTick. More...
 
virtual void GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
 Returns the properties used for network replication, this needs to be overridden by all actor classes with native. More...
 

Public Attributes

int32 OperationBatchId = 0
 
FString SceneName
 
APostProcessVolume * MainPostProcessVolume = nullptr
 
ARRCameraSceneCamera = nullptr
 
FOnSpawnedActorsSettled OnSpawnedActorsSettled
 
double DataCollectionTimeStamp = 0.f
 
TArray< int32 > SceneEntityMaskValueList
 
- Public Attributes inherited from ARRBaseActor
TSharedPtr< FRRActorSpawnInfoActorInfo = nullptr
 
ARRGameStateRRGameState = nullptr
 Pointer for convinience. Since this pointer can be nullptr, you need null check before using. More...
 
URRGameSingletonRRGameSingleton = nullptr
 Pointer for convinience. Since this pointer can be nullptr, you need null check before using. More...
 
ARRGameModeRRGameMode = nullptr
 Pointer for convinience. Since this pointer can be nullptr, you need null check before using. More...
 
ARRPlayerControllerRRPlayerController = nullptr
 Pointer for convinience. Since this pointer can be nullptr, you need null check before using. More...
 
int8 SceneInstanceId = URRActorCommon::DEFAULT_SCENE_INSTANCE_ID
 
URRActorCommonActorCommon = nullptr
 
FString EntityUniqueName
 Actually Object's Name is also unique as noted by UE, but we just do not want to rely on it. More...
 
FString EntityModelName
 
FTimerHandle GenericTimerHandle
 

Protected Member Functions

virtual bool Initialize () override
 Call TryInitializeOperation() repeatedly. More...
 
virtual bool InitializeOperation ()
 Start (Initialize + Run) Operation. More...
 
virtual void RunOperation ()
 Called inside from InitializeOperation and SpawnActors(). More...
 
virtual void ContinueOperation (bool bIsLastOperationSuccessful, bool bContinueRGBRandomizing)
 
virtual void OnDataCollectionPhaseDone (bool bIsFinalDataCollectingPhase)
 
virtual void EndSceneInstance ()
 
virtual void DoDataCollecting ()
 
virtual void SpawnActors ()
 
virtual void ResetScene ()
 
- Protected Member Functions inherited from ARRBaseActor
virtual void PreInitializeComponents () override
 Set #GameMode #GameState #GameSingleton #PlayerController. More...
 
virtual void PrintSimConfig () const
 Print class members' values configured in RapyutaSimSettings.ini. More...
 
virtual void DoGlobalConfig ()
 Globally config custom setups (eg. Exec() cmds) applied for all instances of this class. More...
 

Protected Attributes

FTimerHandle InitializationTimerHandle
 
FTimerHandle DataCollectionTimerHandle
 
uint8 bIsDataCollecting: 1
 
uint8 bIsOperating: 1
 
int32 OperationBatchLoopLeft = 0
 

Private Member Functions

void TryInitializeOperation ()
 Initialize Scene by InitializeOperation() or exit with timeout. More...
 

Private Attributes

FDateTime LastTimeStamp
 
uint8 bSceneInitialized: 1
 

Additional Inherited Members

- Static Public Attributes inherited from ARRBaseActor
static TMap< UClass *, TUniquePtr< std::once_flag > > OnceFlagList
 [std::once_flag] also applies even in case of consecutive PIE runs, More...
 
static std::once_flag OnceFlag
 Used for class having single-branch child classes (linear inheritance tree) More...
 
static int8 SSceneInstanceId
 

Detailed Description

Execute Init/Run/Continue Sim type-specific operations (Data synthesizer/collection or Robot operations, etc. or compound) with #ARRSceneInstance.

UCLASS()

Constructor & Destructor Documentation

◆ ARRSceneDirector()

ARRSceneDirector::ARRSceneDirector ( )

Member Function Documentation

◆ ContinueOperation()

virtual void ARRSceneDirector::ContinueOperation ( bool  bIsLastOperationSuccessful,
bool  bContinueRGBRandomizing 
)
inlineprotectedvirtual

◆ DoDataCollecting()

virtual void ARRSceneDirector::DoDataCollecting ( )
inlineprotectedvirtual

◆ EndSceneInstance()

virtual void ARRSceneDirector::EndSceneInstance ( )
protectedvirtual

◆ HasOperationCompleted()

virtual bool ARRSceneDirector::HasOperationCompleted ( bool  bIsLogged = false)
virtual

◆ HasSceneInitialized()

bool ARRSceneDirector::HasSceneInitialized ( )
inline

◆ Initialize()

virtual bool ARRSceneDirector::Initialize ( )
overrideprotectedvirtual

Call TryInitializeOperation() repeatedly.

Returns
true
false

Reimplemented from ARRBaseActor.

◆ InitializeOperation()

virtual bool ARRSceneDirector::InitializeOperation ( )
protectedvirtual

Start (Initialize + Run) Operation.

Get #RRActorCommon, ScneneCamera, MainPostProcessVolume, and RunOperation().

Returns
true
false

◆ OnDataCollectionPhaseDone()

virtual void ARRSceneDirector::OnDataCollectionPhaseDone ( bool  bIsFinalDataCollectingPhase)
protectedvirtual

◆ ResetScene()

virtual void ARRSceneDirector::ResetScene ( )
protectedvirtual

◆ RunOperation()

virtual void ARRSceneDirector::RunOperation ( )
protectedvirtual

Called inside from InitializeOperation and SpawnActors().

◆ SpawnActors()

virtual void ARRSceneDirector::SpawnActors ( )
inlineprotectedvirtual

◆ TryInitializeOperation()

void ARRSceneDirector::TryInitializeOperation ( )
private

Initialize Scene by InitializeOperation() or exit with timeout.

UFUNCTION()

Member Data Documentation

◆ bIsDataCollecting

uint8 ARRSceneDirector::bIsDataCollecting
protected

◆ bIsOperating

uint8 ARRSceneDirector::bIsOperating
protected

◆ bSceneInitialized

uint8 ARRSceneDirector::bSceneInitialized
private

◆ DataCollectionTimerHandle

FTimerHandle ARRSceneDirector::DataCollectionTimerHandle
protected

◆ DataCollectionTimeStamp

double ARRSceneDirector::DataCollectionTimeStamp = 0.f

◆ InitializationTimerHandle

FTimerHandle ARRSceneDirector::InitializationTimerHandle
protected

◆ LastTimeStamp

FDateTime ARRSceneDirector::LastTimeStamp
private

◆ MainPostProcessVolume

APostProcessVolume* ARRSceneDirector::MainPostProcessVolume = nullptr

◆ OnSpawnedActorsSettled

FOnSpawnedActorsSettled ARRSceneDirector::OnSpawnedActorsSettled

◆ OperationBatchId

int32 ARRSceneDirector::OperationBatchId = 0

◆ OperationBatchLoopLeft

int32 ARRSceneDirector::OperationBatchLoopLeft = 0
protected

◆ SceneCamera

ARRCamera* ARRSceneDirector::SceneCamera = nullptr

◆ SceneEntityMaskValueList

TArray<int32> ARRSceneDirector::SceneEntityMaskValueList

◆ SceneName

FString ARRSceneDirector::SceneName

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