Navigation
API > API/Plugins > API/Plugins/TemplateSequence
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCameraAnimationSequencePlayer
References
| Module | TemplateSequence |
| Header | /Engine/Plugins/MovieScene/TemplateSequence/Source/TemplateSequence/Public/CameraAnimationSequencePlayer.h |
| Include | #include "CameraAnimationSequencePlayer.h" |
Syntax
UCLASS&40;&41;
class UCameraAnimationSequencePlayer :
public UObject,
public IMovieScenePlayer
Remarks
A lightweight sequence player for playing camera animation sequences.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UCameraAnimationSequencePlayer
(
const FObjectInitializer& ObjInit |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FFrameTime | Gets the current play position in frames (display rate) | |
  |
FFrameTime | GetDuration () |
Get the duration of the current sequence in frames (display rate) |
  |
FFrameRate | GetInputRate () |
Get the sequence display rate |
  |
bool | GetIsLooping () |
Gets whether playback is looping |
  |
FFrameRate | Get the sequence tick resolution | |
  |
FFrameNumber | Get the start frame of the current sequence | |
 |
void | Initialize
(
UMovieSceneSequence* InSequence, |
Initializes this player with the given sequence |
 |
void | Jump
(
FFrameTime NewPosition |
Jumps to the given time, in ticks |
 |
void | Play
(
bool bLoop, |
Start playing the sequence |
 |
void | SetBoundObjectOverride
(
UObject* InObject |
Sets an object that can be used to bind everything in the sequence |
 |
void | Stop () |
Stop playing the sequence |
 |
void | Update
(
FFrameTime NewPosition |
Advance play to the given time |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
   |
bool | Called during garbage collection to determine if an object can have its destructor called on a worker thread. |
Overridden from IMovieScenePlayer
| Type | Name | Description | |
|---|---|---|---|
  |
UObject * | AsUObject () |
Cast this player instance as a UObject if possible |
   |
bool | Whether this player can update the camera cut | |
  |
UMovieSceneEntitySystemLinker * | Called to retrieve or construct an entity linker for the specified playback context | |
  |
FMovieSceneRootEvaluationTemplateInstance & | Access the evaluation template that we are playing back | |
   |
EMovieScenePlayerStatus::Type | ||
  |
FMovieSceneSpawnRegister & | Obtain an object responsible for managing movie scene spawnables | |
   |
void | GetViewportSettings
(
TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap |
Get the current perspective viewport settings |
   |
void | ResolveBoundObjects
(
const FGuid& InBindingId, |
Resolve objects bound to the specified binding ID |
  |
void | SetPlaybackStatus
(
EMovieScenePlayerStatus::Type InPlaybackStatus |
|
  |
void | SetViewportSettings
(
const TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap |
Set the perspective viewport settings |
  |
void | UpdateCameraCut
(
UObject* CameraObject, |
Updates the perspective viewports with the actor to view through |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | EndScrubbing () |
EndScrubbing has been deprecated as it has no functionality |
 |
void | StartScrubbing has been deprecated as it has no functionality |