Navigation
API > API/Plugins > API/Plugins/VirtualCamera
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVirtualCameraUserSettings
References
| Module | VirtualCamera |
| Header | /Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraUserSettings.h |
| Include | #include "VirtualCameraUserSettings.h" |
Syntax
UCLASS&40;Config&61;VirtualCamera, BlueprintType&41;
class UVirtualCameraUserSettings : public UObject
Remarks
Virtual Camera User Settings
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< struct FInputActionKeyMapping > | ActionMappings | ||
| TArray< struct FInputAxisKeyMapping > | AxisMappings | ||
| bool | bDisplayFilmLeader | Whether to display film leader when recording a take | |
| bool | bIsMapGrayscale | Whether the map is displayed using grayscale or full color | |
| bool | bOverrideCameraSettingsOnTeleportToScreenshot | Whether to change camera lens and fstop when teleporting to a screenshot to those with which the screenshot was taken | |
| bool | bTeleportOnStart | Whether to teleport to the home bookmark when VCam starts | |
| TSoftClassPtr< AActor > | DefaultVCamClass | Default Vcam Class for Vcam Operator Panel | |
| float | FocusInterpSpeed | Controls interpolation speed when smoothing when changing focus distance. | |
| float | JoysticksSpeed | Controls how fast the camera moves when using joysticks | |
| float | MaxJoysticksSpeed | Sets the maximum possible joystick speed | |
| FString | VirtualCameraFilmback | Stores the filmback preset name selected by the user |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | GetActionMappingsByName
(
const FName InActionName, |
Retrieve all VirtualCamera action mappings by a certain name. | |
| void | GetAxisMappingsByName
(
const FName InAxisName, |
Retrieve all VirtualCamera axis mappings by a certain name. | |
| float | Get FocusInterpSpeed variable | ||
| float | Get JoysticksSpeed variable | ||
| float | Get MaxJoysticksSpeed variable | ||
| FString | Get VirtualCameraFilmback variable | ||
| bool | Get bDisplayFilmLeader variable | ||
| bool | Get bOverrideCameraSettingsOnTeleportToScreenshot variable | ||
| bool | Get bTeleportOnStart variable | ||
| void | Fills the Axis/Action mappings with assosiated gamepad bindings | ||
| bool | Get bIsMapGrayscale variable | ||
| void | SetFocusInterpSpeed
(
const float InFocusInterpSpeed |
Set FocusInterpSpeed variable | |
| void | SetIsMapGrayscle
(
const bool bInIsMapGrayscle |
Set bIsMapGrayscale variable | |
| void | SetJoysticksSpeed
(
const float InJoysticksSpeed |
Set JoysticksSpeed variable | |
| void | SetMaxJoysticksSpeed
(
const float InMaxJoysticksSpeed |
Set MaxJoysticksSpeed variable | |
| void | SetSavedVirtualCameraFilmbackPresetName
(
const FString& InFilmback |
Set VirtualCameraFilmback variable | |
| void | SetShouldDisplayFilmLeader
(
const bool bInDisplayFilmLeader |
Set bDisplayFilmLeader variable | |
| void | SetShouldOverrideCameraSettingsOnTeleport
(
const bool bInOverrideCameraSettings |
Set bOverrideCameraSettingsOnTeleportToScreenshot variable | |
| void | SetTeleportOnStart
(
const bool bInTeleportOnStart |
Set bTeleportOnStart variable |