UCameraAnimationCameraModifier

A camera modifier that plays camera animation sequences.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraModifier

UCameraAnimationCameraModifier

References

Module

GameplayCameras

Header

/Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/CameraAnimationCameraModifier.h

Include

#include "CameraAnimationCameraModifier.h"

Syntax

UCLASS(Config=Camera)
class UCameraAnimationCameraModifier : public UCameraModifier

Remarks

A camera modifier that plays camera animation sequences.

Variables

Name Description

Protected variable UProperty

TArray< FActive...

 

ActiveAnimations

List of active camera animation instances

Protected variable UProperty

uint16

 

InstanceSerialNumber

Next serial number to use for a camera animation instance

Constructors

Name Description

Public function

UCameraAnimationCameraModifier

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

DeactivateCameraAnimation

(
    int32 Index
)

Protected function Static

float

 

EvaluateEasing

(
    ECameraAnimationEasingType EasingTy...,
    float Interp
)

Protected function

int32

 

FindInactiveCameraAnimation()

Protected function Const

const FActiv...

 

GetActiveCameraAnimation

(
    const FCameraAnimationHandle& Hand...
)

Protected function

FActiveCamer...

 

GetActiveCameraAnimation

(
    const FCameraAnimationHandle& Hand...
)

Public function Static UFunction BlueprintPure, Category, Meta

UCameraAnima...

 

GetCameraAnimationCameraModifier

(
    const UObject* WorldContextObj...,
    int32 PlayerIndex
)

Public function Static UFunction BlueprintPure, Category, Meta

UCameraAnima...

 

GetCameraAnimationCameraModifierFromID

(
    const UObject* WorldContextObj...,
    int32 ControllerID
)

Public function Static UFunction BlueprintPure, Category

UCameraAnima...

 

GetCameraAnimationCameraModifierFromPlayerController

(
    const APlayerController* Playe...
)

Public function Const UFunction BlueprintCallable, Category

bool

 

IsCameraAnimationActive

(
    const FCameraAnimationHandle& Hand...
)

Returns whether the given camera animation is playing.

Public function UFunction BlueprintCallable, Category

FCameraAnima...

 

PlayCameraAnimation

(
    UCameraAnimationSequence* Sequ...,
    FCameraAnimationParams Params
)

Play a new camera animation sequence.

Public function Virtual UFunction BlueprintCallable, Category

void

 

StopAllCameraAnimations

(
    bool bImmediate
)

Stop all camera animation instances.

Public function UFunction BlueprintCallable, Category

void

 

StopAllCameraAnimationsOf

(
    UCameraAnimationSequence* Sequ...,
    bool bImmediate
)

Stop playing all instances of the given camera animation sequence.

Public function UFunction BlueprintCallable, Category

void

 

StopCameraAnimation

(
    const FCameraAnimationHandle& Hand...,
    bool bImmediate
)

Stops the given camera animation instance.

Protected function

void

 

TickAllAnimations

(
    float DeltaTime,
    FMinimalViewInfo& InOutPOV
)

Protected function

void

 

TickAnimation

(
    FActiveCameraAnimationInfo& Camera...,
    float DeltaTime,
    FMinimalViewInfo& InOutPOV
)

Overridden from UCameraModifier

Name Description

Public function Virtual

void

 

DisplayDebug

(
    UCanvas* Canvas,
    const FDebugDisplayInfo& DebugDisp...,
    float& YL,
    float& YPos
)

Allows camera modifiers to output debug text during "showdebug camera"

Public function Virtual

bool

 

ModifyCamera

(
    float DeltaTime,
    FMinimalViewInfo& InOutPOV
)

Directly modifies variables in the owning camera