Navigation
API > API/Runtime > API/Runtime/Engine
A shake "pattern" defines how a camera should be effectively shaken. Examples of shake patterns are sinewave oscillation, perlin noise, or FBX animation.
| Name | UCameraShakePattern |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Camera/CameraShakeBase.h |
| Include Path | #include "Camera/CameraShakeBase.h" |
Syntax
UCLASS (Abstract, EditInlineNew, MinimalAPI)
class UCameraShakePattern : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraShakePattern
Derived Classes
- UCompositeCameraShakePattern
- ULegacyCameraShakePattern
- USequenceCameraShakePattern
- USimpleCameraShakePattern
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCameraShakePattern
(
const FObjectInitializer& ObjectInitializer |
Constructor for a shake pattern | Camera/CameraShakeBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetShakePatternInfo
(
FCameraShakeInfo& OutInfo |
Gets information about this shake pattern | Camera/CameraShakeBase.h | |
bool IsFinished() |
Returns whether this shake pattern is finished | Camera/CameraShakeBase.h | |
void ScrubShakePattern
(
const FCameraShakePatternScrubParams& Params, |
Scrubs the shake pattern to the given time, and apply the generated offset to the given result | Camera/CameraShakeBase.h | |
void StartShakePattern
(
const FCameraShakePatternStartParams& Params |
Called when the shake pattern starts | Camera/CameraShakeBase.h | |
void StopShakePattern
(
const FCameraShakePatternStopParams& Params |
Called when the shake pattern is manually stopped | Camera/CameraShakeBase.h | |
void TeardownShakePattern() |
Call when the shake pattern is discard, either after naturally finishing or being stopped manually | Camera/CameraShakeBase.h | |
void UpdateShakePattern
(
const FCameraShakePatternUpdateParams& Params, |
Updates the shake pattern, which should add its generated offset to the given result | Camera/CameraShakeBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
InstanceType * GetShakeInstance () |
Gets the shake pattern's parent shake | Camera/CameraShakeBase.h | |
| Gets the shake pattern's parent shake | Camera/CameraShakeBase.h |