NVIDIA DeepLearning Dataset Synthesizer (NDDS)
 All Classes Namespaces Functions Variables Typedefs Pages
ANVSceneCapturerActor Class Reference

The scene exporter actor. More...

+ Inheritance diagram for ANVSceneCapturerActor:
+ Collaboration diagram for ANVSceneCapturerActor:

Public Member Functions

 ANVSceneCapturerActor (const FObjectInitializer &ObjectInitializer)
 Use SpawnActor() to create this instance. More...
 
float GetCapturedDuration () const
 
float GetCapturedFPS () const
 Capturing information. More...
 
FNVFrameCounter GetCapturedFrameCounter () const
 Frame counters. More...
 
float GetCaptureProgressFraction () const
 
ENVSceneCapturerState GetCurrentState () const
 
float GetEstimatedTimeUntilFinishCapturing () const
 
int32 GetNumberOfFramesLeftToCapture () const
 
int32 GetNumberOfFramesToCapture () const
 
UNVSceneDataHandlerGetSceneDataHandler () const
 Control what to do with the captured scene data. More...
 
UNVSceneDataVisualizerGetSceneDataVisualizer () const
 Control what to do with the captured scene data. More...
 
TArray
< UNVSceneCapturerViewpointComponent * > 
GetViewpointList ()
 
void PauseCapturing ()
 
void ResumeCapturing ()
 
void ReturnViewportToPlayerController ()
 
void SetNumberOfFramesToCapture (int32 NewSceneCount)
 Setter and Getter for Number of scene to capture. More...
 
void StartCapturing ()
 Capture controls. More...
 
void StopCapturing ()
 
void TakeOverViewport ()
 
bool ToggleTakeOverViewport ()
 return false means PlayerController view. true means Viewport is taken over. More...
 

Static Public Member Functions

static TArray
< FNVNamedImageSizePreset >
const & 
GetImageSizePresets ()
 

Public Attributes

bool bIsActive
 Whether this capturer actor is active and can start capturing or not. More...
 
FNVSceneCapturerSettings CapturerSettings
 
TArray
< FNVFeatureExtractorSettings
FeatureExtractorSettings
 List of the feature extractors this capturer support. More...
 
FNVSceneCapturer_Completed OnCompletedEvent
 
FNVSceneCapturer_Started OnStartedEvent
 Event properties. More...
 
FNVSceneCapturer_Stopped OnStoppedEvent
 

Protected Member Functions

virtual void BeginPlay () final
 
bool CanHandleMoreSceneData () const
 
void CaptureSceneToPixelsData ()
 
void CheckCaptureScene ()
 
virtual void EndPlay (const EEndPlayReason::Type EndPlayReason) final
 
void OnCompleted ()
 
virtual void PostInitializeComponents () final
 
virtual void PostLoad () final
 
void ResetCounter ()
 
void StartCapturing_Internal ()
 
virtual void Tick (float DeltaTime) final
 
void UpdateCapturerSettings ()
 
void UpdateSettingsFromCommandLine ()
 
void UpdateViewpointList ()
 

Protected Attributes

bool bAutoStartCapturing
 If true, this capturer will automatically start capturing the scene right when the game start (every TimeBetweenSceneExport seconds) More...
 
bool bNeedToExportScene
 
bool bPauseGameLogicWhenFlushing
 If true, the capturer will pause the game logic when it's trying to flushing - handle the scene data from previous frame. More...
 
bool bSkipFirstFrame
 
bool bTakeOverGameViewport
 If true, the player's camera will be tied to this exporter's location and rotation. More...
 
bool bTakingOverViewport
 
AActor * CachedPlayerControllerViewTarget
 
float CapturedDuration
 
FNVFrameCounter CapturedFrameCounter
 
class USphereComponent * CollisionComponent
 Collision of the capturer actor. More...
 
ENVSceneCapturerState CurrentState
 
TArray< FNVNamedImageSizePresetImageSizePresets
 List of available image size presets. More...
 
float LastCaptureTimestamp
 
int32 MaxNumberOfFramesToCapture
 Maximum number of scenes (>= 0) to export before stopping NOTE: If TotalNumberOfScenesToExport == 0 then the exporter will keep exporting without limit until told to stop. More...
 
int32 NumberOfFramesToCapture
 
