AVirtualCameraActor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

VirtualCamera

Header

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

Include

#include "VirtualCameraActor.h"

Syntax

UCLASS(Abstract, Blueprintable, BlueprintType, Category="VirtualCamera",
       DisplayName="VirtualCameraActor")
class AVirtualCameraActor :
    public ACineCameraActor,
    public IVirtualCameraController,
    public IVirtualCameraPresetContainer,
    public IVirtualCameraOptions

Variables

Name Description

Protected variable UProperty Transient

UWorld *

 

ActorWorld

Protected variable UProperty Category BlueprintReadOnly

bool

 

bAllowFocusVisualization

Should focus plane be shown on all touch focus events

Protected variable

bool

 

bSaveSettingsOnStopStreaming

Whether to save all settings when streaming is stopped

Protected variable UProperty Category, EditDefaultsOnly

UVPFullScreenUs...

 

CameraScreenWidget

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TSubclassOf< UU...

 

CameraUMGClass

Protected variable

EUnit

 

DesiredDistanceUnits

The desired unit in which to display focus distance

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLiveLinkSubjec...

 

LiveLinkSubject

Protected variable UProperty Category, EditDefaultsOnly Transient

URemoteSessionM...

 

MediaCapture

Public variable UProperty Category, EditDefaultsOnly Transient

URemoteSessionM...

 

MediaOutput

Public variable UProperty Category BlueprintReadWrite visibleanywhere

UVirtualCameraM...

 

MovementComponent

Protected variable UProperty Category, EditAnywhere

FOnActorClicked...

 

OnActorClickedDelegate

Delegate that will be triggered when an actor has been clicked/touched.

Protected variable UProperty Category, EditAnywhere

FPreSetVirtualC...

 

OnPreSetVirtualCameraTransform

Delegate that will is triggered before transform is set onto Actor.

Protected variable UProperty Category, EditAnywhere

FVirtualCameraT...

 

OnVirtualCameraUpdatedDelegates

This delegate is triggered at the end of a tick in editor/pie/game.

Protected variable UProperty Transient

AActor *

 

PreviousViewTarget

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

int32

 

RemoteSessionPort

Public variable UProperty Category BlueprintReadWrite visibleanywhere

USceneCaptureCo...

 

SceneCaptureComponent

Protected variable UProperty Category, EditAnywhere

TMap< FString, ...

 

SettingsPresets

Stores the list of settings presets, and saved presets

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FVector2D

 

TargetDeviceResolution

Constructors

Name Description

Public function

AVirtualCameraActor

(
    const FObjectInitializer& ObjectIn...
)

Public function

AVirtualCameraActor

(
    FVTableHelper& Helper
)

Destructors

Name Description

Public function

~AVirtualCameraActor()

Functions

Name Description

Protected function Virtual

void

 

AddBlendableToCamera_Implementation

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

Protected function Virtual

void

 

AddOnVirtualCameraUpdatedDelegate_Implementation

(
    const FVirtualCameraTickDelegate& ...
)

Protected function Virtual

int32

 

DeletePreset_Implementation

(
    const FString& PresetName
)

Protected function Virtual

EUnit

 

GetDesiredDistanceUnits_Implementation()

Protected function Virtual Const

FLiveLinkSub...

 

GetLiveLinkRepresentation_Implementation()

Protected function Virtual

TScriptInter...

 

GetOptions_Implementation()

Protected function Virtual

TScriptInter...

 

GetPresetContainer_Implementation()

Protected function Virtual Const

FTransform

 

GetRelativeTransform_Implementation()

Protected function Virtual Const

USceneCaptur...

 

GetSceneCaptureComponent_Implementation()

Protected function Virtual Const

ULevelSequen...

 

GetSequenceController_Implementation()

Protected function Virtual

TMap< FStrin...

 

GetSettingsPresets_Implementation()

Protected function Virtual Const

UCineCameraC...

 

GetStreamedCameraComponent_Implementation()

Protected function Virtual

bool

 

IsFocusVisualizationAllowed_Implementation()

Protected function Virtual Const

bool

 

IsStreaming_Implementation()

Protected function Virtual

bool

 

LoadPreset_Implementation

(
    const FString& PresetName
)

Protected function Virtual

void

 

RemoveOnVirtualCameraUpdatedDelegate_Implementation

(
    const FVirtualCameraTickDelegate& ...
)

Protected function Virtual

FString

 

SavePreset_Implementation

(
    const bool bSaveCameraSettings,
    const bool bSaveStabilization,
    const bool bSaveAxisLocking,
    const bool bSaveMotionScale
)

Protected function Virtual

void

 

SetBeforeSetVirtualCameraTransformDelegate_Implementation

(
    const FPreSetVirtualCameraTransform...
)

Protected function Virtual

void

 

SetDesiredDistanceUnits_Implementation

(
    const EUnit DesiredUnits
)

Protected function Virtual

void

 

SetFocusVisualization_Implementation

(
    bool bInShowFocusVisualization
)

Protected function Virtual

void

 

SetLiveLinkRepresentation_Implementation

(
    const FLiveLinkSubjectRepresentatio...
)

Protected function Virtual

void

 

SetOnActorClickedDelegate_Implementation

(
    const FOnActorClickedDelegate& InD...
)

Protected function Virtual

void

 

SetSaveSettingsOnStopStreaming_Implementation

(
    bool bShouldSettingsSave
)

Protected function Virtual

void

 

SetTrackedActorForFocus_Implementation

(
    AActor* InActorToTrack,
    const FVector& InTrackingPointOffs...
)

Protected function Virtual Const

bool

 

ShouldSaveSettingsOnStopStreaming_Implementation()

Overridden from AActor

Name Description

Protected function Virtual

void

 

BeginPlay()

Overridable native event for when play begins for this actor.

Public function Virtual

void

 

Destroyed()

Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending

Protected function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

Overridable function called whenever this actor is being removed from a level

Public function Virtual Const

bool

 

ShouldTickIfViewportsOnly()

If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly

Public function Virtual

void

 

Tick

(
    float DeltaSeconds
)

Function called every frame on this Actor.

Overridden from IVirtualCameraController

Constants

Name

Description

PresetIndex

The next preset number