1. Epic GamesDeveloper
  3. AVirtualCameraPlayerControllerBase

AVirtualCameraPlayerControllerBase

API > API/Plugins > API/Plugins/VirtualCamera

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract&41;  
class AVirtualCameraPlayerControllerBase : public APlayerController

Variables

  Type Name Description
Protected variable FVector2D AutoFocusScreenPosition The 2D vector corresponding to which point on the screen will be used for autofocus
Protected variable UProperty Category BlueprintReadOnly Transient bool bCachedIsVirtualCameraControlledByRemoteSession Cached value for IsVirtualCameraControlledByRemoteSession()
Protected variable UProperty Category BlueprintReadOnly Transient bool bCachedShouldUpdateTargetCameraTransform Cached value for IsVirtualCameraControlledByRemoteSession()
Protected variable EVirtualCameraFocusMethod CurrentFocusMethod The current focus method in use
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite blueprintsetter ETrackerInputSource InputSource Allows user to select which tracker input should be used
Protected variable UProperty Transient TObjectPtr< ULevelSequencePlaybackController > LevelSequencePlaybackController Controller for level sequence playback
Protected variable ILiveLinkClient * LiveLinkClient Client interface to the LiveLink plugin for gathering data on an actor
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FName LiveLinkTargetName Controller for level sequence playback
Public variable UProperty Category BlueprintAssignable FVirtualCameraResetOffsetsDelegate OnOffsetReset  
Public variable FScriptDelegate OnStop  
Protected variable ETouchInputState PreviousTouchInput The previous touch input state.
Public variable UProperty Category, EditAnywhere TArray< FName > RequiredSequencerRecorderCameraSettings Array of any properties that should be recorded
Public variable UProperty Category BlueprintReadOnly Transient TObjectPtr< AVPRootActor > RootActor  
Protected variable UProperty Transient TObjectPtr< ACineCameraActor > TargetCameraActor Target camera that is spawned or possessed on begin play for the sequence controller
Public variable UProperty Category, EditAnywhere BlueprintReadOnly noclear TSubclassOf< ACineCameraActor > TargetCameraActorClass Class of CameraActor to spawn to allow user to use their own customized camera
Protected variable ETouchInputState TouchInputState The touch input state to determine the context of how touch input should be handled.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FTrackingOffset TrackerPostOffset Offset applied to calculated location after tracker transform is added
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FTrackingOffset TrackerPreOffset Offset applied to calculated location before tracker transform is added

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Helper to bring the game viewport to front.
Public function UFunction BlueprintCallable, Category void

AddBlendableToCamera ( TScriptInterface< IBlendableInterface > BlendableToAdd,
float Weight
)

 Adds a blendable object to the camera's post process settings.
Protected function UFunction void Broadcast offset resets when movement component broadcasts
Public function UFunction BlueprintCallable, Category float

ChangeAperturePreset ( const bool bShiftUp
)

 Adjusts the aperture of the camera to an adjacent preset value.
Public function UFunction BlueprintCallable, Category float

ChangeFocalLengthPreset ( const bool bShiftUp
)

 Adjust the focal length of the camera to an adjecent preset value.
Public function UFunction BlueprintCallable, Category void Clears the current level sequence player, needed when recording clean takes of something
Public function UFunction BlueprintCallable, Category int32

DeletePreset ( FString PresetName
)

 Deletes a preset using its name as the key.
Public function UFunction BlueprintCallable, Category int32

DeleteScreenshot ( FString ScreenshotName
)

 Deletes a screenshot, using its name as the key.
Public function UFunction BlueprintCallable, Category int32

DeleteWaypoint ( FString WaypointName
)

 Deletes a waypoint, using its name as the key.
Public function UFunction Category, BlueprintImplementableEvent void Blueprint event for when the focus method is changed.
Public function UFunction BlueprintPure, Category ULevelSequence * Returns the currently selected sequence
Public function UFunction BlueprintPure, Category FString Returns the asset name of the currently selected sequence
Public function UFunction BlueprintPure, Category float Gets movement scale for a specific axis.
Public function UFunction BlueprintPure, Category float Gets stabalization scale for a specific axis.
Public function UFunction BlueprintPure, Category float Get the current aperture value on the camera.
Public function UFunction BlueprintPure, Category FString Get the name of the current preset filmback option on the camera.
Public function UFunction BlueprintPure, Category float Get the current focal length value on the camera.
Public function UFunction BlueprintPure, Category float Returns the current focus distance of the camera.
Public function UFunction BlueprintPure, Category EVirtualCameraFocusMethod Returns the current focus method.
Public function UFunction BlueprintPure, Category FFrameRate Get the frame rate of the currently selected sequence
Public function UFunction BlueprintPure, Category FFrameNumber Get the end position of the currently selected sequence
Public function UFunction BlueprintPure, Category FFrameNumber Get the start position of the currently selected sequence
Protected function bool

