1. Epic GamesDeveloper
  3. ULensFile

ULensFile

A Lens file containing calibration mapping from FIZ data

API > API/Plugins > API/Plugins/CameraCalibrationCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class ULensFile :  
    public UObject,  
    public FTickableGameObject

Remarks

A Lens file containing calibration mapping from FIZ data

Variables

  Type Name Description
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< UAssetImportData > AssetImportData Importing data and options used for importing ulens files.
Protected variable TUniquePtr< ICalibratedMapProcessor > CalibratedMapProcessor Processor handling derived data out of calibrated st maps
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FCameraFeedInfo CameraFeedInfo Camera feed information
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ELensDataMode DataMode Type of data used for lens mapping
Protected variable int32 DerivedDataInFlightCount Derived data compute jobs we are waiting on
Protected variable UProperty Transient TArray< TObjectPtr< UTextureRenderTarget2D > > DistortionDisplacementMapHolders Texture used to store temporary distortion displacement map when using map blending
Public variable UProperty FDistortionTable DistortionTable Distortion parameters table mapping to input focus/zoom
Public variable UProperty FEncodersTable EncodersTable Encoder mapping table
Public variable UProperty FFocalLengthTable FocalLengthTable Focal length table mapping to input focus/zoom
Public variable UProperty FImageCenterTable ImageCenterTable Image center table mapping to input focus/zoom
Public variable float InputTolerance Tolerance used to consider input focus or zoom to be identical
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FLensInfo LensInfo Lens information
Public variable UProperty FNodalOffsetTable NodalOffsetTable Nodal offset table mapping to input focus/zoom
Protected variable FOnLensFileModelChanged OnLensFileModelChangedDelegate Delegate that is triggered when the LensModel changes
Public variable UProperty Category BlueprintReadOnly visibleanywhere FSimulcamInfo SimulcamInfo Simulcam information
Public variable UProperty FSTMapTable STMapTable STMap table mapping to input focus/zoom
Protected variable UProperty Transient TArray< TObjectPtr< UTextureRenderTarget2D > > UndistortionDisplacementMapHolders Texture used to store temporary undistortion displacement map when using map blending
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TMap< FString, FString > UserMetadata Metadata user could enter for its lens

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddDistortionPoint ( float NewFocus,
float NewZoom,
const FDistortionInfo& NewPoint,
const FFocalLengthInfo& NewFocalLength
)

 Adds a distortion point in our map. If a point already exist at the location, it is updated
Public function UFunction BlueprintCallable, Category void

AddFocalLengthPoint ( float NewFocus,
float NewZoom,
const FFocalLengthInfo& NewFocalLength
)

 Adds a focal length point in our map. If a point already exist at the location, it is updated
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category void Removes all points of all tables
Public function UFunction BlueprintCallable, Category void

ClearData ( ELensDataCategory InDataCategory
)

 Removes table associated to data category
Protected function Const float

ComputeOverscan ( const FDistortionData& DerivedData,
FVector2D PrincipalPoint
)

 Returns the overscan factor based on distorted UV and image center
Protected function void

CreateIntermediateDisplacementMaps ( const FIntPoint DisplacementMapResolution
)

 Create the intermediate displacement maps needed to do map blending to get final distortion/undistortion maps
Public function Const UFunction BlueprintPure, Category bool

EvaluateDistortionData ( float InFocus,
float InZoom,
FVector2D InFilmback,
ULensDistortionModelHandlerBase* InLensHandler
)

 Draws the distortion map based on evaluation point
Protected function Const bool

EvaluateDistortionForParameters ( float InFocus,
float InZoom,
FVector2D InFilmback,
ULensDistortionModelHandlerBase* LensHandler
)

 Evaluates distortion based on InFocus and InZoom using parameters
Protected function Const bool

EvaluateDistortionForSTMaps ( float InFocus,
float InZoom,
FVector2D InFilmback,
ULensDistortionModelHandlerBase* LensHandler
)

 Evaluates distortion based on InFocus and InZoom using STMaps
Public function Const UFunction BlueprintPure, Category bool

EvaluateDistortionParameters ( float InFocus,
float InZoom,
FDistortionInfo& OutEvaluatedValue
)

 Returns interpolated distortion parameters
Public function Const UFunction BlueprintPure, Category bool

EvaluateFocalLength ( float InFocus,
float InZoom,
FFocalLengthInfo& OutEvaluatedValue
)

 Returns interpolated focal length
Public function Const UFunction BlueprintPure, Category bool

