1. Epic GamesDeveloper
  3. UCineCameraComponent

UCineCameraComponent

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

Unreal Engine C++ API Reference > Runtime > CinematicCamera

Inheritance Hierarchy

References

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

Syntax

class UCineCameraComponent : public UCameraComponent

Remarks

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

Variables

  Type Name Description
Public variable 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 FPlateCropSettings CropSettings Controls the crop settings.
Public variable float CurrentAperture Current aperture, in terms of f-stop (e.g. 2.8 for f/2.8)
Public variable float CurrentFocalLength Current focal length of the camera (i.e. controls FoV, zoom)
Public variable float CurrentFocusDistance Read-only. Control this value via FocusSettings.
Public variable float CurrentHorizontalFOV Read-only. Control this value with CurrentFocalLength (and filmback settings).
Public variable float CustomNearClippingPlane Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.
Protected variable TObjectPtr< UStaticMeshComponent > DebugFocusPlaneComponent Component for the debug focus plane visualization
Protected variable TObjectPtr< UMaterialInstanceDynamic > DebugFocusPlaneMID Dynamic material instance for the debug focus plane visualization
Public variable FCameraFilmbackSettings Filmback Controls the filmback of the camera.
Protected variable TObjectPtr< UMaterial > FocusPlaneVisualizationMaterial Material used for debug focus plane visualization
Protected variable TObjectPtr< UStaticMesh > FocusPlaneVisualizationMesh Mesh used for debug focus plane visualization
Public variable FCameraFocusSettings FocusSettings Controls the camera's focus.
Protected variable float LastFocusDistance Most recent calculated focus distance. Used for interpolation.
Public variable FCameraLensSettings LensSettings Controls the camera's lens.

Constructors

  Type Name Description
Public function   Default constuctor.

Functions

  Type Name Description
Public function Const FString Returns the lens name of the camera with the current settings.
Public function Const FString Returns the filmback name of the camera with the current settings.
Public function Const float Returns the horizonal FOV of the camera with current settings.
Public function Const FString Returns the lens name of the camera with the current settings.
Public function Const 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 void  
Public function void

SetCropPresetByName ( const FString& InPresetName
)

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

SetCropSettings ( const FPlateCropSettings& NewCropSettings
)

  
Public function void

SetCurrentAperture ( const float NewCurrentAperture
)

  
Public function void

SetCurrentFocalLength ( float InFocalLength
)

  
Public function void

SetCustomNearClippingPlane ( const float NewCustomNearClippingPlane
)

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

SetFilmback ( const FCameraFilmbackSettings& NewFilmback
)

  
Public function void

SetFilmbackPresetByName ( const FString& InPresetName
)

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

SetFocusSettings ( const FCameraFocusSettings& NewFocusSettings
)

  
Public function void

SetLensPresetByName ( const FString& InPresetName
)

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

SetLensSettings ( const FCameraLensSettings& NewLensSettings
)

  
Protected function Virtual void

UpdateCameraLens ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

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

Overridden from UCameraComponent

  Type Name Description
Public function Virtual void

GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

 Returns camera's Point of View.
Public function Virtual Const FText Returns the filmback text used for burnins on preview viewports.
Protected function Virtual void Can be called from external code to notify that this camera was cut to, so it can update things like interpolation if necessary.
Protected function Virtual void  
Public function Virtual void

SetFieldOfView ( float InFieldOfView
)

 Override setting FOV to manipulate Focal Length.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void

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

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Protected variable FString DefaultFilmbackPreset This property is now located on the UCineCameraSettings object
Protected variable FString DefaultFilmbackPresetName_DEPRECATED This property has been removed and fully replaced by DefaultFilmbackPreset on the UCineCameraSettings object
Protected variable float DefaultLensFocalLength This property is now located on the UCineCameraSettings object
Protected variable float DefaultLensFStop This property is now located on the UCineCameraSettings object
Protected variable FString DefaultLensPresetName This property is now located on the UCineCameraSettings object
Protected variable TArray< FNamedFilmbackPreset > FilmbackPresets This property is now located on the UCineCameraSettings object
Public variable FCameraFilmbackSettings FilmbackSettings_DEPRECATED  
Protected variable TArray< FNamedLensPreset > LensPresets This property is now located on the UCineCameraSettings object

Deprecated Functions

  Type Name Description
Public function Const FString This function has been deprecated, please access the presets via the CineCameraSettings object.
Public function Static TArray< FNamedFilmbackPreset > const & This function has been deprecated, please access the presets via the CineCameraSettings object.
Public function Static TArray< FNamedFilmbackPreset > This function has been deprecated, please access the presets via the CineCameraSettings object.
Public function Static TArray< FNamedLensPreset > const & This function has been deprecated, please access the presets via the CineCameraSettings object.
Public function Static TArray< FNamedLensPreset > This function has been deprecated, please access the presets via the CineCameraSettings object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page