class UNVSceneDataHandlerSceneDataHandler
 Control what to do with the captured scene data. More...
 
class UNVSceneDataVisualizerSceneDataVisualizer
 Control what to do with the captured scene data. More...
 
float StartCapturingDuration
 
float StartCapturingTimestamp
 
float TimeBetweenSceneCapture
 NOTE: TimeBetweenSceneExport <= 0 mean export every frame. More...
 
FTimerHandle TimeHandle_StartCapturingDelay
 
TArray
< UNVSceneCapturerViewpointComponent * > 
ViewpointList
 

Detailed Description

The scene exporter actor.

Definition at line 126 of file NVSceneCapturerActor.h.

Constructor & Destructor Documentation

ANVSceneCapturerActor::ANVSceneCapturerActor ( const FObjectInitializer &  ObjectInitializer)

Use SpawnActor() to create this instance.

Member Function Documentation

float ANVSceneCapturerActor::GetCapturedFPS ( ) const

Capturing information.

FNVFrameCounter ANVSceneCapturerActor::GetCapturedFrameCounter ( ) const
inline

Frame counters.

Definition at line 171 of file NVSceneCapturerActor.h.

UNVSceneDataHandler* ANVSceneCapturerActor::GetSceneDataHandler ( ) const

Control what to do with the captured scene data.

UNVSceneDataVisualizer* ANVSceneCapturerActor::GetSceneDataVisualizer ( ) const

Control what to do with the captured scene data.

void ANVSceneCapturerActor::SetNumberOfFramesToCapture ( int32  NewSceneCount)

Setter and Getter for Number of scene to capture.

void ANVSceneCapturerActor::StartCapturing ( )

Capture controls.

bool ANVSceneCapturerActor::ToggleTakeOverViewport ( )

return false means PlayerController view. true means Viewport is taken over.

Member Data Documentation

bool ANVSceneCapturerActor::bAutoStartCapturing
protected

If true, this capturer will automatically start capturing the scene right when the game start (every TimeBetweenSceneExport seconds)

Definition at line 248 of file NVSceneCapturerActor.h.

bool ANVSceneCapturerActor::bIsActive

Whether this capturer actor is active and can start capturing or not.

Definition at line 232 of file NVSceneCapturerActor.h.

bool ANVSceneCapturerActor::bPauseGameLogicWhenFlushing
protected

If true, the capturer will pause the game logic when it's trying to flushing - handle the scene data from previous frame.

Definition at line 273 of file NVSceneCapturerActor.h.

bool ANVSceneCapturerActor::bTakeOverGameViewport
protected

If true, the player's camera will be tied to this exporter's location and rotation.

Definition at line 261 of file NVSceneCapturerActor.h.

class USphereComponent* ANVSceneCapturerActor::CollisionComponent
protected

Collision of the capturer actor.

Definition at line 244 of file NVSceneCapturerActor.h.

TArray<FNVFeatureExtractorSettings> ANVSceneCapturerActor::FeatureExtractorSettings

List of the feature extractors this capturer support.

Definition at line 239 of file NVSceneCapturerActor.h.

TArray<FNVNamedImageSizePreset> ANVSceneCapturerActor::ImageSizePresets
protected

List of available image size presets.

Definition at line 277 of file NVSceneCapturerActor.h.

int32 ANVSceneCapturerActor::MaxNumberOfFramesToCapture
protected

Maximum number of scenes (>= 0) to export before stopping NOTE: If TotalNumberOfScenesToExport == 0 then the exporter will keep exporting without limit until told to stop.

Definition at line 257 of file NVSceneCapturerActor.h.

FNVSceneCapturer_Started ANVSceneCapturerActor::OnStartedEvent

Event properties.

Definition at line 202 of file NVSceneCapturerActor.h.

class UNVSceneDataHandler* ANVSceneCapturerActor::SceneDataHandler
protected

Control what to do with the captured scene data.

Definition at line 265 of file NVSceneCapturerActor.h.

class UNVSceneDataVisualizer* ANVSceneCapturerActor::SceneDataVisualizer
protected

Control what to do with the captured scene data.

Definition at line 269 of file NVSceneCapturerActor.h.

float ANVSceneCapturerActor::TimeBetweenSceneCapture
protected

NOTE: TimeBetweenSceneExport <= 0 mean export every frame.

Definition at line 252 of file NVSceneCapturerActor.h.


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