GetCurrentTrackerLocationAndRotation ( FVector& OutTrackerLocation,
FRotator& OutTrackerRotation
)

 Get the current tracker location and rotation based on selected input method.
Public function UFunction Category, BlueprintImplementableEvent void

GetCustomTrackerLocationAndRotation ( FVector& OutTrackerLocation,
FRotator& OutTrackerRotation
)

 Overridable function to allow user to get tracker data from blueprints.
Public function UFunction BlueprintPure, Category EUnit Returns previously set unit of distance.
Public function Const UFunction BlueprintPure, Category FString

GetDistanceInDesiredUnits ( const float InputDistance,
const EUnit ConversionUnit
)

 Converts a distance in unreal units (cm) to other units of measurement for display.
Public function UFunction BlueprintCallable, BlueprintPure, Category bool

GetFilmbackPresetOptions ( TArray< FString >& OutFilmbackPresetsArray
)

 Stores the names of all available filmback presets into an array.
Public function UFunction BlueprintPure, Category FColor Get the current color of the focus plane that should be used
Public function UFunction BlueprintPure, Category FFrameNumber Gets the length of the currently selected level sequence
Public function UFunction BlueprintCallable, Category void

GetLevelSequences ( TArray< FLevelSequenceData >& OutLevelSequenceNames
)

 Returns the names of each level sequence asset in the project
Public function UFunction BlueprintPure, Category float Returns the current matte aspect ratio.
Public function UFunction BlueprintPure, Category float Set the matte aspect ratio to a new value.
Public function UFunction BlueprintPure, Category void

GetMatteValues ( TArray< float >& OutMatteValues
)

 Returns the values of all matte options.
Public function UFunction BlueprintPure, Category FFrameTime Gets the playback position of the level sequence
Public function UFunction BlueprintPure, Category FTimecode Gets the playback Timecode of the level sequence
Public function UFunction BlueprintPure, Category void

GetScreenshotInfo ( FString ScreenshotName,
FVirtualCameraScreenshot& OutScreenshotInfo
)

 Returns the information associated with a Screenshot.
Public function UFunction BlueprintPure, Category void

GetScreenshotNames ( TArray< FString >& OutArray
)

 Collects a list of existing screenshot names.
Public function UFunction BlueprintPure, Category TMap< FString, FVirtualCameraSettingsPreset > Returns a sorted TMap of the current presets.
Public function UFunction BlueprintCallable, Category ACineCameraActor * Returns the target camera that was spawned for this play
Public function UFunction BlueprintPure, Category ETouchInputState Sets the current state of touch input.
Protected function Const UVirtualCameraCineCameraComponent * Convenience function to get camera component for UI functions.
Protected function Const UVirtualCameraMovementComponent * Convenience function to get movement component for UI functions
Protected function Const AVirtualCameraPawnBase * Gets the current Virtual Camera Pawn
Public function UFunction BlueprintPure, Category void

GetWaypointInfo ( FString WaypointName,
FVirtualCameraWaypoint& OutWaypointInfo
)

 Returns the information associated with a waypoint.
Public function UFunction BlueprintPure, Category void

GetWaypointNames ( TArray< FString >& OutArray
)

 Collects a list of existing waypoint names.
Public function void

HandleRecordEnabledStateChange ( const bool bIsRecordEnabled
)

 Function to handle delegate when form playback controller.
Public function UFunction BlueprintCallable, Category void Sets the autofocus point to the correct starting location at the center of the screen
Public function UFunction BlueprintPure, Category bool Checks if an axis is locked.
Public function Const UFunction BlueprintPure, Category bool Checks whether or not focus visualization is activate
Public function UFunction BlueprintPure, Category bool Checks whether or not focus visualization can activate
Protected function Const bool

IsLocationWithinMatte ( const FVector Location
)

 Checks of the touch input
Public function UFunction BlueprintPure, Category bool Check to see if the sequence is playing
Public function UFunction BlueprintPure, Category bool Gets the locked to camera cut from the active LevelSequence
Public function UFunction BlueprintPure, Category bool Helper to check if touch input state is in a touch focus mode.
Public function UFunction BlueprintPure, Category bool Get whether or not global boom is being used when navigating with the joysticks
Protected function Const UFunction Category blueprintnativeevent bool Is this machine should display the Virtual Camera UI and establish a connection with the remote session app.
Public function UFunction BlueprintCallable, Category void Goes to the end of the level sequence and pauses
Public function UFunction BlueprintCallable, Category void Goes to the start of the level sequence and pauses
Public function UFunction BlueprintCallable, Category void

JumpToPlaybackPosition ( const FFrameNumber& InFrameNumber
)

 Sets the playback position of the level sequence.
Public function UFunction BlueprintCallable, Category bool

LoadPreset ( FString PresetName
)

 Loads a preset using its name as a string key.
Public function UFunction BlueprintCallable, Category bool

LoadScreenshotView ( const FString& ScreenshotName
)

 Moves a camera to the location where a screenshot was taken and restores camera settings used for that screenshot.
Protected function void

OnMoveForward ( const float InValue
)

 Handle moving forward/backward input from a controller or touch interface.
Protected function void

OnMoveRight ( const float InValue
)

 Handle moving left/right input from a controller or touch interface.
Protected function void

OnMoveUp ( const float InValue
)

 Handle moving up/down input from a controller or touch interface.
Public function UFunction Category, BlueprintImplementableEvent void

OnRecordEnabledStateChanged ( bool bIsRecordEnabled
)

 Blueprint Event for updating if a sequence can be recorded or not.
Public function UFunction Category, BlueprintImplementableEvent void Blueprint Event for when a sequence stops playing.
Protected function void

OnTouchInput ( const ETouchIndex::Type TouchIndex,
const FVector Location
)

 Determine how to handle touch input based on current context.
Public function UFunction BlueprintCallable, Category void Pauses the playing of the current level sequence.
Protected function void Pilot the controlled camera during recording, copying over settings from the pawn.
Public function UFunction BlueprintCallable, Category void Plays current level sequence
Public function UFunction BlueprintCallable, Category void Plays current level sequence in reverse
Public function UFunction BlueprintCallable, Category void Moves the camera back to actor root and aligns rotation with the input tracker.
Public function UFunction BlueprintCallable, Category void Plays current level sequence from the current time.
Public function UFunction BlueprintCallable, Category void

SaveHomeWaypoint ( const FString& NewHomeWaypointName
)

 Stores the new home waypoint location.
Public function UFunction BlueprintCallable, Category FString

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

 Saves a preset into the list of presets.
Public function UFunction BlueprintCallable, Category FString Stores the current pawn location as a waypoint.
Public function UFunction BlueprintCallable, Category bool

SetActiveLevelSequence ( ULevelSequence* InNewLevelSequence
)

 Changes the active level sequence to a new level sequence.
Public function UFunction BlueprintCallable, Category void

SetAllowFocusPlaneVisualization ( bool bShouldAllowFocusVisualization
)

 Sets whether or not to use focus visualization
Public function UFunction BlueprintCallable, Category float

SetAxisStabilizationScale ( EVirtualCameraAxis AxisToAdjust,
float NewStabilizationAmount
)

 Sets the stabilization rate for a given lock.
Public function UFunction BlueprintCallable, Category void

SetCurrentAperture ( float NewAperture
)

 Set the current aperture value on the camera.
Public function UFunction BlueprintCallable, Category void

SetCurrentFocalLength ( const float NewFocalLength
)

 Sets the current focal length of the cinematic camera to a given value.
Public function UFunction BlueprintCallable, Category void

SetCurrentFocusDistance ( const float NewFocusDistance
)

 Sets the current focus distance of the cinematic camera to a given value.
Public function UFunction BlueprintCallable, Category void

SetDesiredDistanceUnits ( const EUnit DesiredUnits
)

 Sets unit of distance.
Public function UFunction BlueprintCallable, Category bool

SetFilmbackPresetOption ( const FString& NewFilmbackPreset
)

 Set the filmback settings to a new filmback preset.
Protected function void

SetFocusDistanceThroughPoint ( const FVector2D ScreenPosition
)

 Sets the focus distance through a point on the screen.
Protected function void

