1. Epic GamesDeveloper
  3. FChaosVDPlaybackController

FChaosVDPlaybackController

Loads,unloads and owns a Chaos VD recording file

API > API/Plugins > API/Plugins/ChaosVD

Inheritance Hierarchy

References

   
Module ChaosVD
Header /Engine/Plugins/Experimental/ChaosVD/Source/ChaosVD/Public/ChaosVDPlaybackController.h
Include #include "ChaosVDPlaybackController.h"

Syntax

class FChaosVDPlaybackController : public TSharedFromThis< FChaosVDPlaybackController >

Remarks

Loads,unloads and owns a Chaos VD recording file

Variables

  Type Name Description
Protected variable FChaosVDPlaybackControllerFrameUpdated ControllerFrameUpdatedDelegate Delegate called when the a in a track changes
Protected variable FChaosVDPlaybackControllerUpdated ControllerUpdatedDelegate Delegate called when the data on the loaded recording changes
Protected variable TSharedPtr< FChaosVDRecording > LoadedRecording Ptr to the loaded recording
Protected variable TWeakPtr< FChaosVDScene > SceneToControl Ptr to the current Chaos VD Scene this controller controls
Protected variable TMap< EChaosVDTrackType, TrackInfoByIDMap > TrackInfoPerType Map containing all track info, by track type

Constructors

  Type Name Description
Public function  

FChaosVDPlaybackController ( const TWeakPtr< FChaosVDScene >& InSceneToControl
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function int32 Converts the current frame number of a track, to a frame number in other tracks space time
Public function void

GetAvailableTrackInfosAtTrackFrame ( EChaosVDTrackType TrackTypeToFind,
TArray< TSharedPtr< FChaosVDTrackInfo >>& OutTrackInfo,
const FChaosVDTrackInfo* TrackFrameInfo
)

 Gets all the ids of the tracks, of the specified type, that are available available on the loaded recording, at a specified frame
Public function void Gets all the ids of the tracks, of the specified type, that are available available on the loaded recording
Public function TWeakPtr< FChaosVDScene > Returns a weak ptr to the Scene this controller is controlling during playback
Public function TWeakPtr< FChaosVDRecording > Returns a weak ptr pointer to the loaded recording
Public function FChaosVDTrackInfo *

GetMutableTrackInfo ( EChaosVDTrackType TrackType,
int32 TrackID
)

 Gets the track info of the specified type with the specified ID
Public function Const int32

GetTrackCurrentFrame ( EChaosVDTrackType TrackType,
int32 InTrackID
)

 Gets the current frame number at which the specified track is at
Public function Const int32

GetTrackCurrentStep ( EChaosVDTrackType TrackType,
int32 InTrackID
)

 Gets the number of available frames for the specified track
Public function Const int32

GetTrackFramesNumber ( EChaosVDTrackType TrackType,
int32 InTrackID
)

 Gets the number of available frames for the specified track
Public function const FChaosVDTrackInfo *

GetTrackInfo ( EChaosVDTrackType TrackType,
int32 TrackID
)

 Gets the track info of the specified type with the specified ID
Public function Const int32

GetTrackLastStepAtFrame ( EChaosVDTrackType TrackType,
int32 InTrackID,
int32 InFrameNumber
)

 Gets the index number of the last step available (available steps -1)
Public function Const const FChaosVDStepsContainer *

GetTrackStepsDataAtFrame ( EChaosVDTrackType TrackType,
int32 InTrackID,
int32 FrameNumber
)

 Gets the available steps container in a track at the specified frame
Public function Const int32

GetTrackStepsNumberAtFrame ( EChaosVDTrackType TrackType,
int32 InTrackID,
int32 FrameNumber
)

 Gets the number of available steps in a track at the specified frame
Protected function void

GoToRecordedGameFrame ( int32 FrameNumber,
FGuid InstigatorID
)

 Updates the controlled scene with the loaded data at specified game frame
Protected function void

GoToRecordedSolverStep ( int32 InTrackID,
int32 FrameNumber,
int32 Step,
FGuid InstigatorID
)

 Updates the controlled scene with the loaded data at specified solver frame and solver step
Public function void

GoToTrackFrame ( FGuid InstigatorID,
EChaosVDTrackType TrackType,
int32 InTrackID,
int32 FrameNumber,
int32 Step
)

 Moves a track of the recording to the specified step and frame numbers
Protected function void Handles any data changes on the loaded recording - Usually called during Trace analysis
Public function Const bool Returns true if the controller has a valid recording loaded
Public function bool Loads a recording using a Trace Session Name
Public function void

LockTrackInCurrentStep ( EChaosVDTrackType TrackType,
int32 TrackID
)

 Locks the steps timeline of a given track so each time you move between frames, it will automatically scrub to the locked in step
Public function FChaosVDPlaybackControllerUpdated & Called when data on the recording being controlled gets updated internally or externally (for example, during Trace Analysis)
Public function FChaosVDPlaybackControllerFrameUpdated & Called when a frame on a track is updated
Protected function void

PlayFromClosestKeyFrame ( int32 InTrackID,
int32 FrameNumber,
FChaosVDScene& InSceneToControl
)

 Finds the closest Key frame to the provided frame number, and plays all the following frames until the specified frame number (no inclusive)
Public function void Unloads the currently loaded recording
Public function void

UnlockTrackStep ( EChaosVDTrackType TrackType,
int32 TrackID
)

 UnLocks the steps timeline of a given track so each time you move between frames, it will automatically scrub to the default step
Protected function void Updates (or adds) solvers data from the loaded recording to the solver tracks

Constants

Name Description
GameTrackID ID used for the Game Track

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page