UCameraAnimInst

A CameraAnimInst is an active instance of a CameraAnim.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Camera/CameraAnimInst.h

Include

#include "Camera/CameraAnimInst.h"

Syntax

class UCameraAnimInst : public UObject

Remarks

A CameraAnimInst is an active instance of a CameraAnim.

Variables

Name Description

Public variable

float

 

BasePlayScale

"Intensity" value used to scale keyframe values.

Protected variable

uint32: 1

 

bBlendingIn

True if currently blending in.

Protected variable

uint32: 1

 

bBlendingOut

True if currently blending out.

Public variable

uint32: 1

 

bFinished

True if the animation has finished, false otherwise.

Protected variable

uint32: 1

 

bHasFOVTrack

True if this camera anim has a track modifying the FOV

Protected variable

float

 

BlendInTime

Time to interpolate in from zero, for smooth starts.

Protected variable

float

 

BlendOutTime

Time to interpolate out to zero, for smooth finishes.

Protected variable

uint32: 1

 

bLooping

True if the animation should loop, false otherwise.

Protected variable

uint32: 1

 

bStopAutomatically

If true, this anim inst will automatically stop itself when it finishes, otherwise, it will wait for an explicit Stop() call.

Public variable

UCameraAnim ...

 

CamAnim

Which CameraAnim this is an instance of

Protected variable

float

 

CurBlendInTime

Current time for the blend-in. I.e. how long we have been blending.

Protected variable

float

 

CurBlendOutTime

Current time for the blend-out. I.e. how long we have been blending.

Public variable

float

 

CurrentBlendWeight

Number in range [0..1], controlling how much this influence this instance should have.

Public variable

float

 

CurTime

Current time for the animation

Public variable

FTransform

 

InitialCamToWorld

Transform of initial anim key, used for treating anim keys as offsets from initial key

Public variable

float

 

InitialFOV

FOV of the initial anim key, used for treating fov keys as offsets from initial key.

Public variable

FVector

 

LastCameraLoc

Camera Anim debug variable to trace back to previous location

Public variable

UInterpTrackIns...

 

MoveInst

Public variable

UInterpTrackMov...

 

MoveTrack

Cached movement track from the currently playing anim so we don't have to go find it every frame

Public variable

float

 

PlayRate

Multiplier for playback rate. 1.0 = normal.

Public variable

TEnumAsByte< EC...

 

PlaySpace

Protected variable

float

 

RemainingTime

How much longer to play the anim, if a specific duration is desired. Has no effect if 0.

Public variable

float

 

TransientScaleModifier

A supplemental scale factor, allowing external systems to scale this anim as necessary.

Public variable

FMatrix

 

UserPlaySpaceMatrix

The user-defined space for UserDefined PlaySpace

Constructors

Name Description

Public function

UCameraAnimInst

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AdvanceAnim

(
    float DeltaTime,
    bool bJump
)

Advances the animation by the specified time - updates any modified interp properties, moves the group actor, etc

Public function Const

void

 

ApplyToView

(
    FMinimalViewInfo& InOutPOV
)

Takes the given view and applies the camera anim transform and fov changes to it.

Public function

void

 

ApplyTransientScaling

(
    float Scalar
)

Applies given scaling factor to the playing animation for the next update only.

Public function Const

float

 

GetCurrentTime()

Returns the current playback time.

Protected function Const

UInterpGroup...

 

GetInterpGroupInst()

Returns InterpGroupInst subobject

Public function

void

 

Play

(
    UCameraAnim* Anim,
    AActor* CamActor,
    float InRate,
    float InScale,
    float InBlendInTime,
    float InBlendOutTime,
    bool bInLoop,
    bool bRandomStartTime,
    float Duration
)

Starts this instance playing the specified CameraAnim.

Public function

void

 

SetCurrentTime

(
    float NewTime
)

Jumps he camera anim to the given (unscaled) time.

Public function

void

 

SetDuration

(
    float NewDuration
)

Changes the running duration of this active anim, while maintaining playback position.

Public function

void

 

SetPlaySpace

(
    ECameraAnimPlaySpace::Type NewSpace,
    FRotator UserPlaySpace
)

Sets this anim to play in an alternate playspace

Public function

void

 

SetScale

(
    float NewDuration
)

Changes the scale of the animation while playing.

Public function

void

 

SetStopAutomatically

(
    bool bNewStopAutoMatically
)

Sets whether this anim instance should automatically stop when finished.

Public function

void

 

Stop

(
    bool bImmediate
)

Stops this instance playing whatever animation it is playing.

Public function

void

 

Update

(
    float NewRate,
    float NewScale,
    float NewBlendInTime,
    float NewBlendOutTime,
    float NewDuration
)

Updates this active instance with new parameters.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback