CameraLensEffectInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "UObject/Interface.h"
#include "Math/Transform.h"
#include "Templates/SubclassOf.h"
#include "Kismet/BlueprintFunctionLibrary.h"
 
#include "CameraLensEffectInterface.generated.h"
 
class AActor;
class APlayerCameraManager;
class UFXSystemComponent;
 
UINTERFACE(meta=(CannotImplementInterfaceInBlueprint), MinimalAPI, BlueprintType)
class UCameraLensEffectInterface : public UInterface
{
    GENERATED_BODY()
};
 
class ICameraLensEffectInterface
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category = "CameraLensEffect")
    ENGINE_API virtual TArray<UFXSystemComponent*> GetParticleComponents() const;
 
    UFUNCTION(BlueprintCallable, Category = "CameraLensEffect")
    ENGINE_API virtual UFXSystemComponent* GetPrimaryParticleComponent() const;
 
    virtual const FTransform& GetRelativeTransform() const = 0;
    virtual float GetBaseFOV() const = 0;
    virtual bool ShouldAllowMultipleInstances() const = 0;
    virtual bool ResetWhenTriggered() const = 0;
 
    virtual void NotifyWillBePooled() {};
 
    virtual bool ShouldTreatEmitterAsSame(TSubclassOf<AActor> OtherEmitter) const = 0;
 
    virtual void RegisterCamera(APlayerCameraManager* CameraManager) = 0;
    
    virtual void NotifyRetriggered() = 0;
 
    virtual void ActivateLensEffect() = 0;
    
    virtual void DeactivateLensEffect() = 0;
    
    ENGINE_API virtual void UpdateLocation(const FVector& CamLoc, const FRotator& CamRot, float CamFOVDeg);
 
    virtual void AdjustBaseFOV(float NewFOV) = 0;
 
    static ENGINE_API FTransform GetAttachedEmitterTransform(const AActor* Emitter, const FVector& CamLoc, const FRotator& CamRot, float CamFOVDeg);
 
    virtual bool IsLooping() const = 0;
};
 
//~ Engineering Note: You can validate assets to see if they have any TSubclassOf<AEmitterCameraLensEffectBase> [or other lens effect bases] and issue warnings where they do! Suggest this type instead!
USTRUCT(BlueprintType)
struct FCameraLensInterfaceClassSupport
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category="Lens Effect", meta=(MustImplement= "/Script/Engine.CameraLensEffectInterface"))
    TSubclassOf<AActor> Class;
};
 
UENUM()
enum class EInterfaceValidResult : uint8 
{
    Valid,
    Invalid,
};
 
template <typename T>
class TScriptInterface;
 
UCLASS()
class UCameraLensEffectInterfaceClassSupportLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintPure, Category="Lens Effect", meta=(BlueprintAutocast, CompactNodeTitle=".", Keywords="class, get, toclass, getclass, spawn, object"))
    static TSubclassOf<AActor> GetInterfaceClass(const FCameraLensInterfaceClassSupport& CameraLens);
 
    UFUNCTION(BlueprintCallable, Category="Lens Effect", meta=(ExpandEnumAsExecs=Result, Keywords = "valid, camera, real, lens", DisplayName="Is Valid Camera Lens Class"))
    static void IsInterfaceClassValid(const FCameraLensInterfaceClassSupport& CameraLens, EInterfaceValidResult& Result);
    
    UFUNCTION(BlueprintCallable, Category="Lens Effect", meta=(ExpandEnumAsExecs=Result, Keywords = "valid, camera, real, lens", DisplayName="Is Valid Camera Lens"))
    static void IsInterfaceValid(const TScriptInterface<ICameraLensEffectInterface>& CameraLens, EInterfaceValidResult& Result);
    
    UFUNCTION(BlueprintCallable, Category="Lens Effect", meta=(ExpandEnumAsExecs=Result))
    static void SetInterfaceClass(UPARAM(meta = (MustImplement = "CameraLensEffectInterface")) TSubclassOf<AActor> Class, UPARAM(Ref) FCameraLensInterfaceClassSupport& Var, EInterfaceValidResult& Result);
};