EvaluateImageCenterParameters ( float InFocus,
float InZoom,
FImageCenterInfo& OutEvaluatedValue
)

 Returns interpolated image center parameters based on input focus and zoom
Public function Const UFunction BlueprintPure, Category bool

EvaluateNodalPointOffset ( float InFocus,
float InZoom,
FNodalPointOffset& OutEvaluatedValue
)

 Returns interpolated nodal point offset based on input focus and zoom
Public function Const UFunction BlueprintPure, Category float

EvaluateNormalizedFocus ( float InNormalizedValue
)

 Returns interpolated focus based on input normalized value and mapping
Public function Const UFunction BlueprintPure, Category float

EvaluateNormalizedIris ( float InNormalizedValue
)

 Returns interpolated iris based on input normalized value and mapping
Public function Const const FBaseLensTable *

GetDataTable ( ELensDataCategory InDataCategory
)

 Get data table reference based on given category
Public function Const UFunction BlueprintPure, Category bool

GetDistortionPoint ( float InFocus,
float InZoom,
FDistortionInfo& OutDistortionInfo
)

 Gets a Distortion point by given focus and zoom, if point does not exists returns false
Public function Const UFunction BlueprintPure, Category TArray< FDistortionPointInfo > Gets all Distortion points struct with focus, zoom and info
Public function Const UFunction BlueprintPure, Category bool

GetFocalLengthPoint ( float InFocus,
float InZoom,
FFocalLengthInfo& OutFocalLengthInfo
)

 Gets a Focal Length point by given focus and zoom, if point does not exists returns false
Public function Const UFunction BlueprintPure, Category TArray< FFocalLengthPointInfo > Gets all Focal Length points struct with focus, zoom and info
Public function Const UFunction BlueprintPure, Category bool

GetImageCenterPoint ( float InFocus,
float InZoom,
FImageCenterInfo& OutImageCenterInfo
)

 Gets a Image Center point by given focus and zoom, if point does not exists returns false
Public function Const UFunction BlueprintPure, Category TArray< FImageCenterPointInfo > Gets all Image Center points struct with focus, zoom and info
Public function Const UFunction BlueprintPure, Category bool

GetNodalOffsetPoint ( float InFocus,
float InZoom,
FNodalPointOffset& OutNodalPointOffset
)

 Gets a Nodal Offset point by given focus and zoom, if point does not exists returns false
Public function Const UFunction BlueprintPure, Category TArray< FNodalOffsetPointInfo > Gets all Nodal Offset points struct with focus, zoom and info
Public function Const UFunction BlueprintPure, Category bool

GetSTMapPoint ( float InFocus,
float InZoom,
FSTMapInfo& OutSTMapInfo
)

 Gets a ST Map point by given focus and zoom, if point does not exists returns false
Public function Const UFunction BlueprintPure, Category TArray< FSTMapPointInfo > Gets all ST Map points struct with focus, zoom and info
Public function Const UFunction BlueprintPure, Category int32

GetTotalPointNum ( ELensDataCategory InDataCategory
)

 Returns total number of the points for given category
Public function Const UFunction BlueprintPure, Category bool Whether focus encoder mapping is configured
Public function Const UFunction BlueprintPure, Category bool Whether iris encoder mapping is configured
Public function Const UFunction BlueprintPure, Category bool

HasSamples ( ELensDataCategory InDataCategory
)

 Returns whether a category has data samples
Public function void

OnDistortionDerivedDataJobCompleted ( const FDerivedDistortionDataJobOutput& JobOutput
)

 Callbacked when stmap derived data has completed
Public function FOnLensFileModelChanged & Returns the delegate that is triggered when the LensModel changes
Public function UFunction BlueprintCallable, Category void

RemoveFocusPoint ( ELensDataCategory InDataCategory,
float InFocus
)

 Removes a focus point
Public function UFunction BlueprintCallable, Category void

RemoveZoomPoint ( ELensDataCategory InDataCategory,
float InFocus,
float InZoom
)

 Removes a zoom point
Protected function Const void Clears output displacement map on LensHandler to have no distortion and setup distortion data to match that
Protected function void Updates derived data entries to make sure it matches what is assigned in map points based on data mode
Public function void

UpdateDisplacementMapResolution ( const FIntPoint NewDisplacementMapResolution
)

 Update the resolution used for intermediate blending displacement maps and for STMap derived data
Public function void

UpdateInputTolerance ( const float NewTolerance
)

 Update the input tolerance used when adding points to calibration tables

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Constants

Name Description
DisplacementMapHolderCount The number of intermediate displacement maps needed to do map blending
UndistortedUVs UV coordinates of 8 points (4 corners + 4 mid points)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page