UCineCameraComponent

Inheritance Hierarchy

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

UMaterial *

 

DebugFocusPlaneMaterial

Material used for debug focus plane visualization

Protected variable

UStaticMesh ...

 

DebugFocusPlaneMesh

Mesh used for 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.

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 Static

TArray < FNam ...

 

GetFilmbackPresets()

Returns a list of available filmback presets.

Public function

float

 

GetHorizontalFieldOfView()

Returns the horizonal FOV of the camera with current settings.

Public function Static

TArray < FNam ...

 

GetLensPresets()

Returns a list of available lens presets.

Public function

float

 

GetVerticalFieldOfView()

Returns the vertical FOV of the camera with current settings.

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
)

End of UObject interface.

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

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnComponentDestroyed

(
    bool bDestroyingHierarchy
)

Called when a component is destroyed

Protected function Virtual

void

 

OnRegister()

UActorComponent interface.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

End of UActorComponent interface.

Protected function Virtual

void

 

PostInitProperties()

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

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object, and immediately after any undo/redo.

References

Module

CinematicCamera

Header

Runtime/CinematicCamera/Public/CineCameraComponent.h