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

Light Theme

Dark Theme

AVirtualCameraPlayerControllerBase

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AController

APlayerController

AVirtualCameraPlayerControllerBase

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class AVirtualCameraPlayerControllerBase : public APlayerController

Variables

	Name	Description
FVector2D	AutoFocusScreenPosition	The 2D vector corresponding to which point on the screen will be used for autofocus
bool	bCachedIsVirtualCameraControlledByRemoteSession	Cached value for IsVirtualCameraControlledByRemoteSession()
bool	bCachedShouldUpdateTargetCameraTransform	Cached value for IsVirtualCameraControlledByRemoteSession()
EVirtualCameraF...	CurrentFocusMethod	The current focus method in use
ETrackerInputSo...	InputSource	Allows user to select which tracker input should be used
ULevelSequenceP...	LevelSequencePlaybackController	Controller for level sequence playback
ILiveLinkClient...	LiveLinkClient	Client interface to the LiveLink plugin for gathering data on an actor
FName	LiveLinkTargetName	Controller for level sequence playback
FVirtualCameraR...	OnOffsetReset
FScriptDelegate	OnStop
ETouchInputStat...	PreviousTouchInput	The previous touch input state.
TArray< FName >	RequiredSequencerRecorderCameraSettings	Array of any properties that should be recorded
AVPRootActor &#...	RootActor
ACineCameraActo...	TargetCameraActor	Target camera that is spawned or possessed on begin play for the sequence controller
TSubclassOf< AC...	TargetCameraActorClass	Class of CameraActor to spawn to allow user to use their own customized camera
ETouchInputStat...	TouchInputState	The touch input state to determine the context of how touch input should be handled.
FTrackingOffset	TrackerPostOffset	Offset applied to calculated location after tracker transform is added
FTrackingOffset	TrackerPreOffset	Offset applied to calculated location before tracker transform is added

Constructors

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

Functions

	Name	Description
