Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CameraCalibrationCore > ULensDistortionModelHandlerBase

Light Theme

Dark Theme

ULensDistortionModelHandlerBase

Asset user data that can be used on Camera Actors to manage lens distortion state and utilities

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULensDistortionModelHandlerBase

USphericalLensDistortionModelHandler

References

Module	CameraCalibrationCore
Header	/Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/LensDistortionModelHandlerBase.h
Include	#include "LensDistortionModelHandlerBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class ULensDistortionModelHandlerBase : public UObject

Remarks

Asset user data that can be used on Camera Actors to manage lens distortion state and utilities

Variables

	Name	Description
FLensDistortion...	CurrentState	Current state as set by the most recent call to Update()
FString	DisplayName	Display name, used to identify handler in-editor details panels
UMaterialInstan...	DistortionDisplacementMapMID	MID used to draw the distortion displacement map
UTextureRenderT...	DistortionDisplacementMapRT	UV displacement map used to distort an undistorted image
UMaterialInstan...	DistortionPostProcessMID	Dynamically created post-process material instance for the currently specified lens model
FGuid	DistortionProducerID	UObject that is producing the distortion state for this handler
TSubclassOf< UL...	LensModelClass	Create the distortion MIDs Set the material parameters for the displacement map and distortion post-process materials Convert the generic distortion parameter array into the specific structure of parameters used by the supported lens model Lens Model describing how to interpret the distortion parameters
float	OverscanFactor	Computed overscan factor needed to scale the camera's FOV (read-only)
UMaterialInstan...	UndistortionDisplacementMapMID	MID used to draw the undistortion displacement map
UTextureRenderT...	UndistortionDisplacementMapRT	UV displacement map used to undistort a distorted image

Functions

	Name	Description
float	ComputeOverscanFactor()	Use the current distortion state to compute the overscan factor needed such that all distorted UVs will fall into the valid range of [0,1]
bool	DrawDistortionDisplacementMap ( UTextureRenderTarget2D* Destin... )	Draw the distortion displacement map associated with the current state to the DestinationTexture
bool	DrawUndistortionDisplacementMap ( UTextureRenderTarget2D* Destin... )	Draw the undistortion displacement map associated with the current state to the DestinationTexture
FLensDistort...	GetCurrentDistortionState()	Get the current distortion state (the lens model and properties that mathematically represent the distortion characteristics
FString	GetDisplayName()	Get the display name of this lens distortion model handler
TArray< FVec...	GetDistortedUVs ( TConstArrayView< FVector2D > Undist... )	Computes the distorted version of UndistortedUVs based on the current state
UTextureRend...	GetDistortionDisplacementMap()	Get the UV displacement map used to distort an undistorted image
UMaterialIns...	GetDistortionMID()	Get the post-process MID for the currently specified lens model
FGuid	GetDistortionProducerID()	Get the UObject that produces the distortion state for this handler
FVector2D	GetFxFy()	Get the normalized focal length (unitless)
const TSubcl...	GetLensModelClass()	Get the specified lens model that characterizes the distortion effect
float	GetOverscanFactor()	Returns the last overscan factor that was set
FVector2D	GetPrincipalPoint()	Get the normalized center of projection of the image, in the range [0.0f, 1.0f]
UTextureRend...	GetUndistortionDisplacementMap()	Get the UV displacement map used to undistort a distorted image
bool	IsModelSupported ( const TSubclassOf< ULensModel >& M... )	Returns true if the input model is supported by this model handler, false otherwise.
void	ProcessCurrentDistortion()	Draws the current distortion state to the internal displacement map
void	SetDisplayName ( FString InDisplayName )	Set the display name of this lens distortion model handler
void	SetDistortionProducerID ( const FGuid& InDistortionProducerI... )	Set the UObject that produces the distortion state for this handler
void	SetDistortionState ( const FLensDistortionState& InNewS... )	Update the lens distortion state, recompute the overscan factor, and set all material parameters
void	SetOverscanFactor ( float OverscanFactor )	Updates overscan factor and applies to material instances

Overridden from UObject

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Name	Description
DisplacementMapHeight
DisplacementMapWidth

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

Take our survey

Dismiss