| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraPawnBase.h |
Include |
#include "VirtualCameraPawnBase.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable, BlueprintType,
HideCategories=("Pawn", "Camera", "Rendering", "Replication", "Input", "Actor", "HLOD"))
class AVirtualCameraPawnBase :
public APawn,
public IVirtualCameraPresetContainer,
public IVirtualCameraOptions
A class to handle aspects of virtual Camera related to general settings, and communicating with components.
Name | Description | ||
---|---|---|---|
|
bAllowFocusVisualization |
Should focus plane be shown on all touch focus events |
|
|
bSaveSettingsWhenClosing |
Determines if values should be saved between sessions |
|
|
CineCamera |
Cinematic camera used for view |
|
|
DefaultSceneRoot |
Root component |
|
|
DesiredDistanceUnits |
The desired unit in which to display focus distance |
|
|
HomeWaypointName |
Tracks which waypoint is the "home" waypoint, defaults to first value |
|
|
MinimumIntegralDigits |
Number formatter for Screenshots, Waypoints and Presets. |
|
|
MovementComponent |
Movement Component to handle the motion input for the camera |
|
|
SavedSettingsSlotName |
Stores the name of the save slot being used currently |
|
|
Screenshots |
Stores the locations of any screenshots that were taken |
|
|
SettingsPresets |
Stores the list of settings presets, and saved presets |
|
|
Waypoints |
Tracks any waypoints the player has saved for teleporting |
Name | Description | |
---|---|---|
|
AVirtualCameraPawnBase ( |
Name | Description | ||
---|---|---|---|
|
DeletePreset ( |
Deletes a preset using its name as the key. |
|
|
DeletePreset_Implementation ( |
||
|
DeleteScreenshot ( |
Deletes a screenshot, using its name as the key. |
|
|
DeleteWaypoint ( |
Deletes a waypoint, using its name as the key. |
|
|
GetDesiredDistanceUnits() |
Set the matte aspect ratio to a new value. |
|
|
GetDesiredDistanceUnits_Implementation() |
||
|
GetSaveSettingsWhenClosing() |
Gets whether settings should save when closing. |
|
|
GetScreenshotInfo ( |
Returns the information associated with a Screenshot. |
|
|
GetScreenshotNames |
Collects a list of existing screenshot names into an out array. |
|
|
GetSettingsPresets() |
Returns a sorted TMap of the current presets. |
|
|
GetSettingsPresets_Implementation() |
||
|
GetWaypointInfo ( |
Returns the information associated with a waypoint. |
|
|
GetWaypointNames |
Collects a list of existing waypoint names into an out array. |
|
|
HighlightTappedActor ( |
Blueprint event to trigger the highlighting of a specific actor. |
|
|
IsAutoFocusEnabled() |
Check to see if the camera is in autofocus mode. |
|
|
IsFocusVisualizationAllowed() |
Checks whether or not focus visualization can activate |
|
|
IsFocusVisualizationAllowed_Implementation() |
||
|
LeftPadWithZeros |
Convenience function to leftpad numbers with zeros |
|
|
LoadFinished() |
Blueprint event for signaling UI that game settings have been loaded. |
|
|
LoadPreset ( |
Loads a preset using its name as a string key. |
|
|
LoadPreset_Implementation ( |
||
|
LoadScreenshotView ( |
Moves a camera to the location where a screenshot was taken and restores camera settings used for that screenshot. |
|
|
LoadSettings() |
Loads camera settings from a saved file. |
|
|
ProcessMovementInput |
Send any movement input data forward to the Movement Component. |
|
|
RenameScreenshotLocation |
Change the name of a waypoint to a different name. |
|
|
RenameWaypoint |
Change the name of a waypoint to a different name. |
|
|
SaveHomeWaypoint ( |
Stores the new home location. |
|
|
SavePreset |
Saves a preset into the list of presets. |
|
|
SavePreset_Implementation |
||
|
SaveSettings() |
Stores the current camera settings to a save file for later use. |
|
|
SaveWaypoint() |
Stores the current pawn location as a waypoint. |
|
|
SetAllowFocusPlaneVisualization ( |
Sets whether or not focus visualization can activate |
|
|
SetDesiredDistanceUnits ( |
Set the matte aspect ratio to a new value. |
|
|
SetDesiredDistanceUnits_Implementation ( |
||
|
SetFocusDistance ( |
Forwards any focus change commands from outside sources to the camera component. |
|
|
SetPresetFavoriteStatus |
Sets whether or not a preset is favorited |
|
|
SetSaveSettingsWhenClosing ( |
Sets whether settings should be saved on exit. |
|
|
SetScreenshotFavoriteStatus |
Sets whether or not a screenshot is favorited |
|
|
SetTrackedActorForFocus |
Forwards tracked actor changes to the camera component to be handled. |
|
|
SetWaypointFavoriteStatus |
Sets whether or not a waypoint is favorited |
|
|
TakeScreenshot() |
Takes a screenshot from the current view and saves the location and camera settings. |
|
|
TeleportToHomeWaypoint() |
Teleports the pawn to the current marked home waypoint. |
|
|
TeleportToWaypoint ( |
Teleports the pawn to a location associated with the specified waypoint. |
|
|
TriggerFocusPlaneTimer() |
Blueprint event to trigger focus plane visualization for a set amount of time. |
|
|
UpdateSettingsFromPreset ( |
Updates the current settings to reflect those in the preset. |
Name | Description | ||
---|---|---|---|
|
BeginPlay() |
Overridable native event for when play begins for this actor. |
|
|
EndPlay ( |
Overridable function called whenever this actor is being removed from a level |
Name |
Description |
---|---|
PresetIndex |
The next preset number |
ScreenshotIndex |
The next screenshot number |
WaypointIndex |
The next waypoint number |