1. Epic GamesDeveloper
  3. UVirtualCameraMovementComponent

UVirtualCameraMovementComponent

API > API/Plugins > API/Plugins/VirtualCamera

Inheritance Hierarchy

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
Public variable TMap< EVirtualCameraAxis, FVirtualCameraAxisSettings > AxisSettings Stores all settings for each axis
Public variable bool bLockRelativeToFirstLockAxis Tracks whether user wants to cache a locking axis set or always use local
Public variable bool bUseGlobalBoom Tracks if boom should be global or relative to the camera
Public variable bool bZeroDutchOnLock Tracks if dutch should be reset to zero when freezing view
Public variable FVirtualCameraResetOffsetsDelegate OnOffsetReset Delegate to broadcast when tracker offsets are reset

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddInputVectorFromController ( FVector WorldVector,
EVirtualCameraAxis MovementScaleAxis
)

 Adds the given vector to the accumulated input in world space.
Public function Const float

GetAxisMovementScale ( const EVirtualCameraAxis AxisToRetrieve
)

 Gets the movement scale for a given axis.
Public function Const float Gets the stabilization rate for a given axis.
Public function Const float

GetMovementScale ( const EVirtualCameraAxis AxisToRetrieve
)

 Gets the movement scale of the camera actor
Public function Const bool

IsAxisLocked ( const EVirtualCameraAxis AxisToCheck
)

 Checks if an axis is locked.
Public function Const bool Get the value for the option to zero out dutch when locking that axis.
Public function Const bool Check to see if any location locks are active
Public function Const bool Get whether or not global boom is being used when navigating with the joysticks
Public function void

OnMoveForward ( const float InValue
)

 Handle a move forward command from the owner.
Public function void

OnMoveRight ( const float InValue
)

 Handle a move right command from the owner.
Public function void

OnMoveUp ( const float InValue
)

 Handle a move up command from the owner.
Public function void

ProcessMovementInput ( const FVector& Location,
const FRotator& Rotation
)

 Update the position and rotation of the camera.
Public function void Moves the camera back to actor root and aligns rotation with the input tracker.
Public function float

SetAxisStabilizationScale ( const EVirtualCameraAxis AxisToAdjust,
float NewStabilizationAmount
)

 Sets the stabilization rate for a given lock.
Public function void

SetMovementScale ( const EVirtualCameraAxis AxisToAdjust,
const float NewMovementScale
)

 Sets the movement scale of the camera actor
Public function void

SetRootComponent ( USceneComponent* FromController
)

 When the input come from a physical controller, move this component instead.
Public function void

SetUseGlobalBoom ( bool bShouldUseGlobalBoom
)

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

SetZeroDutchOnLock ( const bool bInValue
)

 Set the value for the option to zero out dutch when locking that axis.
Public function void

Teleport ( const FTransform& TargetTransform
)

 Teleport to a provided location and rotation.
Public function bool

ToggleAxisFreeze ( const EVirtualCameraAxis AxisToToggle
)

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

ToggleAxisLock ( const EVirtualCameraAxis AxisToToggle
)

 Toggles the lock on a given axis; returns new locked state.

Overridden from UPawnMovementComponent

  Type Name Description
Public function Virtual void

AddInputVector ( FVector WorldVector,
bool bForce
)

 Adds the given vector to the accumulated input in world space.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page