1. Epic GamesDeveloper
  3. FCameraPose

FCameraPose

Structure describing the state of a camera.

API > API/Plugins > API/Plugins/GameplayCameras

Structure describing the state of a camera.

Fields are private and can only be accessed via the getters and setters. The ChangedFlags structure keeps track of which fields were changed via the setters.

   
Name FCameraPose
Type struct
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraPose.h
Include Path #include "Core/CameraPose.h"

Syntax

USTRUCT ()  
struct FCameraPose

Constructors

Name Remarks Include Path Unreal Specifiers

FCameraPose()

   Core/CameraPose.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Aperture float The aperture of the camera's lens, in f-stops Core/CameraPose.h  
AspectRatioAxisConstraint TEnumAsByte< EAspectRatioAxisConstraint > If ConstrainAspectRatio is false and OverrideAspectRatioAxisConstraint is true, how we should compute FieldOfView Core/CameraPose.h  
ChangedFlags FCameraPoseFlags Flags keeping track of which properties were written to since last time the flags were cleared. Core/CameraPose.h  
ConstrainAspectRatio bool Whether to constrain aspect ratio Core/CameraPose.h  
DiaphragmBladeCount int32 Number of blades in the lens diaphragm Core/CameraPose.h  
EnablePhysicalCamera bool Whether to setup post-process settings based on physical camera properties such as Aperture, FocusDistance, DiaphragmBladeCount, and so on. Core/CameraPose.h  
FarClippingPlane float The distance to the far clipping plane, in world units Core/CameraPose.h  
FieldOfView float The horizontal field of view of the camera, in degrees If zero or less, focal length is used instead Core/CameraPose.h  
FocalLength float The focal length of the camera's lens, in millimeters If zero or less, field of view is used instead Core/CameraPose.h  
FocusDistance float The focus distance of the camera's lens, in world units Core/CameraPose.h  
ISO float The camera sensor sensitivity in ISO. Core/CameraPose.h  
Location FVector3d The location of the camera in the world Core/CameraPose.h  
NearClippingPlane float The distance to the near clipping plane, in world units Core/CameraPose.h  
OrthographicWidth float The desired width (in world units) of the orthographic view (ignored in Perspective mode) Core/CameraPose.h  
OverrideAspectRatioAxisConstraint bool Whether to override the default aspect ratio axis constraint defined on the player controller Core/CameraPose.h  
Overscan float Sensor overscan in percentage Core/CameraPose.h  
PhysicalCameraBlendWeight float An internal weight for the physical camera post-process settings, used when blending between cameras with EnablePhysicalCamera enabled/disabled. Core/CameraPose.h  
ProjectionMode TEnumAsByte< ECameraProjectionMode::Type > Projection mode - Perspective or orthographic Core/CameraPose.h  
Rotation FRotator3d The rotation of the camera in the world Core/CameraPose.h  
SensorHeight float The height of the camera's sensor, in millimeters Core/CameraPose.h  
SensorHorizontalOffset float Horizontal offset of the sensor, in mm. Core/CameraPose.h  
SensorVerticalOffset float Vertical offset of the sensor, in mm. Core/CameraPose.h  
SensorWidth float The width of the camera's sensor, in millimeters Core/CameraPose.h  
ShutterSpeed float The shutter speed of the camera's lens, in 1/seconds Core/CameraPose.h  
SqueezeFactor float Squeeze factor for anamorphic lenses Core/CameraPose.h  
TargetDistance double Distance to the target Core/CameraPose.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyPhysicalCameraSettings ( FPostProcessSettings& PostProcessSettings,
bool bOverwriteSettings
) const

 Applies the necessary post-process settings given the current values on this camera pose. Core/CameraPose.h  

void ClearAllChangedFlags()

 Set all fields as clean. Core/CameraPose.h  

FVector3d GetAimDir()

 Gets the aiming direction of the camera. Core/CameraPose.h  

FRay3d GetAimRay()

 Gets the aiming ray of the camera. Core/CameraPose.h  

float GetAperture()

   Core/CameraPose.h  

EAspectRatioAxisConstraint GetAspectRatioAxisConstraint()

   Core/CameraPose.h  
Get the changed flags. Core/CameraPose.h  
Get the changed flags. Core/CameraPose.h  

bool GetConstrainAspectRatio()

   Core/CameraPose.h  

int32 GetDiaphragmBladeCount()

   Core/CameraPose.h  

double GetEffectiveFieldOfView ( bool bIncludeOverscan
) const

 Computes the horizontal field of view of the camera. Core/CameraPose.h  

bool GetEnablePhysicalCamera()

   Core/CameraPose.h  

float GetFarClippingPlane()

   Core/CameraPose.h  

float GetFieldOfView()

   Core/CameraPose.h  

float GetFocalLength()

   Core/CameraPose.h  

float GetFocusDistance()

   Core/CameraPose.h  

double GetHorizontalProjectionOffset()

 Gets the horizontal projection offset. Core/CameraPose.h  

float GetISO()

   Core/CameraPose.h  

FVector GetLocation()

   Core/CameraPose.h  

float GetNearClippingPlane()

   Core/CameraPose.h  

float GetOrthographicWidth()

   Core/CameraPose.h  

bool GetOverrideAspectRatioAxisConstraint()

   Core/CameraPose.h  

float GetOverscan()

   Core/CameraPose.h  

float GetPhysicalCameraBlendWeight()

   Core/CameraPose.h  

ECameraProjectionMode::Type GetProjectionMode()

   Core/CameraPose.h  

FRotator3d GetRotation()

   Core/CameraPose.h  
Gets the aspect ratio of the camera sensor. Core/CameraPose.h  

float GetSensorHeight()

   Core/CameraPose.h  

float GetSensorHorizontalOffset()

   Core/CameraPose.h  

float GetSensorVerticalOffset()

   Core/CameraPose.h  

float GetSensorWidth()

   Core/CameraPose.h  

float GetShutterSpeed()

   Core/CameraPose.h  

float GetSqueezeFactor()

   Core/CameraPose.h  

FVector3d GetTarget ( double InTargetDistance
) const

 Gets the location of the camera's target given a specific distance. Core/CameraPose.h  

FVector3d GetTarget ()

 Gets the location of the camera's target. Core/CameraPose.h  

double GetTargetDistance()

   Core/CameraPose.h  

FTransform3d GetTransform()

 Gets the transform of the camera. Core/CameraPose.h  

double GetVerticalProjectionOffset()

 Gets the vertical projection offset. Core/CameraPose.h  

void LerpAll ( const FCameraPose& ToPose,
float Factor
)

 Interpolates all properties from ToPose using the given factor. Core/CameraPose.h  

void LerpChanged ( const FCameraPose& ToPose,
float Factor,
const FCameraPoseFlags& InMask,
bool bInvertMask,
FCameraPoseFlags& OutMask
)

 Interpolates changed properties from ToPose using the given factor. Core/CameraPose.h  

void LerpChanged ( const FCameraPose& ToPose,
float Factor
)

 Interpolates all changed properties from ToPose using the given factor. Core/CameraPose.h  

void OverrideAll ( const FCameraPose& OtherPose
)

 Takes all properties from OtherPose and sets them on this camera pose. Core/CameraPose.h  

void OverrideChanged ( const FCameraPose& OtherPose
)

 Takes all changed properties from OtherPose and sets them on this camera pose. Core/CameraPose.h  

void Reset()

 Resets this camera pose to its default values, with all changed flags off. Core/CameraPose.h  
Serializes this camera pose including the written-property flags. Core/CameraPose.h  

void SetAllChangedFlags()

 Set all fields as changed. Core/CameraPose.h  

void SetAperture ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetAspectRatioAxisConstraint ( TCallTraits< EAspectRatioAxisConstraint >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetChangedFlags ( const FCameraPoseFlags& InChangedFlags
)

 Set the changed flags. Core/CameraPose.h  

void SetConstrainAspectRatio ( TCallTraits< bool >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetDiaphragmBladeCount ( TCallTraits< int32 >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetEnablePhysicalCamera ( TCallTraits< bool >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetFarClippingPlane ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetFieldOfView ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetFocalLength ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetFocusDistance ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetISO ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetLocation ( TCallTraits< FVector >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetNearClippingPlane ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetOrthographicWidth ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetOverrideAspectRatioAxisConstraint ( TCallTraits< bool >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetOverscan ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetPhysicalCameraBlendWeight ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetProjectionMode ( TCallTraits< ECameraProjectionMode::Type >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetRotation ( TCallTraits< FRotator3d >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetSensorHeight ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetSensorHorizontalOffset ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetSensorVerticalOffset ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetSensorWidth ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetShutterSpeed ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetSqueezeFactor ( TCallTraits< float >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetTargetDistance ( TCallTraits< double >::ParamType InValue,
bool bForceSet
)

   Core/CameraPose.h  

void SetTransform ( FTransform3d Transform,
bool bForceSet
)

 Sets the transform of the camera. Core/CameraPose.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetDefaultSensorSize ( float& OutSensorWidth,
float& OutSensorHeight
)

 Gets the default sensor size. Core/CameraPose.h  

static double GetEffectiveFieldOfView ( float FocalLength,
float FieldOfView,
float SensorWidth,
float SensorHeight,
float SqueezeFactor,
float Overscan
)

 Computes the horizontal field of view of a camera. Core/CameraPose.h  

static double GetSensorAspectRatio ( float SensorWidth,
float SensorHeight
)

 Computes the aspect ratio of a camera sensor. Core/CameraPose.h  

static void SerializeWithFlags ( FArchive& Ar,
FCameraPose& CameraPose
)

 Serializes the given camera pose including the written-property flags. Core/CameraPose.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page