CineCameraComponent.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 "Camera/CameraComponent.h"
#include "CineCameraSettings.h"
#include "CineCameraComponent.generated.h"
 
class AActor;
class UMaterial;
class UMaterialInstanceDynamic;
class UStaticMesh;
class UStaticMeshComponent;
 
UCLASS(HideCategories = (CameraSettings), HideFunctions = (SetFieldOfView, SetAspectRatio), Blueprintable, ClassGroup = Camera, meta = (BlueprintSpawnableComponent), Config = Engine, MinimalAPI)
class UCineCameraComponent : public UCameraComponent
{
    GENERATED_BODY()
 
public:
    CINEMATICCAMERA_API UCineCameraComponent();
 
    CINEMATICCAMERA_API virtual void GetCameraView(float DeltaTime, FMinimalViewInfo& DesiredView) override;
#if WITH_EDITOR
    CINEMATICCAMERA_API virtual FText GetFilmbackText() const override;
#endif
    UPROPERTY()
    FCameraFilmbackSettings FilmbackSettings_DEPRECATED;
 
    UPROPERTY(Interp, BlueprintSetter = SetFilmback, EditAnywhere, BlueprintReadWrite, Category = "Current Camera Settings")
    FCameraFilmbackSettings Filmback;
 
    UFUNCTION(BlueprintSetter)
    CINEMATICCAMERA_API void SetFilmback(const FCameraFilmbackSettings& NewFilmback);
 
    UPROPERTY(EditAnywhere, BlueprintSetter = SetLensSettings, BlueprintReadWrite, Category = "Current Camera Settings")
    FCameraLensSettings LensSettings;
 
    UFUNCTION(BlueprintSetter)
    CINEMATICCAMERA_API void SetLensSettings(const FCameraLensSettings& NewLensSettings);
 
    UPROPERTY(EditAnywhere, BlueprintSetter = SetFocusSettings, BlueprintReadWrite, Category = "Current Camera Settings")
    FCameraFocusSettings FocusSettings;
 
    UFUNCTION(BlueprintSetter)
    CINEMATICCAMERA_API void SetFocusSettings(const FCameraFocusSettings& NewFocusSettings);
    
    UPROPERTY(EditAnywhere, BlueprintSetter = SetCropSettings, BlueprintReadWrite, Category = "Current Camera Settings")
    FPlateCropSettings CropSettings;
 
    UFUNCTION(BlueprintSetter)
    CINEMATICCAMERA_API void SetCropSettings(const FPlateCropSettings& NewCropSettings);
 
    UPROPERTY(Interp, BlueprintSetter = SetCurrentFocalLength, EditAnywhere, BlueprintReadWrite, Category = "Current Camera Settings")
    float CurrentFocalLength;
 
    UPROPERTY(Interp, BlueprintSetter = SetCurrentAperture, EditAnywhere, BlueprintReadWrite, Category = "Current Camera Settings")
    float CurrentAperture;
 
    UFUNCTION(BlueprintSetter)
    CINEMATICCAMERA_API void SetCurrentAperture(const float NewCurrentAperture);
    
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Current Camera Settings")
    float CurrentFocusDistance;
 
    UPROPERTY(Interp, EditAnywhere, BlueprintReadWrite, Category = "Current Camera Settings")
    ECameraExposureMethod ExposureMethod;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = "Current Camera Settings", meta = (InlineEditConditionToggle))
    uint32 bOverride_CustomNearClippingPlane:1;
 
    UPROPERTY(Interp, BlueprintSetter = SetCustomNearClippingPlane, EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = "Current Camera Settings", meta = (UIMin = "0.00001", ClampMin = "0.00001", editcondition = "bOverride_CustomNearClippingPlane", Units = cm))
    float CustomNearClippingPlane;
    
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = "Current Camera Settings")
    float CurrentHorizontalFOV;
