UVirtualCameraCineCameraComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

VirtualCamera

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraCineCameraComponent.h

Include

#include "VirtualCameraCineCameraComponent.h"

Syntax

UCLASS(Blueprintable, BlueprintType)
class UVirtualCameraCineCameraComponent : public UCineCameraComponent

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< float >

 

ApertureOptions

List of preset aperture options, aperture will always be one of these values

Protected variable

bool

 

bAllowCameraViewUpdates

Whether or not camera view updates should occur

Public variable

bool

 

bAutoFocusEnabled

Tracks if autofocus is enabled

Public variable

bool

 

bCameraViewResetNeeded

Tracks whether or not the camera's view needs to be restored

Protected variable

EVirtualCameraF...

 

CachedFocusMethod

Saves the current focus method for reset if menus is exited without applying settings

Protected variable

FString

 

CurrentFilmbackOptionsKey

The current filmback option preset being used

Protected variable

EVirtualCameraF...

 

CurrentFocusMethod

The current focus method

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FCameraFilmback...

 

DesiredFilmbackSettings

The desired filmback settings to be shown in the viewport within Virtual Camera UI window

Public variable UProperty Category, EditAnywhere

TMap< FString, ...

 

FilmbackOptions

List of preset filmback options, filmback will always be one of these values

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< float >

 

FocalLengthOptions

List of preset focal length options, focal length will be one of these values, unless manually zooming

Protected variable

float

 

FocusChangeSmoothness

How smooth focus changes are, set by user through UI

Protected variable

UStaticMesh ...

 

FocusPlaneMesh

Mesh used for the focus plane

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

float

 

MatteAspectRatio

The filmback settings to be used for additional letterboxing if desired

Public variable UProperty Category, Meta BlueprintReadWrite

float

 

MatteOpacity

The opacity of the matte in the camera view

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< float >

 

MatteOptions

List of preset matte options to chose from, UI options will only pull from this, unless a filmback option with a custom matte is selected

Public variable UProperty Category BlueprintReadWrite

FVector2D

 

ViewSizeRatio

The X and Y ratios of Desired View Size to Actual View Size (calculated as Desired/ Actual)

Constructors

Name Description

Public function

UVirtualCameraCineCameraComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddBlendableToCamera

(
    const TScriptInterface< IBlendableI...,
    const float Weight
)

Adds a blendable object to the camera's post process settings.

Public function

void

 

AllowCameraViewUpdates()

Allow camera view updates.

Public function

float

 

ChangeAperturePreset

(
    const bool bShiftUp
)

Adjusts the aperture of the camera to an adjacent preset value.

Public function

float

 

ChangeFocalLengthPreset

(
    const bool bShiftUp
)

Adjust the focal length of the camera to an adjacent preset value.

Protected function Const

int32

 

FindClosestPresetIndex

(
    const TArray< float >& ArrayToSear...,
    const float SearchValue
)

Searches a preset array for the closest value to it.

Public function Const

float

 

GetCurrentAperture()

Get the current aperture value on the camera.

Public function Const

FString

 

GetCurrentFilmbackName()

Get the name of the current preset filmback option on the camera.

Public function Const

float

 

GetCurrentFocalLength()

Get the current focal length value on the camera.

Public function

float

 

GetCurrentFocusDistance()

Gets the current focus distance of the camera.

Public function Const

EVirtualCame...

 

GetCurrentFocusMethod()

Get the currently used focus method.

Public function Const

bool

 

GetFilmbackPresetOptions

(
    TArray< FString >& OutFilmbackPres...
)

Stores the names of all available filmback presets into an array.

Public function

float

 

GetMatteAspectRatio()

Returns the current matte aspect ratio.

Public function Const

void

 

GetMatteValues

(
    TArray< float >& OutMatteValues
)

Returns the values of all matte options.

Public function Const

bool

 

IsFocusVisualizationActivated()

Is focus visualization tools activated on camera.

Public function

void

 

SetCurrentAperture

(
    const float NewAperture
)

Set the current aperture value on the camera.

Public function

void

 

SetCurrentFocalLength

(
    const float NewFocalLength
)

Sets the current focal length of the cinematic camera to a given value.

Public function

void

 

SetCurrentFocusDistance

(
    const float NewFocusDistance
)

Sets the current focus distance of the camera to a new value.

Public function

bool

 

SetFilmbackPresetOption

(
    const FString& NewFilmbackPreset
)

Set the filmback settings to a new filmback preset.

Public function

void

 

SetFocusChangeSmoothness

(
    const float NewFocusChangeSmoothnes...
)

Sets the focus change rate.

Public function

void

 

SetFocusDistance

(
    const float NewFocusDistance
)

Sets the current focus distance to a new value based on current focus settings.

Public function

void

 

SetFocusMethod

(
    const EVirtualCameraFocusMethod New...
)

Sets the camera focus method.

Public function

void

 

SetFocusVisualization

(
    bool bShowFocusVisualization
)

Toggles focus visualization tools on camera.

Public function

bool

 

SetMatteAspectRatio

(
    const float NewMatteAspectRatio
)

Set the matte aspect ratio to a new value.

Public function

void

 

SetTrackedActorForFocus

(
    AActor* ActorToTrack,
    const FVector TrackingPointOffset
)

Sets tracked actor settings on the camera.

Public function

void

 

StopCameraViewUpdates()

Disable camera view updates.

Public function

void

 

UpdateCameraView()

Updates the camera view to have the desired film format view within the Virtual Camera UI area.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

BeginPlay()

Begins Play for the component.