UCameraShakePattern

A shake "pattern" defines how a camera should be effectively shaken.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Camera/CameraShakeBase.h"

Syntax

class UCameraShakePattern : public UObject

Remarks

A shake "pattern" defines how a camera should be effectively shaken. Examples of shake patterns are sinewave oscillation, perlin noise, or FBX animation.

Constructors

Name Description

Public function

UCameraShakePattern

(
    const FObjectInitializer& ObjectIn...
)

Constructor for a shake pattern

Functions

Name Description

Protected function Const

UCameraShake...

 

GetShakeInstance()

Gets the shake pattern's parent shake

Protected function Const

InstanceType...

 

GetShakeInstance()

Gets the shake pattern's parent shake

Public function Const

void

 

GetShakePatternInfo

(
    FCameraShakeInfo& OutInfo
)

Gets information about this shake pattern

Public function Const

bool

 

IsFinished()

Returns whether this shake pattern is finished

Public function

void

 

ScrubShakePattern

(
    const FCameraShakeScrubParams& Par...,
    FCameraShakeUpdateResult& OutResul...
)

Scrubs the shake pattern to the given time, and apply the generated offset to the given result

Public function

void

 

StartShakePattern

(
    const FCameraShakeStartParams& Par...
)

Called when the shake pattern starts

Public function

void

 

StopShakePattern

(
    const FCameraShakeStopParams& Para...
)

Called when the shake pattern is manually stopped

Public function

void

 

TeardownShakePattern()

Call when the shake pattern is discard, either after naturally finishing or being stopped manually

Public function

void

 

UpdateShakePattern

(
    const FCameraShakeUpdateParams& Pa...,
    FCameraShakeUpdateResult& OutResul...
)

Updates the shake pattern, which should add its generated offset to the given result