#endif
 
    CINEMATICCAMERA_API virtual void SetFieldOfView(float InFieldOfView) override;
    
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Cine Camera")
    CINEMATICCAMERA_API void SetCurrentFocalLength(float InFocalLength);
 
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Cine Camera")
    CINEMATICCAMERA_API void SetCustomNearClippingPlane(const float NewCustomNearClippingPlane);
 
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API float GetHorizontalFieldOfView() const;
    
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API float GetVerticalFieldOfView() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Cine Camera")
    CINEMATICCAMERA_API float GetHorizontalProjectionOffset() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Cine Camera")
    CINEMATICCAMERA_API float GetVerticalProjectionOffset() const;
    
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API FString GetFilmbackPresetName() const;
 
    UE_DEPRECATED(5.1, "This function has been deprecated, please access the presets via the CineCameraSettings object.")
    UFUNCTION(BlueprintPure, Category = "Cine Camera")
    CINEMATICCAMERA_API FString GetDefaultFilmbackPresetName() const;
 
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API void SetFilmbackPresetByName(const FString& InPresetName);
 
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API FString GetLensPresetName() const;
 
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API void SetLensPresetByName(const FString& InPresetName);
    
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API FString GetCropPresetName() const;
 
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    CINEMATICCAMERA_API void SetCropPresetByName(const FString& InPresetName);
 
    UE_DEPRECATED(5.1, "This function has been deprecated, please access the presets via the CineCameraSettings object.")
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    static CINEMATICCAMERA_API TArray<FNamedFilmbackPreset> GetFilmbackPresetsCopy();
 
    UE_DEPRECATED(5.1, "This function has been deprecated, please access the presets via the CineCameraSettings object.")
    UFUNCTION(BlueprintCallable, Category = "Cine Camera")
    static CINEMATICCAMERA_API TArray<FNamedLensPreset> GetLensPresetsCopy();
 
    UE_DEPRECATED(5.1, "This function has been deprecated, please access the presets via the CineCameraSettings object.")
    static CINEMATICCAMERA_API TArray<FNamedFilmbackPreset> const& GetFilmbackPresets();
    
    UE_DEPRECATED(5.1, "This function has been deprecated, please access the presets via the CineCameraSettings object.")
    static CINEMATICCAMERA_API TArray<FNamedLensPreset> const& GetLensPresets();
 
#if WITH_EDITOR
    CINEMATICCAMERA_API void UpdateDebugFocusPlane();
#endif
 
    CINEMATICCAMERA_API float GetWorldToMetersScale() const;
 
protected:
 
    float LastFocusDistance;
 
    uint8 bResetInterpolation : 1;
 
    
    CINEMATICCAMERA_API virtual void PostLoad() override;
    
    
    CINEMATICCAMERA_API virtual void Serialize(FArchive& Ar) override;
    CINEMATICCAMERA_API virtual void PostInitProperties() override;
    CINEMATICCAMERA_API virtual void OnRegister() override;
    CINEMATICCAMERA_API virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
#if WITH_EDITOR
    CINEMATICCAMERA_API virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;
#endif
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TObjectPtr<UStaticMesh> FocusPlaneVisualizationMesh;
 
    UPROPERTY(transient)
    TObjectPtr<UMaterial> FocusPlaneVisualizationMaterial;
 
    UPROPERTY(transient)
    TObjectPtr<UStaticMeshComponent> DebugFocusPlaneComponent;
 
    UPROPERTY(transient)
    TObjectPtr<UMaterialInstanceDynamic> DebugFocusPlaneMID;
 
    CINEMATICCAMERA_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    CINEMATICCAMERA_API virtual void ResetProxyMeshTransform() override;
#endif
 
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    TArray<FNamedFilmbackPreset> FilmbackPresets;
 
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    TArray<FNamedLensPreset> LensPresets;
 
    UE_DEPRECATED(5.1, "This property has been removed and fully replaced by DefaultFilmbackPreset on the UCineCameraSettings object")
    UPROPERTY(config)
    FString DefaultFilmbackPresetName_DEPRECATED;
 
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    FString DefaultFilmbackPreset;
 
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    FString DefaultLensPresetName;
 
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    float DefaultLensFocalLength;
    
    UE_DEPRECATED(5.1, "This property is now located on the UCineCameraSettings object")
    UPROPERTY(config)
    float DefaultLensFStop;
 
    CINEMATICCAMERA_API virtual void UpdateCameraLens(float DeltaTime, FMinimalViewInfo& DesiredView);
 
    CINEMATICCAMERA_API virtual void NotifyCameraCut() override;
    
    CINEMATICCAMERA_API void RecalcDerivedData();
 
private:
    float GetDesiredFocusDistance(const FVector& InLocation) const;
    void SetLensPresetByNameInternal(const FString& InPresetName);
    void SetFilmbackPresetByNameInternal(const FString& InPresetName, FCameraFilmbackSettings& InOutFilmbackSettings);
    void SetCropPresetByNameInternal(const FString& InPresetName);
    float GetHorizontalFieldOfViewInternal(bool bIncludeOverscan = true) const;
    float GetVerticalFieldOfViewInternal(bool bIncludeOverscan) const;
    
#if WITH_EDITORONLY_DATA
    void CreateDebugFocusPlane();
    void DestroyDebugFocusPlane();
#endif
};