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 > Plugins > VirtualCamera > UVirtualCameraCineCameraComponent

Light Theme

Dark Theme

UVirtualCameraCineCameraComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UCameraComponent

UCineCameraComponent

UVirtualCameraCineCameraComponent

References

Module	VirtualCamera
Header	/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraCineCameraComponent.h
Include	#include "VirtualCameraCineCameraComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, BlueprintType)
class UVirtualCameraCineCameraComponent : public UCineCameraComponent

Variables

	Name	Description
TArray< float >	ApertureOptions	List of preset aperture options, aperture will always be one of these values
bool	bAllowCameraViewUpdates	Whether or not camera view updates should occur
bool	bAutoFocusEnabled	Tracks if autofocus is enabled
bool	bCameraViewResetNeeded	Tracks whether or not the camera's view needs to be restored
EVirtualCameraF...	CachedFocusMethod	Saves the current focus method for reset if menus is exited without applying settings
FString	CurrentFilmbackOptionsKey	The current filmback option preset being used
EVirtualCameraF...	CurrentFocusMethod	The current focus method
FCameraFilmback...	DesiredFilmbackSettings	The desired filmback settings to be shown in the viewport within Virtual Camera UI window
TMap< FString, ...	FilmbackOptions	List of preset filmback options, filmback will always be one of these values
TArray< float >	FocalLengthOptions	List of preset focal length options, focal length will be one of these values, unless manually zooming
float	FocusChangeSmoothness	How smooth focus changes are, set by user through UI
UStaticMesh ...	FocusPlaneMesh	Mesh used for the focus plane
float	MatteAspectRatio	The filmback settings to be used for additional letterboxing if desired
float	MatteOpacity	The opacity of the matte in the camera view
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
FVector2D	ViewSizeRatio	The X and Y ratios of Desired View Size to Actual View Size (calculated as Desired/ Actual)

Constructors

	Name	Description
	UVirtualCameraCineCameraComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddBlendableToCamera ( const TScriptInterface< IBlendableI..., const float Weight )	Adds a blendable object to the camera's post process settings.
void	AllowCameraViewUpdates()	Allow camera view updates.
float	ChangeAperturePreset ( const bool bShiftUp )	Adjusts the aperture of the camera to an adjacent preset value.
float	ChangeFocalLengthPreset ( const bool bShiftUp )	Adjust the focal length of the camera to an adjacent preset value.
int32	FindClosestPresetIndex ( const TArray< float >& ArrayToSear..., const float SearchValue )	Searches a preset array for the closest value to it.
float	GetCurrentAperture()	Get the current aperture value on the camera.
FString	GetCurrentFilmbackName()	Get the name of the current preset filmback option on the camera.
float	GetCurrentFocalLength()	Get the current focal length value on the camera.
float	GetCurrentFocusDistance()	Gets the current focus distance of the camera.
EVirtualCame...	GetCurrentFocusMethod()	Get the currently used focus method.
bool	GetFilmbackPresetOptions ( TArray< FString >& OutFilmbackPres... )	Stores the names of all available filmback presets into an array.
float	GetMatteAspectRatio()	Returns the current matte aspect ratio.
void	GetMatteValues ( TArray< float >& OutMatteValues )	Returns the values of all matte options.
bool	IsFocusVisualizationActivated()	Is focus visualization tools activated on camera.
void	SetCurrentAperture ( const float NewAperture )	Set the current aperture value on the camera.
void	SetCurrentFocalLength ( const float NewFocalLength )	Sets the current focal length of the cinematic camera to a given value.
void	SetCurrentFocusDistance ( const float NewFocusDistance )	Sets the current focus distance of the camera to a new value.
bool	SetFilmbackPresetOption ( const FString& NewFilmbackPreset )	Set the filmback settings to a new filmback preset.
void	SetFocusChangeSmoothness ( const float NewFocusChangeSmoothnes... )	Sets the focus change rate.
void	SetFocusDistance ( const float NewFocusDistance )	Sets the current focus distance to a new value based on current focus settings.
void	SetFocusMethod ( const EVirtualCameraFocusMethod New... )	Sets the camera focus method.
void	SetFocusVisualization ( bool bShowFocusVisualization )	Toggles focus visualization tools on camera.
bool	SetMatteAspectRatio ( const float NewMatteAspectRatio )	Set the matte aspect ratio to a new value.
void	SetTrackedActorForFocus ( AActor* ActorToTrack, const FVector TrackingPointOffset )	Sets tracked actor settings on the camera.
void	StopCameraViewUpdates()	Disable camera view updates.
void	UpdateCameraView()	Updates the camera view to have the desired film format view within the Virtual Camera UI area.

Overridden from UActorComponent

		Name	Description
	void	BeginPlay()	Begins Play for the component.

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

Take our survey

Dismiss