Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CinematicCamera > UCineCameraComponent

Light Theme

Dark Theme

UCineCameraComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UCameraComponent

UCineCameraComponent

UVirtualCameraCineCameraComponent

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

	Name	Description
uint8: 1	bResetInterpolation	Set to true to skip any interpolations on the next update. Resets to false automatically.
float	CurrentAperture	Current aperture, in terms of f-stop (e.g. 2.8 for f/2.8)
float	CurrentFocalLength	Current focal length of the camera (i.e. controls FoV, zoom)
float	CurrentFocusDistance	Read-only. Control this value via FocusSettings.
float	CurrentHorizontalFOV	Read-only. Control this value with CurrentFocalLength (and filmback settings).
UStaticMeshComp...	DebugFocusPlaneComponent	Component for the debug focus plane visualization
UMaterialInstan...	DebugFocusPlaneMID	Dynamic material instance for the debug focus plane visualization
FString	DefaultFilmbackPreset	Name of the default filmback preset
float	DefaultLensFocalLength	Default focal length (will be constrained by default lens)
float	DefaultLensFStop	Default aperture (will be constrained by default lens)
FString	DefaultLensPresetName	Name of the default lens preset
FCameraFilmback...	Filmback	Controls the filmback of the camera.
TArray< FNamedF...	FilmbackPresets	List of available filmback presets
UMaterial *	FocusPlaneVisualizationMaterial	Material used for debug focus plane visualization
UStaticMesh ...	FocusPlaneVisualizationMesh	Mesh used for debug focus plane visualization
FCameraFocusSet...	FocusSettings	Controls the camera's focus.
float	LastFocusDistance	Most recent calculated focus distance. Used for interpolation.
TArray< FNamedL...	LensPresets	List of available lens presets
FCameraLensSett...	LensSettings	Controls the camera's lens.

Constructors

	Name	Description
	UCineCameraComponent()	Default constuctor.

Functions

	Name	Description
FString	GetDefaultFilmbackPresetName()	Returns the name of the default filmback preset.
FString	GetFilmbackPresetName()	Returns the filmback name of the camera with the current settings.
TArray< FNam...	GetFilmbackPresets()	Returns a list of available filmback presets.
float	GetHorizontalFieldOfView()	Returns the horizonal FOV of the camera with current settings.
FString	GetLensPresetName()	Returns the lens name of the camera with the current settings.
TArray< FNam...	GetLensPresets()	Returns a list of available lens presets.
TArray< FNam...	GetLensPresetsCopy()	Returns a copy of the list of available lens presets.
float	GetVerticalFieldOfView()	Returns the vertical FOV of the camera with current settings.
void	RecalcDerivedData()
void	SetCurrentFocalLength ( const float& InFocalLength )
void	SetFilmbackPresetByName ( const FString& InPresetName )	Set the current preset settings by preset name.
void	SetLensPresetByName ( const FString& InPresetName )	Set the current lens settings by preset name.
void	UpdateCameraLens ( float DeltaTime, FMinimalViewInfo& DesiredView )
void	UpdateDebugFocusPlane()	Update the debug focus plane position and orientation.

Overridden from UCameraComponent

	Name	Description
void	GetCameraView ( float DeltaTime, FMinimalViewInfo& DesiredView )	Returns camera's Point of View.
FText	GetFilmbackText()	Returns the filmback text used for burnins on preview viewports.
void	NotifyCameraCut()	Can be called from external code to notify that this camera was cut to, so it can update things like interpolation if necessary.
void	ResetProxyMeshTransform()
void	SetFieldOfView ( float InFieldOfView )	Override setting FOV to manipulate Focal Length.

Overridden from UActorComponent

	Name	Description
void	OnComponentDestroyed ( bool bDestroyingHierarchy )	Called when a component is destroyed
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	TickComponent ( float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	FString	DefaultFilmbackPresetName_DEPRECATED	See DefaultFilmbackPreset
	FCameraFilmback...	FilmbackSettings_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss