FVirtualCameraAxisSettings

Stores relevant information for an axis for the virtual camera pawn

Windows
MacOS
Linux

References

Module

VirtualCamera

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraSaveGame.h

Include

#include "VirtualCameraSaveGame.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FVirtualCameraAxisSettings

Remarks

Stores relevant information for an axis for the virtual camera pawn

Variables

Name Description

Public variable UProperty

bool

 

bIsFrozen

If an axis is frozen, then that frozen axis's movement will be disabled.

Public variable UProperty

bool

 

bIsLocked

If an axis is locked, then that axis's movement will be disabled.

Public variable

FVector

 

FreezeLocationOffset

Public variable

float

 

FreezeRotationOffset

The freeze offset associated with an axis

Public variable

FVector

 

LockLocationOffset

Public variable

float

 

LockRotationOffset

The lock offset associated with an axis

Public variable UProperty

float

 

MovementScale

The scale that a user's movement should be adjusted by in game

Public variable UProperty

float

 

StabilizationScale

The amount of stabilization that can be applied to an axis

Constructors

Name Description

Public function

FVirtualCameraAxisSettings()

Functions

Name Description

Public function

void

 

AddLocationOffset

(
    const FVector InOffset
)

Add an offset based on the freeze and lock states

Public function

void

 

AddRotationOffset

(
    const float InOffset
)

Add an offset based on the freeze and lock states

Public function Const

FVector

 

GetLocationOffset()

Public function Const

float

 

GetRotationOffset()

Get the current total offset applied to this axis

Public function Const

bool

 

IsAxisImmobilized()

Helper method to check if an axis is prevented from moving.

Public function

void

 

SetIsLocked

(
    const bool bNewIsLocked
)

Set the current lock state

Public function

bool

 

ToggleLock()

Toggle the current lock state

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss