1. Epic GamesDeveloper
  3. FCameraPose

FCameraPose

Structure describing the state of a camera.

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Core

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraPose.h
Include #include "Core/CameraPose.h"

Syntax

USTRUCT ()  
struct FCameraPose

Remarks

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.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool

ApplyPhysicalCameraSettings ( FPostProcessSettings& PostProcessSettings,
bool bOverwriteSettings
)

 Applies the necessary post-process settings given the current values on this camera pose.
Public function void Set all fields as clean.
Public function Const FVector3d Gets the aiming direction of the camera.
Public function Const FRay3d Gets the aiming ray of the camera.
Public function Const float  
Public function Const EAspectRatioAxisConstraint  
Public function Const const FCameraPoseFlags & Get the changed flags.
Public function FCameraPoseFlags & Get the changed flags.
Public function Const bool  
Public function Static void

GetDefaultSensorSize ( float& OutSensorWidth,
float& OutSensorHeight
)

 Gets the default sensor size.
Public function Const int32  
Public function Const double Computes the horizontal field of view of the camera.
Public function Static double

GetEffectiveFieldOfView ( float FocalLength,
float FieldOfView,
float SensorWidth,
float SensorHeight,
float SqueezeFactor
)

 Computes the horizontal field of view of a camera.
Public function Const bool  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float

GetISO ()

  
Public function Const FVector  
Public function Const float  
Public function Const bool  
Public function Const float  
Public function Const FRotator3d  
Public function Static double

GetSensorAspectRatio ( float SensorWidth,
float SensorHeight
)

 Computes the aspect ratio of a camera sensor.
Public function Const double Gets the aspect ratio of the camera sensor.
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const FVector3d

GetTarget ( double InTargetDistance
)

 Gets the location of the camera's target given a specific distance.
Public function Const FVector3d Gets the location of the camera's target.
Public function Const double  
Public function Const FTransform3d Gets the transform of the camera.
Public function void

LerpAll ( const FCameraPose& ToPose,
float Factor
)

 Interpolates all properties from ToPose using the given factor.
Public function void

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

 Interpolates changed properties from ToPose using the given factor.
Public function void

LerpChanged ( const FCameraPose& ToPose,
float Factor
)

 Interpolates all changed properties from ToPose using the given factor.
Public function void

OverrideAll ( const FCameraPose& OtherPose
)

 Takes all properties from OtherPose and sets them on this camera pose.
Public function void

OverrideChanged ( const FCameraPose& OtherPose
)

 Takes all changed properties from OtherPose and sets them on this camera pose.
Public function void

Reset ()

 Resets this camera pose to its default values, with all changed flags off.
Public function Static void

SerializeWithFlags ( FArchive& Ar,
FCameraPose& CameraPose
)

 Serializes the given camera pose including the written-property flags.
Public function void

SerializeWithFlags ( FArchive& Ar
)

 Serializes this camera pose including the written-property flags.
Public function void Set all fields as changed.
Public function void

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

  
Public function void

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

  
Public function void

SetChangedFlags ( const FCameraPoseFlags& InChangedFlags
)

 Set the changed flags.
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

SetTransform ( FTransform3d Transform
)

 Sets the transform of the camera.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page