UCineCameraComponent

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

Windows
MacOS
Linux

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

Name Description

Protected variable

uint8: 1

 

bResetInterpolation

Set to true to skip any interpolations on the next update. Resets to false automatically.

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).

Protected variable

UStaticMeshComp...

 

DebugFocusPlaneComponent

Component for the debug focus plane visualization

Protected variable

UMaterialInstan...

 

DebugFocusPlaneMID

Dynamic material instance for the debug focus plane visualization

Protected variable

FString

 

DefaultFilmbackPresetName

Name of the default filmback preset

Protected variable

float

 

DefaultLensFocalLength

Default focal length (will be constrained by default lens)

Protected variable

float

 

DefaultLensFStop

Default aperture (will be constrained by default lens)

Protected variable

FString

 

DefaultLensPresetName

Name of the default lens preset

Protected variable

TArray< FNamedF...

 

FilmbackPresets

List of available filmback presets

Public variable

FCameraFilmback...

 

FilmbackSettings

Controls the filmback of the camera.

Protected variable

UMaterial *

 

FocusPlaneVisualizationMaterial

Material used for debug focus plane visualization

Protected variable

UStaticMesh ...

 

FocusPlaneVisualizationMesh

Mesh used for debug focus plane visualization

Public variable

FCameraFocusSet...

 

FocusSettings

Controls the camera's focus.

Protected variable

float

 

LastFocusDistance

Most recent calculated focus distance. Used for interpolation.

Protected variable

TArray< FNamedL...

 

LensPresets

List of available lens presets

Public variable

FCameraLensSett...

 

LensSettings

Controls the camera's lens.

Constructors

Name Description

Public function

UCineCameraComponent()

Default constuctor.

Functions

Name Description

Public function Const

FString

 

GetFilmbackPresetName()

Returns the filmback name of the camera with the current settings.

Public function Static

TArray< FNam...

 

GetFilmbackPresets()

Returns a list of available filmback presets.

Public function Const

float

 

GetHorizontalFieldOfView()

Returns the horizonal FOV of the camera with current settings.

Public function Const

FString

 

GetLensPresetName()

Returns the lens name of the camera with the current settings.

Public function Static

TArray< FNam...

 

GetLensPresets()

Returns a list of available lens presets.

Public function Const

float

 

GetVerticalFieldOfView()

Returns the vertical FOV of the camera with current settings.

Protected function

void

 

RecalcDerivedData()

Public function

void

 

SetFilmbackPresetByName

(
    const FString& InPresetName
)

Set the current preset settings by preset name.

Public function

void

 

SetLensPresetByName

(
    const FString& InPresetName
)

Set the current lens settings by preset name.

Protected function Virtual

void

 

UpdateCameraLens

(
    float DeltaTime,
    FMinimalViewInfo& DesiredView
)

Public function

void

 

UpdateDebugFocusPlane()

Update the debug focus plane position and orientation.

Overridden from UCameraComponent

Name Description

Public function Virtual

void

 

GetCameraView

(
    float DeltaTime,
    FMinimalViewInfo& DesiredView
)

Returns camera's Point of View.

Public function Virtual Const

FText

 

GetFilmbackText()

Returns the filmback text used for burnins on preview viewports.

Protected function Virtual

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.

Protected function Virtual

void

 

ResetProxyMeshTransform()

Public function Virtual

void

 

SetFieldOfView

(
    float InFieldOfView
)

Override setting FOV to manipulate Focal Length.

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnComponentDestroyed

(
    bool bDestroyingHierarchy
)

Called when a component is destroyed

Protected function Virtual

void

 

OnRegister()

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* T...
)

Function called every frame on this ActorComponent.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback