CameraShakeSourceComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Camera/CameraTypes.h"
#include "Components/SceneComponent.h"
#include "UObject/ObjectMacros.h"
#include "CameraShakeSourceComponent.generated.h"
 
class UCameraShakeBase;
class UTexture2D;
 
UENUM(BlueprintType)
enum class ECameraShakeAttenuation : uint8
{
    Linear,
    Quadratic
};
 
struct FCameraShakeSourceComponentStartParams
{
    TSubclassOf<UCameraShakeBase> ShakeClass;
 
    /* The scale for playing the shake */
    float Scale = 1.f;
 
    ECameraShakePlaySpace PlaySpace = ECameraShakePlaySpace::CameraLocal;
 
    FRotator UserPlaySpaceRot = FRotator::ZeroRotator;
 
    TOptional<float> DurationOverride;
};
 
UCLASS(Blueprintable, meta = (BlueprintSpawnableComponent), MinimalAPI)
class UCameraShakeSourceComponent : public USceneComponent
{
    GENERATED_BODY()
 
public:
    ENGINE_API UCameraShakeSourceComponent(const FObjectInitializer& ObjectInitializer);
 
    ENGINE_API virtual void BeginPlay() override;
    ENGINE_API virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
    ENGINE_API virtual void OnRegister() override;
 
#if WITH_EDITOR
    ENGINE_API virtual void PreEditChange(FProperty* PropertyAboutToChange) override;
    ENGINE_API virtual void PostEditChangeProperty( struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
private:
    void UpdateEditorSpriteTexture();
 
#if WITH_EDITOR
    TSubclassOf<UCameraShakeBase> PreviousCameraShake;
#endif
 
public:
    ENGINE_API void StartCameraShake(const FCameraShakeSourceComponentStartParams& Params);
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Attenuation)
    ECameraShakeAttenuation Attenuation;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Attenuation)
    float InnerAttenuationRadius;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Attenuation)
    float OuterAttenuationRadius;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = CameraShake)
    TSubclassOf<UCameraShakeBase> CameraShake;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = CameraShake)
    bool bAutoStart;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TObjectPtr<UTexture2D> EditorSpriteTexture;
 
    UPROPERTY(transient)
    float EditorSpriteTextureScale;
#endif
 
public:
    UFUNCTION(BlueprintCallable, Category = CameraShake)
    ENGINE_API void Start();
 
    UFUNCTION(BlueprintCallable, Category = CameraShake)
    ENGINE_API void StartCameraShake(TSubclassOf<UCameraShakeBase> InCameraShake, float Scale=1.f, ECameraShakePlaySpace PlaySpace = ECameraShakePlaySpace::CameraLocal, FRotator UserPlaySpaceRot = FRotator::ZeroRotator);
 
    UFUNCTION(BlueprintCallable, Category = CameraShake)
    ENGINE_API void StopAllCameraShakesOfType(TSubclassOf<UCameraShakeBase> InCameraShake, bool bImmediately = true);
 
    UFUNCTION(BlueprintCallable, Category = CameraShake)
    ENGINE_API void StopAllCameraShakes(bool bImmediately = true);
 
    UFUNCTION(BlueprintCallable, Category = CameraShake)
    ENGINE_API float GetAttenuationFactor(const FVector& Location) const;
};