UCameraAnimationSequencePlayer

A lightweight sequence player for playing camera animation sequences.

API > API/Plugins > API/Plugins/TemplateSequence

Inheritance Hierarchy

  • UObject
  • IMovieScenePlayer
  • UCameraAnimationSequencePlayer

References

   
Module TemplateSequence
Header /Engine/Plugins/MovieScene/TemplateSequence/Source/TemplateSequence/Public/CameraAnimationSequencePlayer.h
Include #include "CameraAnimationSequencePlayer.h"

Syntax

UCLASS ()  
class UCameraAnimationSequencePlayer :  
    public UObject,  
    public IMovieScenePlayer

Remarks

A lightweight sequence player for playing camera animation sequences.

Constructors

  Type Name Description
Public function  

UCameraAnimationSequencePlayer ( const FObjectInitializer& ObjInit
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual UObject *  
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual UMovieSceneEntitySystemLinker *  
Public function void Ends scrub mode
Public function Const FFrameTime Gets the current play position in frames (display rate)
Public function Const FFrameTime Get the duration of the current sequence in frames (display rate)
Public function Virtual FMovieSceneRootEvaluationTemplateInstance &  
Public function Const FFrameRate Get the sequence display rate
Public function Const bool Gets whether playback is looping
Public function Const FFrameRate Get the sequence tick resolution
Public function Virtual Const EMovieScenePlayerStatus::Type  
Public function Virtual FMovieSceneSpawnRegister &  
Public function Const FFrameNumber Get the start frame of the current sequence
Public function Virtual Const void

GetViewportSettings ( TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
)

  
Public function void

Initialize ( UMovieSceneSequence* InSequence,
int32 StartOffset,
float DurationOverride
)

 Initializes this player with the given sequence
Public function Virtual Const bool  
Public function void

Jump ( FFrameTime NewPosition
)

 Jumps to the given time, in ticks
Public function void

Play ( bool bLoop,
bool bRandomStartTime
)

 Start playing the sequence
Protected function Virtual Const void

ResolveBoundObjects ( UE::UniversalObjectLocator::FResolveParams& ResolveParams,
const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
)

  
Public function void

SetBoundObjectOverride ( UObject* InObject
)

 Sets an object that can be used to bind everything in the sequence
Public function Virtual void

SetPlaybackStatus ( EMovieScenePlayerStatus::Type InPlaybackStatus
)

  
Public function Virtual void

SetViewportSettings ( const TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
)

  
Public function void Sets the player in scrub mode
Public function void

Stop ()

 Stop playing the sequence
Public function void

Update ( FFrameTime NewPosition
)

 Advance play to the given time
Public function Virtual void

UpdateCameraCut ( UObject* CameraObject,
const EMovieSceneCameraCutParams& CameraCutParams
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page