1. Epic GamesDeveloper
  3. FCameraPoseMath

FCameraPoseMath

A utility class for mathematical functions related to a camera pose.

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Math

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Math/CameraPoseMath.h
Include #include "Math/CameraPoseMath.h"

Syntax

class FCameraPoseMath

Remarks

A utility class for mathematical functions related to a camera pose.

Functions

  Type Name Description
Public function Static FMatrix

BuildProjectionMatrix ( const FCameraPose& CameraPose,
double AspectRatio
)

 Builds the projection matrix of the given camera pose.
Public function Static FMatrix

BuildViewProjectionMatrix ( const FCameraPose& CameraPose,
double AspectRatio
)

 Builds the view-projection matrix of the given camera pose.
Public function Static double

GetEffectiveAspectRatio ( const FCameraPose& CameraPose,
const APlayerController* PlayerController
)

 Gets the aspect ratio of the viewport associated with the given player controller.
Public function Static FCameraFieldsOfView

GetEffectiveFieldsOfView ( const FCameraPose& CameraPose
)

 Gets both horizontal and vertical effective fields of view, using the sensor aspect ratio.
Public function Static FCameraFieldsOfView

GetEffectiveFieldsOfView ( const FCameraPose& CameraPose,
const APlayerController* PlayerController
)

 Gets both horizontal and vertical effective fields of view, using the given player controller's viewport aspect ratio.
Public function Static FCameraFieldsOfView

GetEffectiveFieldsOfView ( const FCameraPose& CameraPose,
double AspectRatio
)

 Gets both horizontal and vertical effective fields of view, using the given aspect ratio.
Public function Static TOptional< FVector2d >

ProjectCameraToScreen ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector3d& CameraSpaceLocation,
bool bForceLocationInsideFrustum
)

 Projects the given camera-local point onto screen-space.
Public function Static TOptional< FVector2d >

ProjectToScreen ( const FMatrix& ViewProjectionMatrix,
const FVector3d& Location,
bool bForceLocationInsideFrustum
)

 Projects the given point onto screen-space.
Public function Static TOptional< FVector2d >

ProjectWorldToScreen ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector3d& WorldLocation,
bool bForceLocationInsideFrustum
)

 Projects the given world point onto screen-space.
Public function Static FRay3d

UnprojectFromScreen ( const FMatrix& InverseViewProjectionMatrix,
const FVector2D& ScreenSpacePoint
)

 Unprojects the given screen-space point into a ray.
Public function Static FVector3d

UnprojectFromScreen ( const FMatrix& InverseViewProjectionMatrix,
const FVector2D& ScreenSpacePoint,
double PredictedDistance
)

 Unprojects the given screen-space point into a point given an expected distance.
Public function Static FRay3d

UnprojectScreenToCamera ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector2D& ScreenSpacePoint
)

 Unproject a screen-space point into a camera-local ray.
Public function Static FVector3d

UnprojectScreenToCamera ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector2D& ScreenSpacePoint,
double PredictedDistance
)

 Unproject a screen-space point into a camera-local point given an expected distance.
Public function Static FRay3d

UnprojectScreenToWorld ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector2D& ScreenSpacePoint
)

 Unproject a screen-space point into a world-space ray.
Public function Static FVector3d

UnprojectScreenToWorld ( const FCameraPose& CameraPose,
double AspectRatio,
const FVector2D& ScreenSpacePoint,
double PredictedDistance
)

 Unproject a screen-space point into a world-space point given an expected distance.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page