Navigation
API > API/Plugins > API/Plugins/TemplateSequence
A lightweight sequence player for playing camera animation sequences.
| Name | UCameraAnimationSequencePlayer |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/TemplateSequence/Source/TemplateSequence/Public/CameraAnimationSequencePlayer.h |
| Include Path | #include "CameraAnimationSequencePlayer.h" |
Syntax
UCLASS (MinimalAPI)
class UCameraAnimationSequencePlayer :
public UObject ,
public IMovieScenePlayer
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraAnimationSequencePlayer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCameraAnimationSequencePlayer
(
const FObjectInitializer& ObjInit |
CameraAnimationSequencePlayer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UCameraAnimationSequencePlayer() |
CameraAnimationSequencePlayer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDurationRequiresLooping | bool | Whether we need to loop due to a duration override | CameraAnimationSequencePlayer.h | |
| bIsLooping | bool | Whether we should be looping | CameraAnimationSequencePlayer.h | |
| BoundObjectOverride | TObjectPtr< UObject > | Bound object overrides | CameraAnimationSequencePlayer.h |
|
| DurationFrames | FFrameTime | The sequence duration in frames | CameraAnimationSequencePlayer.h | |
| LoopsPlayed | uint16 | Accumulated number of loops played so far | CameraAnimationSequencePlayer.h | |
| PlayPosition | FMovieScenePlaybackPosition | Play position helper | CameraAnimationSequencePlayer.h | |
| RootTemplateInstance | FMovieSceneRootEvaluationTemplateInstance | The evaluation template instance | CameraAnimationSequencePlayer.h |
|
| Sequence | TObjectPtr< UMovieSceneSequence > | The sequence to play back | CameraAnimationSequencePlayer.h |
|
| SpawnRegister | FSequenceCameraShakeSpawnRegister | CameraAnimationSequencePlayer.h | ||
| StartFrame | FFrameNumber | Start frame for the sequence | CameraAnimationSequencePlayer.h | |
| Status | TEnumAsByte< EMovieScenePlayerStatus::Type > | Movie player status. | CameraAnimationSequencePlayer.h | |
| TotalDurationFrames | FFrameTime | The total duration we need to play | CameraAnimationSequencePlayer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameTime GetCurrentPosition() |
Gets the current play position in frames (display rate) | CameraAnimationSequencePlayer.h | |
FFrameTime GetDuration() |
Get the duration of the current sequence in frames (display rate) | CameraAnimationSequencePlayer.h | |
FFrameRate GetInputRate() |
Get the sequence display rate | CameraAnimationSequencePlayer.h | |
bool GetIsLooping() |
Gets whether playback is looping | CameraAnimationSequencePlayer.h | |
FFrameRate GetOutputRate() |
Get the sequence tick resolution | CameraAnimationSequencePlayer.h | |
FFrameNumber GetStartFrame() |
Get the start frame of the current sequence | CameraAnimationSequencePlayer.h | |
void Initialize
(
UMovieSceneSequence* InSequence, |
Initializes this player with the given sequence | CameraAnimationSequencePlayer.h | |
bool IsValid () |
Returns whether this player is still valid. | CameraAnimationSequencePlayer.h | |
void Jump
(
FFrameTime NewPosition |
Jumps to the given time, in ticks | CameraAnimationSequencePlayer.h | |
void Play
(
bool bLoop, |
Start playing the sequence | CameraAnimationSequencePlayer.h | |
void SetBoundObjectOverride
(
UObject* InObject |
Sets an object that can be used to bind everything in the sequence | CameraAnimationSequencePlayer.h | |
void Stop() |
Stop playing the sequence | CameraAnimationSequencePlayer.h | |
void Update
(
FFrameTime NewPosition |
Advance play to the given time | CameraAnimationSequencePlayer.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
CameraAnimationSequencePlayer.h | ||
virtual bool IsDestructionThreadSafe() |
CameraAnimationSequencePlayer.h |
Overridden from IMovieScenePlayer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UObject * AsUObject() |
CameraAnimationSequencePlayer.h | ||
virtual bool CanUpdateCameraCut() |
CameraAnimationSequencePlayer.h | ||
virtual UMovieSceneEntitySystemLinker * ConstructEntitySystemLinker() |
CameraAnimationSequencePlayer.h | ||
virtual FMovieSceneRootEvaluationTemplateInstance & GetEvaluationTemplate() |
CameraAnimationSequencePlayer.h | ||
virtual EMovieScenePlayerStatus::Type GetPlaybackStatus() |
CameraAnimationSequencePlayer.h | ||
virtual FMovieSceneSpawnRegister & GetSpawnRegister() |
CameraAnimationSequencePlayer.h | ||
virtual void GetViewportSettings
(
TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap |
CameraAnimationSequencePlayer.h | ||
virtual void SetPlaybackStatus
(
EMovieScenePlayerStatus::Type InPlaybackStatus |
CameraAnimationSequencePlayer.h | ||
virtual void SetViewportSettings
(
const TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap |
CameraAnimationSequencePlayer.h | ||
virtual void UpdateCameraCut
(
UObject* CameraObject, |
CameraAnimationSequencePlayer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnAbandonLinker
(
UMovieSceneEntitySystemLinker* InLinker |
CameraAnimationSequencePlayer.h |
Overridden from IMovieScenePlayer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ResolveBoundObjects
(
UE::UniversalObjectLocator::FResolveParams& ResolveParams, |
CameraAnimationSequencePlayer.h |