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 > ULensFile

Light Theme

Dark Theme

ULensFile

A Lens file containing calibration mapping from FIZ data

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULensFile

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class ULensFile :
public UObject,
public FTickableGameObject

Remarks

A Lens file containing calibration mapping from FIZ data

Variables

	Name	Description
TUniquePtr< ICa...	CalibratedMapProcessor	Processor handling derived data out of calibrated st maps
ELensDataMode	DataMode	Type of data used for lens mapping
int32	DerivedDataInFlightCount	Derived data compute jobs we are waiting on
TArray< UTextur...	DistortionDisplacementMapHolders	Texture used to store temporary distortion displacement map when using map blending
FDistortionTabl...	DistortionTable	Distortion parameters table mapping to input focus/zoom
FEncodersTable	EncodersTable	Encoder mapping table
FFocalLengthTab...	FocalLengthTable	Focal length table mapping to input focus/zoom
FImageCenterTab...	ImageCenterTable	Image center table mapping to input focus/zoom
FLensInfo	LensInfo	Lens information
FNodalOffsetTab...	NodalOffsetTable	Nodal offset table mapping to input focus/zoom
FSTMapTable	STMapTable	STMap table mapping to input focus/zoom
TArray< UTextur...	UndistortionDisplacementMapHolders	Texture used to store temporary undistortion displacement map when using map blending
TMap< FString, ...	UserMetadata	Metadata user could enter for its lens

Constructors

	Name	Description
	ULensFile()

Functions

	Name	Description
void	AddDistortionPoint ( float NewFocus, float NewZoom, const FDistortionInfo& NewPoint, const FFocalLengthInfo& NewFocalLe... )	Adds a distortion point in our map. If a point already exist at the location, it is updated
void	AddFocalLengthPoint ( float NewFocus, float NewZoom, const FFocalLengthInfo& NewFocalLe... )	Adds a focal length point in our map. If a point already exist at the location, it is updated
void	AddImageCenterPoint ( float NewFocus, float NewZoom, const FImageCenterInfo& NewPoint )	Adds an ImageCenter point in our map. If a point already exist at the location, it is updated
void	AddNodalOffsetPoint ( float NewFocus, float NewZoom, const FNodalPointOffset& NewPoint )	Adds an NodalOffset point in our map. If a point already exist at the location, it is updated
void	AddSTMapPoint ( float NewFocus, float NewZoom, const FSTMapInfo& NewPoint )	Adds an STMap point in our map. If a point already exist at the location, it is updated
void	ClearAll()	Removes all points of all tables
void	ClearData ( ELensDataCategory InDataCategory )	Removes table associated to data category
float	ComputeOverscan ( const FDistortionData& DerivedData, FVector2D PrincipalPoint )	Returns the overscan factor based on distorted UV and image center
bool	EvaluateDistortionData ( float InFocus, float InZoom, FVector2D InFilmback, ULensDistortionModelHandlerBase..., FDistortionData& OutDistortionData )	Draws the distortion map based on evaluation point
bool	EvaluateDistortionForParameters ( float InFocus, float InZoom, FVector2D InFilmback, ULensDistortionModelHandlerBase..., FDistortionData& OutDistortionData )	Evaluates distortion based on InFocus and InZoom using parameters
bool	EvaluateDistortionParameters ( float InFocus, float InZoom, FDistortionInfo& OutEvaluatedValue )	Returns interpolated distortion parameters
bool	EvaluateFocalLength ( float InFocus, float InZoom, FFocalLengthInfo& OutEvaluatedValu... )	Returns interpolated focal length
bool	EvaluateImageCenterParameters ( float InFocus, float InZoom, FImageCenterInfo& OutEvaluatedValu... )	Returns interpolated image center parameters based on input focus and zoom
bool	EvaluateNodalPointOffset ( float InFocus, float InZoom, FNodalPointOffset& OutEvaluatedVal... )	Returns interpolated nodal point offset based on input focus and zoom
float	EvaluateNormalizedFocus ( float InNormalizedValue )	Returns interpolated focus based on input normalized value and mapping
float	EvaluateNormalizedIris ( float InNormalizedValue )	Returns interpolated iris based on input normalized value and mapping
bool	EvaluteDistortionForSTMaps ( float InFocus, float InZoom, FVector2D InFilmback, ULensDistortionModelHandlerBase..., FDistortionData& OutDistortionData )	Evaluates distortion based on InFocus and InZoom using STMaps
bool	HasFocusEncoderMapping()	Whether focus encoder mapping is configured
bool	HasIrisEncoderMapping()	Whether iris encoder mapping is configured
bool	HasSamples ( ELensDataCategory InDataCategory )	Returns whether a category has data samples
bool	IsCineCameraCompatible ( const UCineCameraComponent* Ci... )	Whether the sensor dimensions in the lens file will be compatible with the sensor dimensions of the input CineCameraComponent
void	OnDistortionDerivedDataJobCompleted ( const FDerivedDistortionDataJobOutp... )	Callbacked when stmap derived data has completed
void	RemoveFocusPoint ( ELensDataCategory InDataCategory, float InFocus )	Removes a focus point
void	RemoveZoomPoint ( ELensDataCategory InDataCategory, float InFocus, float InZoom )	Removes a zoom point
void	SetupNoDistortionOutput ( ULensDistortionModelHandlerBase..., FDistortionData& OutDistortionData )	Clears output displacement map on LensHandler to have no distortion and setup distortion data to match that
void	UpdateDerivedData()	Updates derived data entries to make sure it matches what is assigned in map points based on data mode

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.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

		Name	Description
	TStatId	GetStatId()	Return the stat id to use for this tickable
	void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Constants

Name	Description
DisplacementMapHolderCount
InputTolerance	Tolerance used to consider input focus or zoom to be identical
UndistortedUVs	UV coordinates of 8 points (4 corners + 4 mid points)

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

Take our survey

Dismiss