Navigation
API > API/Plugins > API/Plugins/VirtualCamera
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&40;Abstract, Blueprintable, BlueprintType, Category&61;"VirtualCamera",
DisplayName&61;"VirtualCameraActor"&41;
class AVirtualCameraActor :
public ACineCameraActor,
public IVirtualCameraController,
public IVirtualCameraPresetContainer,
public IVirtualCameraOptions
Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< 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 | |
| TObjectPtr< UVPFullScreenUserWidget > | CameraScreenWidget | ||
| TSubclassOf< UUserWidget > | CameraUMGClass | ||
| EUnit | DesiredDistanceUnits | The desired unit in which to display focus distance | |
| FLiveLinkSubjectRepresentation | LiveLinkSubject | ||
| TObjectPtr< URemoteSessionMediaCapture > | MediaCapture | ||
| TObjectPtr< URemoteSessionMediaOutput > | MediaOutput | ||
| TObjectPtr< UVirtualCameraMovement > | MovementComponent | ||
| FOnActorClickedDelegate | OnActorClickedDelegate | Delegate that will be triggered when an actor has been clicked/touched. | |
| FPreSetVirtualCameraTransform | OnPreSetVirtualCameraTransform | Delegate that will is triggered before transform is set onto Actor. | |
| FVirtualCameraTickDelegateGroup | OnVirtualCameraUpdatedDelegates | This delegate is triggered at the end of a tick in editor/pie/game. | |
| TObjectPtr< AActor > | PreviousViewTarget | ||
| int32 | RemoteSessionPort | ||
| TObjectPtr< USceneCaptureComponent2D > | SceneCaptureComponent | ||
| TMap< FString, FVirtualCameraSettingsPreset > | SettingsPresets | Stores the list of settings presets, and saved presets | |
| FVector2D | TargetDeviceResolution |
Constructors
| Type | Name | Description | |
|---|---|---|---|
AVirtualCameraActor
(
const FObjectInitializer& ObjectInitializer |
|||
AVirtualCameraActor
(
FVTableHelper& Helper |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
Overridden from AActor
| Type | 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 EndPlayReason |
Overridable function called whenever this actor is being removed from a level | |
| bool | If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly | ||
| void | Tick
(
float DeltaSeconds |
Function called every frame on this Actor. |
Overridden from IVirtualCameraController
| Type | Name | Description | |
|---|---|---|---|
| UWorld * | |||
| bool | |||
| bool |
Constants
| Name | Description |
|---|---|
| PresetIndex | The next preset number |