1. Epic GamesDeveloper
  3. UCineCameraComponent

UCineCameraComponent

A specialized version of a camera component, geared toward cinematic usage.

API > API/Runtime > API/Runtime/CinematicCamera

Inheritance Hierarchy

References

   
Module CinematicCamera
Header /Engine/Source/Runtime/CinematicCamera/Public/CineCameraComponent.h
Include #include "CineCameraComponent.h"

Syntax

UCLASS (HideCategories=(CameraSettings), HideFunctions=(SetFieldOfView, SetAspectRatio),  
       Blueprintable, ClassGroup=Camera, Meta=(BlueprintSpawnableComponent), Config=Engine,  
       MinimalAPI)  
class UCineCameraComponent : public UCameraComponent

Remarks

A specialized version of a camera component, geared toward cinematic usage.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite uint32: 1 bOverride_CustomNearClippingPlane  
Protected variable uint8: 1 bResetInterpolation Set to true to skip any interpolations on the next update. Resets to false automatically.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FPlateCropSettings CropSettings Controls the crop settings.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite blueprintsetter float CurrentAperture Current aperture, in terms of f-stop (e.g. 2.8 for f/2.8)
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite blueprintsetter float CurrentFocalLength Current focal length of the camera (i.e. controls FoV, zoom)
Public variable UProperty Category BlueprintReadOnly visibleanywhere float CurrentFocusDistance Read-only. Control this value via FocusSettings.
Public variable UProperty Category visibleanywhere float CurrentHorizontalFOV Read-only. Control this value with CurrentFocalLength (and filmback settings).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Interp, Meta BlueprintReadWrite blueprintsetter float CustomNearClippingPlane Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.
Protected variable UProperty Transient TObjectPtr< UStaticMeshComponent > DebugFocusPlaneComponent Component for the debug focus plane visualization
Protected variable UProperty Transient TObjectPtr< UMaterialInstanceDynamic > DebugFocusPlaneMID Dynamic material instance for the debug focus plane visualization
Protected variable UProperty Config FString DefaultFilmbackPreset Name of the default filmback preset
Protected variable UProperty Config float DefaultLensFocalLength Default focal length (will be constrained by default lens)
Protected variable UProperty Config float DefaultLensFStop Default aperture (will be constrained by default lens)
Protected variable UProperty Config FString DefaultLensPresetName Name of the default lens preset
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite blueprintsetter FCameraFilmbackSettings Filmback Controls the filmback of the camera.
Protected variable UProperty Config TArray< FNamedFilmbackPreset > FilmbackPresets List of available filmback presets
Protected variable UProperty Transient TObjectPtr< UMaterial > FocusPlaneVisualizationMaterial Material used for debug focus plane visualization
Protected variable UProperty Transient TObjectPtr< UStaticMesh > FocusPlaneVisualizationMesh Mesh used for debug focus plane visualization
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FCameraFocusSettings FocusSettings Controls the camera's focus.
Protected variable float LastFocusDistance Most recent calculated focus distance. Used for interpolation.
Protected variable UProperty Config TArray< FNamedLensPreset > LensPresets List of available lens presets
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FCameraLensSettings LensSettings Controls the camera's lens.

Constructors

  Type Name Description
Public function   Default constuctor.

Functions

  Type Name Description
Public function Virtual void

GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

  
Public function Const UFunction BlueprintCallable, Category FString Returns the lens name of the camera with the current settings.
Public function Const UFunction BlueprintPure, Category FString Returns the name of the default filmback preset.
Public function Const UFunction BlueprintCallable, Category FString Returns the filmback name of the camera with the current settings.
Public function Static TArray< FNamedFilmbackPreset > const & Returns a list of available filmback presets.
Public function Static UFunction BlueprintCallable, Category TArray< FNamedFilmbackPreset > Returns a copy of the list of available filmback presets.
Public function Virtual Const FText  
Public function Const UFunction BlueprintCallable, Category float Returns the horizonal FOV of the camera with current settings.
Public function Const UFunction BlueprintCallable, Category FString Returns the lens name of the camera with the current settings.
Public function Static TArray< FNamedLensPreset > const & Returns a list of available lens presets.
Public function Static UFunction BlueprintCallable, Category TArray< FNamedLensPreset > Returns a copy of the list of available lens presets.
Public function Const UFunction BlueprintCallable, Category float Returns the vertical FOV of the camera with current settings.
Public function Const float Returns the world to meters scale for the current UWorld
Protected function Virtual void  
Protected function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

  
Protected function Virtual void  
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual void  
Protected function void  
Protected function Virtual void  
Protected function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetCropPresetByName ( const FString& InPresetName
)

 Set the current lens settings by preset name.
Public function UFunction blueprintsetter void

SetCropSettings ( const FPlateCropSettings& NewCropSettings
)

  
Public function UFunction blueprintsetter void

SetCurrentAperture ( const float NewCurrentAperture
)

  
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetCurrentFocalLength ( float InFocalLength
)

  
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetCustomNearClippingPlane ( const float NewCustomNearClippingPlane
)

 Sets near clipping plane of the cine camera.
Public function Virtual void

SetFieldOfView ( float InFieldOfView
)

 Override setting FOV to manipulate Focal Length.
Public function UFunction blueprintsetter void

SetFilmback ( const FCameraFilmbackSettings& NewFilmback
)

  
Public function UFunction BlueprintCallable, Category void

SetFilmbackPresetByName ( const FString& InPresetName
)

 Set the current preset settings by preset name.
Public function UFunction blueprintsetter void

SetFocusSettings ( const FCameraFocusSettings& NewFocusSettings
)

  
Public function UFunction BlueprintCallable, Category void

SetLensPresetByName ( const FString& InPresetName
)

 Set the current lens settings by preset name.
Public function UFunction blueprintsetter void

SetLensSettings ( const FCameraLensSettings& NewLensSettings
)

  
Protected function Virtual void

TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Protected function Virtual void

UpdateCameraLens ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

  
Public function void Update the debug focus plane position and orientation.

Deprecated Variables

  Type Name Description
Protected variable UProperty Config FString DefaultFilmbackPresetName_DEPRECATED Deprecated. See DefaultFilmbackPreset
Public variable UProperty FCameraFilmbackSettings FilmbackSettings_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page