UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FCameraShakePatternScrubParams Struct Reference

#include <CameraShakeBase.h>

Public Member Functions

 FCameraShakePatternScrubParams ()
 
 FCameraShakePatternScrubParams (const FMinimalViewInfo &InPOV)
 
ENGINE_API FCameraShakePatternUpdateParams ToUpdateParams () const
 
float GetTotalScale () const
 

Public Attributes

float AbsoluteTime = 0.f
 
float ShakeScale = 1.f
 
float DynamicScale = 1.f
 
FMinimalViewInfo POV
 

Detailed Description

Parameters for scrubbing a camera shake.

Constructor & Destructor Documentation

◆ FCameraShakePatternScrubParams() [1/2]

FCameraShakePatternScrubParams::FCameraShakePatternScrubParams ( )
inline

◆ FCameraShakePatternScrubParams() [2/2]

FCameraShakePatternScrubParams::FCameraShakePatternScrubParams ( const FMinimalViewInfo &  InPOV)
inline

Member Function Documentation

◆ GetTotalScale()

float FCameraShakePatternScrubParams::GetTotalScale ( ) const
inline

The total scale to apply to the camera shake during the current update. Equals ShakeScale * DynamicScale

◆ ToUpdateParams()

FCameraShakePatternUpdateParams FCameraShakePatternScrubParams::ToUpdateParams ( ) const

Convert this to an update parameter struct where the delta time is from 0 to the AbsoluteTime.

Member Data Documentation

◆ AbsoluteTime

float FCameraShakePatternScrubParams::AbsoluteTime = 0.f

The time to scrub to

◆ DynamicScale

float FCameraShakePatternScrubParams::DynamicScale = 1.f

The dynamic scale being passed down from the camera manger for the next update

◆ POV

FMinimalViewInfo FCameraShakePatternScrubParams::POV

The current view that this camera shake should modify

◆ ShakeScale

float FCameraShakePatternScrubParams::ShakeScale = 1.f

The base scale for this shake

The documentation for this struct was generated from the following files: