EmitterCameraLensEffectBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Particles/Emitter.h"
#include "Camera/CameraLensEffectInterface.h"
#include "EmitterCameraLensEffectBase.generated.h"
 
class APlayerCameraManager;
 
UCLASS(abstract, Blueprintable, MinimalAPI)
class AEmitterCameraLensEffectBase : public AEmitter, public ICameraLensEffectInterface
{
    GENERATED_UCLASS_BODY()
 
protected:
    UPROPERTY(EditDefaultsOnly, Category = EmitterCameraLensEffectBase)
    TObjectPtr<class UParticleSystem> PS_CameraEffect;
 
    UPROPERTY(transient)
    TObjectPtr<class APlayerCameraManager> BaseCamera;
 
    UPROPERTY(EditDefaultsOnly, Category = EmitterCameraLensEffectBase)
    FTransform RelativeTransform;
 
public:
    UPROPERTY(EditDefaultsOnly, Category = EmitterCameraLensEffectBase)
    float BaseFOV;
 
    UPROPERTY(EditAnywhere, Category = EmitterCameraLensEffectBase)
    uint8 bAllowMultipleInstances:1;
 
    UPROPERTY(EditAnywhere, Category = EmitterCameraLensEffectBase)
    uint8 bResetWhenRetriggered:1;
 
    UPROPERTY(EditDefaultsOnly, Category = EmitterCameraLensEffectBase, meta = (MustImplement = "/Script/Engine.CameraLensEffectInterface"))
    TArray<TSubclassOf<AActor>> EmittersToTreatAsSame;
public:
    //~ Begin AActor Interface
    ENGINE_API virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    ENGINE_API virtual void PostInitializeComponents() override;
    ENGINE_API virtual void PostLoad() override;
    //~ End AActor Interface
 
    //~ Begin ICameraLensEffectInterface interface
    ENGINE_API virtual const FTransform& GetRelativeTransform() const override;
    ENGINE_API virtual float GetBaseFOV() const override;
    ENGINE_API virtual bool ShouldAllowMultipleInstances() const override;
    ENGINE_API virtual bool ResetWhenTriggered() const override;
    ENGINE_API virtual bool ShouldTreatEmitterAsSame(TSubclassOf<AActor> OtherEmitter) const override;
    ENGINE_API virtual bool IsLooping() const override;
 
    ENGINE_API virtual void AdjustBaseFOV(float NewFOV);
 
    ENGINE_API virtual void RegisterCamera(APlayerCameraManager* C) override;
 
    ENGINE_API virtual void NotifyWillBePooled() override;
    
    ENGINE_API virtual void NotifyRetriggered() override;
 
    ENGINE_API virtual void ActivateLensEffect() override;
    
    ENGINE_API virtual void DeactivateLensEffect() override;
    
    ENGINE_API virtual void UpdateLocation(const FVector& CamLoc, const FRotator& CamRot, float CamFOVDeg) override;
    //~ End ICameraLensEffectInterface interface
 
    UE_DEPRECATED(5.0, "ICameraLensEffectInterface::GetAttachedEmitterTransform is favored now")
    static ENGINE_API FTransform GetAttachedEmitterTransform(AEmitterCameraLensEffectBase const* Emitter, const FVector& CamLoc, const FRotator& CamRot, float CamFOVDeg);
 
private:
    UPROPERTY()
    float DistFromCamera_DEPRECATED;
};