| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Camera/CameraShakeBase.h |
Include |
#include "Camera/CameraShakeBase.h" |
class UCameraShakeBase : public UObject
Base class for a camera shake. A camera shake contains a root shake "pattern" which is the object that contains the actual logic driving how the camera is shaken. Keeping the two separate makes it possible to completely change how a shake works without having to create a completely different asset.
Name | Description | ||
---|---|---|---|
|
bSingleInstance |
If true to only allow a single instance of this shake class to play at any given time. |
|
|
float |
ShakeScale |
The overall scale to apply to the shake. Only valid when the shake is active. |
Name | Description | |
---|---|---|
|
UCameraShakeBase ( |
Create a new instance of a camera shake |
Name | Description | ||
---|---|---|---|
|
ApplyLimits ( |
Applies any appropriate system-wide limits |
|
|
ApplyPlaySpace ( |
Modifies the current shake offset to be oriented in the current shake's play space (only if the result is "relative") |
|
|
ApplyPlaySpace ( |
Modifies the current shake offset to be oriented in the current shake's play space (only if the result is "relative") |
|
|
ApplyResult ( |
Uses the given result parameters to apply the given result to the given input view info |
|
|
ApplyScale ( |
Applies all the appropriate auto-scaling to the current shake offset (only if the result is "relative") |
|
|
ApplyScale ( |
Applies the given scale to the current shake offset (only if the result is "relative") |
|
|
ShakePattern... |
ChangeRootShakePattern() |
Creates a new pattern of the given type and sets it as the root one on this shake |
|
APlayerCamer... |
GetCameraManager() |
Gets the current camera manager. Will be null if the shake isn't active. |
|
GetCameraShakeBlendTimes ( |
Gets the default blend in/out durations for camera shakes of the given class. |
|
|
GetCameraShakeBlendTimes ( |
Gets the duration of this camera shake's blend in and out. |
|
|
FCameraShake... |
GetCameraShakeDuration() |
Gets the duration of this camera shake in seconds. |
|
GetCameraShakeDuration ( |
Gets the default duration for camera shakes of the given class. |
|
|
ECameraShake... |
GetPlaySpace() |
Returns the current play space. The value is irrelevant if the shake isn't active. |
|
UCameraShake... |
GetRootShakePattern() |
Gets the root pattern of this camera shake |
|
GetShakeInfo ( |
Gets some infromation about this specific camera shake |
|
|
const FMatri... |
GetUserPlaySpaceMatrix() |
Returns the current play space matrix. |
|
IsActive() |
Returns whether this shake is active. |
|
|
IsFinished() |
Returns whether this camera shake is finished |
|
|
ScrubAndApplyCameraShake ( |
Scrubs this camera shake to the given time and applies its effect to the given view |
|
|
SetRootShakePattern ( |
Sets the root pattern of this camera shake |
|
|
SetUserPlaySpaceMatrix ( |
Sets the current play space matrix. |
|
|
StartShake ( |
Starts this camera shake with the given parameters |
|
|
StopShake ( |
Stops this camera shake |
|
|
TeardownShake() |
Tears down this camera shake before destruction or recycling |
|
|
UpdateAndApplyCameraShake ( |
Updates this camera shake and applies its effect to the given view |