SetFocusDistanceToActor ( const ETouchIndex::Type TouchIndex,
const FVector& Location
)

 Sets the focus distance to an object selected by the player based on touch input.
Public function UFunction BlueprintCallable, Category void

SetFocusMethod ( const EVirtualCameraFocusMethod NewFocusMethod
)

 Sets the camera focus method.
Public function UFunction BlueprintCallable, Category void

SetFocusPlaneColor ( const FColor NewFocusPlaneColor
)

 Changes focus plane color.
Public function UFunction BlueprintCallable, Category void

SetFocusVisualization ( bool bShowFocusVisualization
)

 Toggles focus visualization tools on camera.
Public function UFunction Category blueprintsetter void Set the input source
Public function UFunction BlueprintCallable, Category bool

SetMatteAspectRatio ( const float NewMatteAspectRatio
)

 Set the matte aspect ratio to a new value.
Public function UFunction BlueprintCallable, Category void

SetMatteOpacity ( const float NewMatteOpacity
)

 Set the matte aspect ratio to a new value.
Public function UFunction BlueprintCallable, Category void

SetMovementScale ( const EVirtualCameraAxis AxisToAdjust,
const float NewMovementScale
)

 Sets the movement scale of the camera actor.
Public function UFunction BlueprintCallable, Category void

SetPresetFavoriteStatus ( const FString& PresetName,
const bool bIsFavorite
)

 Sets whether or not a preset is favorited
Public function UFunction BlueprintCallable, Category void

SetSaveSettingsWhenClosing ( bool bShouldSettingsSave
)

 Sets whether settings should be saved on exit.
Public function UFunction BlueprintCallable, Category void

SetScreenshotFavoriteStatus ( const FString& ScreenshotName,
const bool bIsFavorite
)

 Sets whether or not a screenshot is favorited
Public function UFunction BlueprintCallable, Category void

SetSequencerLockedToCameraCut ( bool bLockView
)

 Sets the locked to camera cut from the active LevelSequence
Public function UFunction BlueprintCallable, Category void Sets the current state of touch input.
Public function UFunction BlueprintCallable, Category void

SetUseGlobalBoom ( bool bShouldUseGlobalBoom
)

 Sets whether or not global boom should be used when navigating with the joysticks
Public function UFunction BlueprintCallable, Category void

SetWaypointFavoriteStatus ( const FString& WaypointName,
const bool bIsFavorite
)

 Sets whether or not a waypoint is favorited
Public function UFunction BlueprintCallable, Category void

SetZeroDutchOnLock ( const bool bInValue
)

 Set the value for the option to zero out dutch when locking that axis.
Public function UFunction BlueprintPure, Category bool Check whether settings should save when closing
Protected function Const UFunction Category blueprintnativeevent bool In multi user session, how should we update the information across different sessions.
Protected function void Will trigger the event to show focus visualization, unless disabled by user.
Public function UFunction BlueprintCallable, Category void Stops the currently playing level sequence.
Public function UFunction BlueprintCallable, Category FString Takes a screenshot from the current view and saves the location and camera settings.
Public function UFunction BlueprintCallable, Category void Teleports to the current marked home waypoint.
Public function UFunction BlueprintCallable, Category bool

TeleportToWaypoint ( const FString& WaypointIndex
)

 Teleports the pawn to a specific location.
Public function UFunction BlueprintCallable, Category bool

ToggleAxisFreeze ( const EVirtualCameraAxis AxisToToggle
)

 Toggles the freeze on a given axis; returns new frozen state.
Public function UFunction BlueprintCallable, Category bool

ToggleAxisLock ( const EVirtualCameraAxis AxisToToggle
)

 Toggles the lock on a given axis; returns new locked state.
Public function UFunction Category, BlueprintImplementableEvent void

UpdateFocusReticle ( FVector NewReticleLocation
)

 Blueprint Event for updating position of autofocus reticle.
Protected function void Get the current tracker data and update the movement component.
Protected function void

UpdateScreenFocus ( const ETouchIndex::Type TouchIndex,
const FVector Location
)

 Moves the point through which the camera auto focuses.

Overridden from APlayerController

  Type Name Description
Protected function Virtual 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.
Public function Virtual void Allows the PlayerController to set up custom input bindings.

Overridden from AController

  Type Name Description
Public function Virtual void

OnPossess ( APawn* InPawn
)

 Overridable native function for when this controller is asked to possess a pawn.

Overridden from AActor

  Type Name Description
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page