1. Epic GamesDeveloper
  3. UCineCameraComponent

UCineCameraComponent

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

API > API/Runtime > API/Runtime/CinematicCamera

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

   
Name UCineCameraComponent
Type class
Header File /Engine/Source/Runtime/CinematicCamera/Public/CineCameraComponent.h
Include Path #include "CineCameraComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCineCameraComponent()

 Default constuctor. CineCameraComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOverride_CustomNearClippingPlane uint32   CineCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Current Camera Settings"
  • Meta=(InlineEditConditionToggle)
CropSettings FPlateCropSettings Controls the crop settings. CineCameraComponent.h
  • EditAnywhere
  • BlueprintSetter=SetCropSettings
  • BlueprintReadWrite
  • Category="Current Camera Settings"
CurrentAperture float Current aperture, in terms of f-stop (e.g. 2.8 for f/2.8) CineCameraComponent.h
  • Interp
  • BlueprintSetter=SetCurrentAperture
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Current Camera Settings"
CurrentFocalLength float Current focal length of the camera (i.e. controls FoV, zoom) CineCameraComponent.h
  • Interp
  • BlueprintSetter=SetCurrentFocalLength
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Current Camera Settings"
CurrentFocusDistance float Read-only. Control this value via FocusSettings. CineCameraComponent.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Current Camera Settings"
CurrentHorizontalFOV float Read-only. Control this value with CurrentFocalLength (and filmback settings). CineCameraComponent.h
  • VisibleAnywhere
  • Category="Current Camera Settings"
CustomNearClippingPlane float Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane. CineCameraComponent.h
  • Interp
  • BlueprintSetter=SetCustomNearClippingPlane
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Current Camera Settings"
  • Meta=(UIMin="0.00001", ClampMin="0.00001", editcondition="bOverride_CustomNearClippingPlane", Units=cm)
ExposureMethod ECameraExposureMethod Exposure method, for determining whether exposure-related post-process settings should be automatically set from camera parameters CineCameraComponent.h
  • Interp
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Current Camera Settings"
Filmback FCameraFilmbackSettings Controls the filmback of the camera. CineCameraComponent.h
  • Interp
  • BlueprintSetter=SetFilmback
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Current Camera Settings"
FocusSettings FCameraFocusSettings Controls the camera's focus. CineCameraComponent.h
  • EditAnywhere
  • BlueprintSetter=SetFocusSettings
  • BlueprintReadWrite
  • Category="Current Camera Settings"
LensSettings FCameraLensSettings Controls the camera's lens. CineCameraComponent.h
  • EditAnywhere
  • BlueprintSetter=SetLensSettings
  • BlueprintReadWrite
  • Category="Current Camera Settings"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

   CineCameraComponent.h  

FString GetCropPresetName()

 Returns the lens name of the camera with the current settings. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

FString GetDefaultFilmbackPresetName()

 Returns the name of the default filmback preset. CineCameraComponent.h
  • BlueprintPure
  • Category="Cine Camera"

FString GetFilmbackPresetName()

 Returns the filmback name of the camera with the current settings. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

virtual FText GetFilmbackText()

   CineCameraComponent.h  

float GetHorizontalFieldOfView()

 Returns the horizonal FOV of the camera with current settings. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

float GetHorizontalProjectionOffset()

   CineCameraComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Cine Camera"

FString GetLensPresetName()

 Returns the lens name of the camera with the current settings. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

float GetVerticalFieldOfView()

 Returns the vertical FOV of the camera with current settings. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

float GetVerticalProjectionOffset()

   CineCameraComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Cine Camera"

float GetWorldToMetersScale()

 Returns the world to meters scale for the current UWorld CineCameraComponent.h  

void SetCropPresetByName ( const FString& InPresetName
)

 Set the current lens settings by preset name. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

void SetCropSettings ( const FPlateCropSettings& NewCropSettings
)

   CineCameraComponent.h
  • BlueprintSetter

void SetCurrentAperture ( const float NewCurrentAperture
)

   CineCameraComponent.h
  • BlueprintSetter

void SetCurrentFocalLength ( float InFocalLength
)

   CineCameraComponent.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Cine Camera"

void SetCustomNearClippingPlane ( const float NewCustomNearClippingPlane
)

 Sets near clipping plane of the cine camera. CineCameraComponent.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Cine Camera"

virtual void SetFieldOfView ( float InFieldOfView
)

 Override setting FOV to manipulate Focal Length. CineCameraComponent.h  

void SetFilmback ( const FCameraFilmbackSettings& NewFilmback
)

   CineCameraComponent.h
  • BlueprintSetter

void SetFilmbackPresetByName ( const FString& InPresetName
)

 Set the current preset settings by preset name. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

void SetFocusSettings ( const FCameraFocusSettings& NewFocusSettings
)

   CineCameraComponent.h
  • BlueprintSetter

void SetLensPresetByName ( const FString& InPresetName
)

 Set the current lens settings by preset name. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

void SetLensSettings ( const FCameraLensSettings& NewLensSettings
)

   CineCameraComponent.h
  • BlueprintSetter

void UpdateDebugFocusPlane()

 Update the debug focus plane position and orientation. CineCameraComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void NotifyCameraCut()

   CineCameraComponent.h  

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   CineCameraComponent.h  

virtual void OnRegister()

   CineCameraComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CineCameraComponent.h  

virtual void PostInitProperties()

   CineCameraComponent.h  

void RecalcDerivedData()

   CineCameraComponent.h  

virtual void ResetProxyMeshTransform()

   CineCameraComponent.h  

virtual void Serialize ( FArchive& Ar
)

   CineCameraComponent.h  

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

   CineCameraComponent.h  

virtual void UpdateCameraLens ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

   CineCameraComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FNamedFilmbackPreset > const & GetFilmbackPresets()

 Returns a list of available filmback presets. CineCameraComponent.h  

static TArray< FNamedFilmbackPreset > GetFilmbackPresetsCopy()

 Returns a copy of the list of available filmback presets. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

static TArray< FNamedLensPreset > const & GetLensPresets()

 Returns a list of available lens presets. CineCameraComponent.h  

static TArray< FNamedLensPreset > GetLensPresetsCopy()

 Returns a copy of the list of available lens presets. CineCameraComponent.h
  • BlueprintCallable
  • Category="Cine Camera"

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DefaultFilmbackPresetName_DEPRECATED FString Deprecated. See DefaultFilmbackPreset CineCameraComponent.h
  • Config
FilmbackSettings_DEPRECATED FCameraFilmbackSettings   CineCameraComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page