1. Epic GamesDeveloper
  3. ULensFile

ULensFile

A Lens file containing calibration mapping from FIZ data

API > API/Plugins > API/Plugins/CameraCalibrationCore

A Lens file containing calibration mapping from FIZ data

   
Name ULensFile
Type class
Header File /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/LensFile.h
Include Path #include "LensFile.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class ULensFile :  
    public UObject ,  
    public FTickableGameObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ULensFile()

   LensFile.h  

Constants

Name Type Remarks Include Path
DisplacementMapHolderCount int32 The number of intermediate displacement maps needed to do map blending LensFile.h
UndistortedUVs const TArray< FVector2D > UV coordinates of 8 points (4 corners + 4 mid points) LensFile.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetImportData TObjectPtr< UAssetImportData > Importing data and options used for importing ulens files. LensFile.h
  • VisibleAnywhere
  • Instanced
  • Category="ImportSettings"
CameraFeedInfo FCameraFeedInfo Camera feed information LensFile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Feed"
DataMode ELensDataMode Type of data used for lens mapping LensFile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lens mapping"
DistortionTable FDistortionTable Distortion parameters table mapping to input focus/zoom LensFile.h  
EncodersTable FEncodersTable Encoder mapping table LensFile.h  
FocalLengthTable FFocalLengthTable Focal length table mapping to input focus/zoom LensFile.h  
ImageCenterTable FImageCenterTable Image center table mapping to input focus/zoom LensFile.h  
InputTolerance float Tolerance used to consider input focus or zoom to be identical LensFile.h  
LensInfo FLensInfo Lens information LensFile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Lens info"
NodalOffsetTable FNodalOffsetTable Nodal offset table mapping to input focus/zoom LensFile.h  
SimulcamInfo FSimulcamInfo Simulcam information LensFile.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Simulcam info"
STMapTable FSTMapTable STMap table mapping to input focus/zoom LensFile.h  
UserMetadata TMap< FString, FString > Metadata user could enter for its lens LensFile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Metadata"

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

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 LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

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 LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

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 LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

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 LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void ChangeFocusPoint ( ELensDataCategory InDataCategory,
float InExistingFocus,
float InNewFocus
)

 Changes the value of a focus point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void ChangeZoomPoint ( ELensDataCategory InDataCategory,
float InFocus,
float InExistingZoom,
float InNewZoom
)

 Changes the value of a zoom point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void ClearAll()

 Removes all points of all tables LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void ClearData ( ELensDataCategory InDataCategory
)

 Removes table associated to data category LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

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

 Draws the distortion map based on evaluation point LensFile.h
  • BlueprintPure
  • Category="Utility"

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

 Returns interpolated distortion parameters LensFile.h
  • BlueprintPure
  • Category="Utility"

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

 Returns interpolated focal length LensFile.h
  • BlueprintPure
  • Category="Utility"

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

 Returns interpolated image center parameters based on input focus and zoom LensFile.h
  • BlueprintPure
  • Category="Utility"

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

 Returns interpolated nodal point offset based on input focus and zoom LensFile.h
  • BlueprintPure
  • Category="Utility"

float EvaluateNormalizedFocus ( float InNormalizedValue
) const

 Returns interpolated focus based on input normalized value and mapping LensFile.h
  • BlueprintPure
  • Category="Utility"

float EvaluateNormalizedIris ( float InNormalizedValue
) const

 Returns interpolated iris based on input normalized value and mapping LensFile.h
  • BlueprintPure
  • Category="Utility"

void GetBlendState ( float InFocus,
float InZoom,
FVector2D InFilmback,
FDisplacementMapBlendingParams& OutBlendState
)

 Returns the distortion state and blend paramters for input focus and zoom LensFile.h  

const FBaseLensTable * GetDataTable ( ELensDataCategory InDataCategory
) const

 Get data table reference based on given category LensFile.h  
Get data table reference based on given category LensFile.h  

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

 Gets a Distortion point by given focus and zoom, if point does not exists returns false LensFile.h
  • BlueprintPure
  • Category="Lens Table"

TArray< FDistortionPointInfo > GetDistortionPoints()

 Gets all Distortion points struct with focus, zoom and info LensFile.h
  • BlueprintPure
  • Category="Lens Table"

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

 Gets a Focal Length point by given focus and zoom, if point does not exists returns false LensFile.h
  • BlueprintPure
  • Category="Lens Table"

