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 > AVirtualCameraActor

Light Theme

Dark Theme

AVirtualCameraActor

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ACameraActor

ACineCameraActor

AVirtualCameraActor

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable, BlueprintType, Category="VirtualCamera",
       DisplayName="VirtualCameraActor")
class AVirtualCameraActor :
    public ACineCameraActor,
    public IVirtualCameraController,
    public IVirtualCameraPresetContainer,
    public IVirtualCameraOptions

Variables

	Name	Description
UWorld *	ActorWorld
bool	bAllowFocusVisualization	Should focus plane be shown on all touch focus events
bool	bSaveSettingsOnStopStreaming	Whether to save all settings when streaming is stopped
UVPFullScreenUs...	CameraScreenWidget
TSubclassOf< UU...	CameraUMGClass
EUnit	DesiredDistanceUnits	The desired unit in which to display focus distance
FLiveLinkSubjec...	LiveLinkSubject
URemoteSessionM...	MediaCapture
URemoteSessionM...	MediaOutput
UVirtualCameraM...	MovementComponent
FOnActorClicked...	OnActorClickedDelegate	Delegate that will be triggered when an actor has been clicked/touched.
FPreSetVirtualC...	OnPreSetVirtualCameraTransform	Delegate that will is triggered before transform is set onto Actor.
FVirtualCameraT...	OnVirtualCameraUpdatedDelegates	This delegate is triggered at the end of a tick in editor/pie/game.
AActor *	PreviousViewTarget
int32	RemoteSessionPort
USceneCaptureCo...	SceneCaptureComponent
TMap< FString, ...	SettingsPresets	Stores the list of settings presets, and saved presets
FVector2D	TargetDeviceResolution

Constructors

	Name	Description
	AVirtualCameraActor ( const FObjectInitializer& ObjectIn... )
	AVirtualCameraActor ( FVTableHelper& Helper )

Destructors

	Name	Description
	~AVirtualCameraActor()

Functions

		Name	Description
	void	AddBlendableToCamera_Implementation ( const TScriptInterface< IBlendableI..., float InWeight )
	void	AddOnVirtualCameraUpdatedDelegate_Implementation ( const FVirtualCameraTickDelegate& ... )
	int32	DeletePreset_Implementation ( const FString& PresetName )
	EUnit	GetDesiredDistanceUnits_Implementation()
	FLiveLinkSub...	GetLiveLinkRepresentation_Implementation()
	TScriptInter...	GetOptions_Implementation()
	TScriptInter...	GetPresetContainer_Implementation()
	FTransform	GetRelativeTransform_Implementation()
	USceneCaptur...	GetSceneCaptureComponent_Implementation()
	ULevelSequen...	GetSequenceController_Implementation()
	TMap< FStrin...	GetSettingsPresets_Implementation()
	UCineCameraC...	GetStreamedCameraComponent_Implementation()
	bool	IsFocusVisualizationAllowed_Implementation()
	bool	IsStreaming_Implementation()
	bool	LoadPreset_Implementation ( const FString& PresetName )
	void	RemoveOnVirtualCameraUpdatedDelegate_Implementation ( const FVirtualCameraTickDelegate& ... )
	FString	SavePreset_Implementation ( const bool bSaveCameraSettings, const bool bSaveStabilization, const bool bSaveAxisLocking, const bool bSaveMotionScale )
	void	SetBeforeSetVirtualCameraTransformDelegate_Implementation ( const FPreSetVirtualCameraTransform... )
	void	SetDesiredDistanceUnits_Implementation ( const EUnit DesiredUnits )
	void	SetFocusVisualization_Implementation ( bool bInShowFocusVisualization )
	void	SetLiveLinkRepresentation_Implementation ( const FLiveLinkSubjectRepresentatio... )
	void	SetOnActorClickedDelegate_Implementation ( const FOnActorClickedDelegate& InD... )
	void	SetSaveSettingsOnStopStreaming_Implementation ( bool bShouldSettingsSave )
	void	SetTrackedActorForFocus_Implementation ( AActor* InActorToTrack, const FVector& InTrackingPointOffs... )
	bool	ShouldSaveSettingsOnStopStreaming_Implementation()

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
bool	ShouldTickIfViewportsOnly()	If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly
void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

Overridden from IVirtualCameraController

		Name	Description
	UWorld *	GetControllerWorld()
	bool	StartStreaming()
	bool	StopStreaming()

Constants

Name	Description
PresetIndex	The next preset number

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

Take our survey

Dismiss