Navigation
API > API/Plugins > API/Plugins/VirtualCamera
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UMovementComponent
- UNavMovementComponent
- UPawnMovementComponent
- UVirtualCameraMovementComponent
References
| Module | VirtualCamera |
| Header | /Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraMovementComponent.h |
| Include | #include "VirtualCameraMovementComponent.h" |
Syntax
UCLASS&40;&41;
class UVirtualCameraMovementComponent : public UPawnMovementComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
| TMap< EVirtualCameraAxis, FVirtualCameraAxisSettings > | AxisSettings | Stores all settings for each axis | |
| bool | bLockRelativeToFirstLockAxis | Tracks whether user wants to cache a locking axis set or always use local | |
| bool | bUseGlobalBoom | Tracks if boom should be global or relative to the camera | |
| bool | bZeroDutchOnLock | Tracks if dutch should be reset to zero when freezing view | |
| FVirtualCameraResetOffsetsDelegate | OnOffsetReset | Delegate to broadcast when tracker offsets are reset |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UVirtualCameraMovementComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddInputVectorFromController
(
FVector WorldVector, |
Adds the given vector to the accumulated input in world space. | |
| float | GetAxisMovementScale
(
const EVirtualCameraAxis AxisToRetrieve |
Gets the movement scale for a given axis. | |
| float | GetAxisStabilizationScale
(
const EVirtualCameraAxis AxisToRetrieve |
Gets the stabilization rate for a given axis. | |
| float | GetMovementScale
(
const EVirtualCameraAxis AxisToRetrieve |
Gets the movement scale of the camera actor | |
| bool | IsAxisLocked
(
const EVirtualCameraAxis AxisToCheck |
Checks if an axis is locked. | |
| bool | Get the value for the option to zero out dutch when locking that axis. | ||
| bool | Check to see if any location locks are active | ||
| bool | Get whether or not global boom is being used when navigating with the joysticks | ||
| void | OnMoveForward
(
const float InValue |
Handle a move forward command from the owner. | |
| void | OnMoveRight
(
const float InValue |
Handle a move right command from the owner. | |
| void | OnMoveUp
(
const float InValue |
Handle a move up command from the owner. | |
| void | ProcessMovementInput
(
const FVector& Location, |
Update the position and rotation of the camera. | |
| void | Moves the camera back to actor root and aligns rotation with the input tracker. | ||
| float | SetAxisStabilizationScale
(
const EVirtualCameraAxis AxisToAdjust, |
Sets the stabilization rate for a given lock. | |
| void | SetMovementScale
(
const EVirtualCameraAxis AxisToAdjust, |
Sets the movement scale of the camera actor | |
| void | SetRootComponent
(
USceneComponent* FromController |
When the input come from a physical controller, move this component instead. | |
| void | SetUseGlobalBoom
(
bool bShouldUseGlobalBoom |
Sets whether or not global boom should be used when navigating with the joysticks | |
| void | SetZeroDutchOnLock
(
const bool bInValue |
Set the value for the option to zero out dutch when locking that axis. | |
| void | Teleport
(
const FTransform& TargetTransform |
Teleport to a provided location and rotation. | |
| bool | ToggleAxisFreeze
(
const EVirtualCameraAxis AxisToToggle |
Toggles the freeze on a given axis; returns new frozen state. | |
| bool | ToggleAxisLock
(
const EVirtualCameraAxis AxisToToggle |
Toggles the lock on a given axis; returns new locked state. |
Overridden from UPawnMovementComponent
| Type | Name | Description | |
|---|---|---|---|
| void | AddInputVector
(
FVector WorldVector, |
Adds the given vector to the accumulated input in world space. |