TArray< FFocalLengthPointInfo > GetFocalLengthPoints()

 Gets all Focal Length points struct with focus, zoom and info LensFile.h
  • BlueprintPure
  • Category="Lens Table"

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

 Gets a Image Center point by given focus and zoom, if point does not exists returns false LensFile.h
  • BlueprintPure
  • Category="Lens Table"

TArray< FImageCenterPointInfo > GetImageCenterPoints()

 Gets all Image Center points struct with focus, zoom and info LensFile.h
  • BlueprintPure
  • Category="Lens Table"

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

 Gets a Nodal Offset point by given focus and zoom, if point does not exists returns false LensFile.h
  • BlueprintPure
  • Category="Lens Table"

TArray< FNodalOffsetPointInfo > GetNodalOffsetPoints()

 Gets all Nodal Offset points struct with focus, zoom and info LensFile.h
  • BlueprintPure
  • Category="Lens Table"

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

 Gets a ST Map point by given focus and zoom, if point does not exists returns false LensFile.h
  • BlueprintPure
  • Category="Lens Table"

TArray< FSTMapPointInfo > GetSTMapPoints()

 Gets all ST Map points struct with focus, zoom and info LensFile.h
  • BlueprintPure
  • Category="Lens Table"

int32 GetTotalPointNum ( ELensDataCategory InDataCategory
) const

 Returns total number of the points for given category LensFile.h
  • BlueprintPure
  • Category="Lens Table"

bool HasFocusEncoderMapping()

 Whether focus encoder mapping is configured LensFile.h
  • BlueprintPure
  • Category="Lens Table"

bool HasFocusPoint ( ELensDataCategory InDataCategory,
float InFocus
) const

 Checks to see if there is a focal point for the specified focus in the data category LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

bool HasIrisEncoderMapping()

 Whether iris encoder mapping is configured LensFile.h
  • BlueprintPure
  • Category="Lens Table"

bool HasSamples ( ELensDataCategory InDataCategory
) const

 Returns whether a category has data samples LensFile.h
  • BlueprintPure
  • Category="Lens Table"

bool HasZoomPoint ( ELensDataCategory InDataCategory,
float InFocus,
float InZoom
)

 Removes a zoom point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void MergeFocusPoint ( ELensDataCategory InDataCategory,
float InSrcFocus,
float InDestFocus,
bool bReplaceExistingZoomPoints
)

 Merges the contents of one focus point into another focus point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void OnDistortionDerivedDataJobCompleted ( const FDerivedDistortionDataJobOutput& JobOutput
)

 Callbacked when stmap derived data has completed LensFile.h  

FOnLensFileModelChanged & OnLensFileModelChanged()

 Returns the delegate that is triggered when the LensModel changes LensFile.h  

void RemoveFocusPoint ( ELensDataCategory InDataCategory,
float InFocus
)

 Removes a focus point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void RemoveZoomPoint ( ELensDataCategory InDataCategory,
float InFocus,
float InZoom
)

 Removes a zoom point LensFile.h
  • BlueprintCallable
  • Category="Lens Table"

void UpdateDisplacementMapResolution ( const FIntPoint NewDisplacementMapResolution
)

 Update the resolution used for intermediate blending displacement maps and for STMap derived data LensFile.h  

void UpdateInputTolerance ( const float NewTolerance
)

 Update the input tolerance used when adding points to calibration tables LensFile.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   LensFile.h  

virtual void PostInitProperties()

   LensFile.h  

virtual void Serialize ( FArchive& Ar
)

   LensFile.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   LensFile.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   LensFile.h  

virtual void Tick ( float DeltaTime
)

   LensFile.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BuildLensTableFocusCurves()

 Builds the lens table focus curves to match the existing data in the tables LensFile.h  

float ComputeOverscan ( const FDistortionData& DerivedData,
FVector2D PrincipalPoint
) const

 Returns the overscan factor based on distorted UV and image center LensFile.h  

void CreateIntermediateDisplacementMaps ( const FIntPoint DisplacementMapResolution
)

 Create the intermediate displacement maps needed to do map blending to get final distortion/undistortion maps LensFile.h  

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

 Evaluates distortion based on InFocus and InZoom using parameters LensFile.h  

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

 Evaluates distortion based on InFocus and InZoom using STMaps LensFile.h  

void SetupNoDistortionOutput ( ULensDistortionModelHandlerBase* LensHandler
) const

 Clears output displacement map on LensHandler to have no distortion and setup distortion data to match that LensFile.h  

void UpdateDerivedData()

 Updates derived data entries to make sure it matches what is assigned in map points based on data mode LensFile.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page