FLensDistortionCameraModel

Mathematic camera model for lens distortion/undistortion.

Windows
MacOS
Linux

References

Module

LensDistortion

Header

/Engine/Plugins/Compositing/LensDistortion/Source/LensDistortion/Classes/LensDistortionAPI.h

Include

#include "LensDistortionAPI.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FLensDistortionCameraModel

Remarks

Mathematic camera model for lens distortion/undistortion.

Camera matrix = | F.X 0 C.x | | 0 F.Y C.Y | | 0 0 1 |

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

FVector2D

 

C

Camera matrix's Cx and Cy.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

FVector2D

 

F

Camera matrix's Fx and Fy.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

float

 

K1

Radial parameter #1.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

float

 

K2

Radial parameter #2.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

float

 

K3

Radial parameter #3.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

float

 

P1

Tangential parameter #1.

Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite

float

 

P2

Tangential parameter #2.

Constructors

Name Description

Public function

FLensDistortionCameraModel()

Functions

Name Description

Public function Const

void

 

DrawUVDisplacementToRenderTarget

(
    UWorld* World,
    float DistortedHorizontalFOV,
    float DistortedAspectRatio,
    float UndistortOverscanFactor,
    UTextureRenderTarget2D* Output...,
    float OutputMultiply,
    float OutputAdd
)

Draws UV displacement map within the output render target.

Public function Const

float

 

GetUndistortOverscanFactor

(
    float DistortedHorizontalFOV,
    float DistortedAspectRatio
)

Returns the overscan factor required for the undistort rendering to avoid unrendered distorted pixels.

Public function Const

FVector2D

 

UndistortNormalizedViewPosition

(
    FVector2D V
)

Undistorts 3d vector (x, y, z=1.f) in the view space and returns (x', y', z'=1.f).

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FLensDistortionCameraModel& ...
)

Compare two lens distortion models and return whether they are different.

Public function Const

bool

 

operator==

(
    const FLensDistortionCameraModel& ...
)

Compare two lens distortion models and return whether they are equal.

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