void	ActivateGameViewport()	Helper to bring the game viewport to front.
void	AddBlendableToCamera ( TScriptInterface< IBlendableInterfa..., float Weight )	Adds a blendable object to the camera's post process settings.
void	BroadcastOffsetReset()	Broadcast offset resets when movement component broadcasts
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 adjecent preset value.
void	ClearActiveLevelSequence()	Clears the current level sequence player, needed when recording clean takes of something
int32	DeletePreset ( FString PresetName )	Deletes a preset using its name as the key.
int32	DeleteScreenshot ( FString ScreenshotName )	Deletes a screenshot, using its name as the key.
int32	DeleteWaypoint ( FString WaypointName )	Deletes a waypoint, using its name as the key.
void	FocusMethodChanged ( EVirtualCameraFocusMethod NewFocusM... )	Blueprint event for when the focus method is changed.
ULevelSequen...	GetActiveLevelSequence()	Returns the currently selected sequence
FString	GetActiveLevelSequenceName()	Returns the asset name of the currently selected sequence
float	GetAxisMovementScale ( EVirtualCameraAxis AxisToRetrieve )	Gets movement scale for a specific axis.
float	GetAxisStabilizationScale ( EVirtualCameraAxis AxisToRetrieve )	Gets stabalization scale for a specific axis.
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()	Returns the current focus distance of the camera.
EVirtualCame...	GetCurrentFocusMethod()	Returns the current focus method.
FFrameRate	GetCurrentSequenceFrameRate()	Get the frame rate of the currently selected sequence
FFrameNumber	GetCurrentSequencePlaybackEnd()	Get the end position of the currently selected sequence
FFrameNumber	GetCurrentSequencePlaybackStart()	Get the start position of the currently selected sequence
bool	GetCurrentTrackerLocationAndRotation ( FVector& OutTrackerLocation, FRotator& OutTrackerRotation )	Get the current tracker location and rotation based on selected input method.
void	GetCustomTrackerLocationAndRotation ( FVector& OutTrackerLocation, FRotator& OutTrackerRotation )	Overridable function to allow user to get tracker data from blueprints.
EUnit	GetDesiredDistanceUnits()	Returns previously set unit of distance.
FString	GetDistanceInDesiredUnits ( const float InputDistance, const EUnit ConversionUnit )	Converts a distance in unreal units (cm) to other units of measurement for display.
bool	GetFilmbackPresetOptions ( TArray< FString >& OutFilmbackPres... )	Stores the names of all available filmback presets into an array.
FColor	GetFocusPlaneColor()	Get the current color of the focus plane that should be used
FFrameNumber	GetLevelSequenceLength()	Gets the length of the currently selected level sequence
void	GetLevelSequences ( TArray< FLevelSequenceData >& OutL... )	Returns the names of each level sequence asset in the project
float	GetMatteAspectRatio()	Returns the current matte aspect ratio.
float	GetMatteOpacity()	Set the matte aspect ratio to a new value.
void	GetMatteValues ( TArray< float >& OutMatteValues )	Returns the values of all matte options.
FFrameTime	GetPlaybackPosition()	Gets the playback position of the level sequence
FTimecode	GetPlaybackTimecode()	Gets the playback Timecode of the level sequence
void	GetScreenshotInfo ( FString ScreenshotName, FVirtualCameraScreenshot& OutScree... )	Returns the information associated with a Screenshot.
void	GetScreenshotNames ( TArray< FString >& OutArray )	Collects a list of existing screenshot names.
TMap< FStrin...	GetSettingsPresets()	Returns a sorted TMap of the current presets.
ACineCameraA...	GetTargetCamera()	Returns the target camera that was spawned for this play
ETouchInputS...	GetTouchInputState()	Sets the current state of touch input.
UVirtualCame...	GetVirtualCameraCineCameraComponent()	Convenience function to get camera component for UI functions.
UVirtualCame...	GetVirtualCameraMovementComponent()	Convenience function to get movement component for UI functions
AVirtualCame...	GetVirtualCameraPawn()	Gets the current Virtual Camera Pawn
void	GetWaypointInfo ( FString WaypointName, FVirtualCameraWaypoint& OutWaypoin... )	Returns the information associated with a waypoint.
void	GetWaypointNames ( TArray< FString >& OutArray )	Collects a list of existing waypoint names.
void	HandleRecordEnabledStateChange ( const bool bIsRecordEnabled )	Function to handle delegate when form playback controller.
void	InitializeAutoFocusPoint()	Sets the autofocus point to the correct starting location at the center of the screen
bool	IsAxisLocked ( EVirtualCameraAxis AxisToCheck )	Checks if an axis is locked.
bool	IsFocusVisualizationActivated()	Checks whether or not focus visualization is activate
bool	IsFocusVisualizationAllowed()	Checks whether or not focus visualization can activate
bool	IsLocationWithinMatte ( const FVector Location )	Checks of the touch input
bool	IsPlaying()	Check to see if the sequence is playing
bool	IsSequencerLockedToCameraCut()	Gets the locked to camera cut from the active LevelSequence
bool	IsTouchInputInFocusMode()	Helper to check if touch input state is in a touch focus mode.
bool	IsUsingGlobalBoom()	Get whether or not global boom is being used when navigating with the joysticks
bool	IsVirtualCameraControlledByRemoteSession()	Is this machine should display the Virtual Camera UI and establish a connection with the remote session app.
void	JumpToLevelSequenceEnd()	Goes to the end of the level sequence and pauses
void	JumpToLevelSequenceStart()	Goes to the start of the level sequence and pauses
void	JumpToPlaybackPosition ( const FFrameNumber& InFrameNumber )	Sets the playback position of the level sequence.
bool	LoadPreset ( FString PresetName )	Loads a preset using its name as a string key.
bool	LoadScreenshotView ( const FString& ScreenshotName )	Moves a camera to the location where a screenshot was taken and restores camera settings used for that screenshot.
void	OnMoveForward ( const float InValue )	Handle moving forward/backward input from a controller or touch interface.
void	OnMoveRight ( const float InValue )	Handle moving left/right input from a controller or touch interface.
void	OnMoveUp ( const float InValue )	Handle moving up/down input from a controller or touch interface.
void	OnRecordEnabledStateChanged ( bool bIsRecordEnabled )	Blueprint Event for updating if a sequence can be recorded or not.
void	OnStopped()	Blueprint Event for when a sequence stops playing.
void	OnTouchInput ( const ETouchIndex::Type TouchIndex, const FVector Location )	Determine how to handle touch input based on current context.
void	PauseLevelSequence()	Pauses the playing of the current level sequence.
void	PilotTargetedCamera ( AVirtualCameraPawnBase* PawnTo..., UVirtualCameraCineCameraComponent&... )	Pilot the controlled camera during recording, copying over settings from the pawn.
void	PlayLevelSequence()	Plays current level sequence
void	PlayLevelSequenceInReverse()	Plays current level sequence in reverse
void	ResetCameraOffsetsToTracker()	Moves the camera back to actor root and aligns rotation with the input tracker.
void	ResumeLevelSequencePlay()	Plays current level sequence from the current time.
void	SaveHomeWaypoint ( const FString& NewHomeWaypointName )	Stores the new home waypoint location.
FString	SavePreset ( bool bSaveCameraSettings, bool bSaveStabilization, bool bSaveAxisLocking, bool bSaveMotionScale )	Saves a preset into the list of presets.
FString	SaveWaypoint()	Stores the current pawn location as a waypoint.
bool	SetActiveLevelSequence ( ULevelSequence* InNewLevelSequ... )	Changes the active level sequence to a new level sequence.
void	SetAllowFocusPlaneVisualization ( bool bShouldAllowFocusVisualization )	Sets whether or not to use focus visualization
float	SetAxisStabilizationScale ( EVirtualCameraAxis AxisToAdjust, float NewStabilizationAmount )	Sets the stabilization rate for a given lock.
void	SetCurrentAperture ( 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 cinematic camera to a given value.
void	SetDesiredDistanceUnits ( const EUnit DesiredUnits )	Sets unit of distance.
bool	SetFilmbackPresetOption ( const FString& NewFilmbackPreset )	Set the filmback settings to a new filmback preset.
void	SetFocusDistanceThroughPoint ( const FVector2D ScreenPosition )	Sets the focus distance through a point on the screen.
void	SetFocusDistanceToActor ( const ETouchIndex::Type TouchIndex, const FVector& Location )	Sets the focus distance to an object selected by the player based on touch input.
void	SetFocusMethod ( const EVirtualCameraFocusMethod New... )	Sets the camera focus method.
void	SetFocusPlaneColor ( const FColor NewFocusPlaneColor )	Changes focus plane color.
void	SetFocusVisualization ( bool bShowFocusVisualization )	Toggles focus visualization tools on camera.
void	SetInputSource ( ETrackerInputSource InInputSource )	Set the input source
bool	SetMatteAspectRatio ( const float NewMatteAspectRatio )	Set the matte aspect ratio to a new value.
void	SetMatteOpacity ( const float NewMatteOpacity )	Set the matte aspect ratio to a new value.
void	SetMovementScale ( const EVirtualCameraAxis AxisToAdju..., const float NewMovementScale )	Sets the movement scale of the camera actor.
void	SetPresetFavoriteStatus ( const FString& PresetName, const bool bIsFavorite )	Sets whether or not a preset is favorited
void	SetSaveSettingsWhenClosing ( bool bShouldSettingsSave )	Sets whether settings should be saved on exit.
void	SetScreenshotFavoriteStatus ( const FString& ScreenshotName, const bool bIsFavorite )	Sets whether or not a screenshot is favorited
void	SetSequencerLockedToCameraCut ( bool bLockView )	Sets the locked to camera cut from the active LevelSequence
void	SetTouchInputState ( ETouchInputState NewInputState )	Sets the current state of touch input.
void	SetUseGlobalBoom ( bool bShouldUseGlobalBoom )	Sets whether or not global boom should be used when navigating with the joysticks
void	SetWaypointFavoriteStatus ( const FString& WaypointName, const bool bIsFavorite )	Sets whether or not a waypoint is favorited
void	SetZeroDutchOnLock ( const bool bInValue )	Set the value for the option to zero out dutch when locking that axis.
bool	ShouldSaveSettingsWhenClosing()	Check whether settings should save when closing
bool	ShouldUpdateTargetCameraTransform()	In multi user session, how should we update the information across different sessions.
void	ShowFocusPlaneFromTouch()	Will trigger the event to show focus visualization, unless disabled by user.
void	StopLevelSequencePlay()	Stops the currently playing level sequence.
FString	TakeScreenshot()	Takes a screenshot from the current view and saves the location and camera settings.
void	TeleportToHomeWaypoint()	Teleports to the current marked home waypoint.
bool	TeleportToWaypoint ( const FString& WaypointIndex )	Teleports the pawn to a specific location.
bool	ToggleAxisFreeze ( const EVirtualCameraAxis AxisToTogg... )	Toggles the freeze on a given axis; returns new frozen state.
bool	ToggleAxisLock ( const EVirtualCameraAxis AxisToTogg... )	Toggles the lock on a given axis; returns new locked state.
void	UpdateFocusReticle ( FVector NewReticleLocation )	Blueprint Event for updating position of autofocus reticle.
void	UpdatePawnWithTrackerData()	Get the current tracker data and update the movement component.
void	UpdateScreenFocus ( const ETouchIndex::Type TouchIndex, const FVector Location )	Moves the point through which the camera auto focuses.

Overridden from APlayerController

		Name	Description
	bool	InputTouch ( uint32 Handle, ETouchType::Type Type, const FVector2D& TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex )	Override of InputTouch, used to handle touch and hold events.
	void	SetupInputComponent()	Allows the PlayerController to set up custom input bindings.

Overridden from AController

		Name	Description
	void	OnPossess ( APawn* InPawn )	Overridable native function for when this controller is asked to possess a pawn.

Overridden from AActor

		Name	Description
	void	BeginPlay()	Overridable native event for when play begins for this actor.
	void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

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

Take our survey

Dismiss