Unreal Engine 4 Documentation > Unreal Engine API Reference > Runtime > Engine > Camera > UCameraShakeBase

UCameraShakeBase

A CameraShake is an asset that defines how to shake the camera in a particular way.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraShakeBase

	UMatineeCameraShake
	USequenceCameraShake

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Camera/CameraShakeBase.h
Include	#include "Camera/CameraShakeBase.h"

Syntax

class UCameraShakeBase : public UObject

Remarks

A CameraShake is an asset that defines how to shake the camera in a particular way. CameraShakes can be authored as either oscillating shakes, animated shakes, or both.

An oscillating shake will sinusoidally vibrate various camera parameters over time. Each location and rotation axis can be oscillated independently with different parameters to create complex and random-feeling shakes. These are easier to author and tweak, but can still feel mechanical and are limited to vibration-style shakes, such as earthquakes.

Animated shakes play keyframed camera animations. These can take more effort to author, but enable more natural-feeling results and things like directional shakes. For instance, you can have an explosion to the camera's right push it primarily to the left.

Variables

		Name	Description
	bool	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.

Constructors

	Name	Description
	UCameraShakeBase ( const FObjectInitializer & ObjectIn... )

Functions

	Name	Description
void	ApplyPlaySpace ( const FCameraShakeUpdateParams & Pa..., FCameraShakeUpdateResult & InOutRes... )
void	ApplyScale ( float Scale, FCameraShakeUpdateResult & InOutRes... )
void	ApplyScale ( const FCameraShakeUpdateParams & Pa..., FCameraShakeUpdateResult & InOutRes... )
APlayerCamer ...	GetCameraManager()	Gets the current camera manager. Will be null if the shake isn't active.
bool	GetCameraShakeBlendTimes ( TSubclassOf < UCameraShakeBase > Cam..., float& OutBlendIn, float& OutBlendOut )	Gets the default blend in/out durations for camera shakes of the given class.
void	GetCameraShakeBlendTimes ( float& OutBlendIn, float& OutBlendOut )	Gets the duration of this camera shake's blend in and out.
FCameraShake ...	GetCameraShakeDuration()	Gets the duration of this camera shake in seconds.
bool	GetCameraShakeDuration ( TSubclassOf < UCameraShakeBase > Cam..., FCameraShakeDuration & OutDuration )	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.
void	GetShakeInfo ( FCameraShakeInfo & OutInfo )	Gets some infromation about this specific camera shake
const FMatri ...	GetUserPlaySpaceMatrix()	Returns the current play space matrix.
bool	IsFinished()	Returns whether this camera shake is finished
void	SetUserPlaySpaceMatrix ( const FMatrix & InMatrix )	Sets the current play space matrix.
void	StartShake ( APlayerCameraManager * Camera, float Scale, ECameraShakePlaySpace InPlaySpace, FRotator UserPlaySpaceRot )	Starts this camera shake with the given parameters
void	StopShake ( bool bImmediately )	Stops this camera shake
void	TeardownShake()	Tears down this camera shake before destruction or recycling
void	UpdateAndApplyCameraShake ( float DeltaTime, float Alpha, FMinimalViewInfo & InOutPOV )	Updates this camera shake and applies its effect to the given view

Select Skin

Light

Dark