Navigation
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
- FTickableObjectBase → FTickableGameObject → ULensFile
- UObjectBase → UObjectBaseUtility → UObject → ULensFile
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 |
|
| CameraFeedInfo | FCameraFeedInfo | Camera feed information | LensFile.h |
|
| DataMode | ELensDataMode | Type of data used for lens mapping | LensFile.h |
|
| 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 |
|
| NodalOffsetTable | FNodalOffsetTable | Nodal offset table mapping to input focus/zoom | LensFile.h | |
| SimulcamInfo | FSimulcamInfo | Simulcam information | LensFile.h |
|
| STMapTable | FSTMapTable | STMap table mapping to input focus/zoom | LensFile.h | |
| UserMetadata | TMap< FString, FString > | Metadata user could enter for its lens | LensFile.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddDistortionPoint
(
float NewFocus, |
Adds a distortion point in our map. If a point already exist at the location, it is updated | LensFile.h |
|
void AddFocalLengthPoint
(
float NewFocus, |
Adds a focal length point in our map. If a point already exist at the location, it is updated | LensFile.h |
|
void AddImageCenterPoint
(
float NewFocus, |
Adds an ImageCenter point in our map. If a point already exist at the location, it is updated | LensFile.h |
|
void AddNodalOffsetPoint
(
float NewFocus, |
Adds an NodalOffset point in our map. If a point already exist at the location, it is updated | LensFile.h |
|
void AddSTMapPoint
(
float NewFocus, |
Adds an STMap point in our map. If a point already exist at the location, it is updated | LensFile.h |
|
void ChangeFocusPoint
(
ELensDataCategory InDataCategory, |
Changes the value of a focus point | LensFile.h |
|
void ChangeZoomPoint
(
ELensDataCategory InDataCategory, |
Changes the value of a zoom point | LensFile.h |
|
void ClearAll() |
Removes all points of all tables | LensFile.h |
|
void ClearData
(
ELensDataCategory InDataCategory |
Removes table associated to data category | LensFile.h |
|
bool EvaluateDistortionData
(
float InFocus, |
Draws the distortion map based on evaluation point | LensFile.h |
|
bool EvaluateDistortionParameters
(
float InFocus, |
Returns interpolated distortion parameters | LensFile.h |
|
bool EvaluateFocalLength
(
float InFocus, |
Returns interpolated focal length | LensFile.h |
|
bool EvaluateImageCenterParameters
(
float InFocus, |
Returns interpolated image center parameters based on input focus and zoom | LensFile.h |
|
bool EvaluateNodalPointOffset
(
float InFocus, |
Returns interpolated nodal point offset based on input focus and zoom | LensFile.h |
|
float EvaluateNormalizedFocus
(
float InNormalizedValue |
Returns interpolated focus based on input normalized value and mapping | LensFile.h |
|
float EvaluateNormalizedIris
(
float InNormalizedValue |
Returns interpolated iris based on input normalized value and mapping | LensFile.h |
|
void GetBlendState
(
float InFocus, |
Returns the distortion state and blend paramters for input focus and zoom | LensFile.h | |
const FBaseLensTable * GetDataTable
(
ELensDataCategory InDataCategory |
Get data table reference based on given category | LensFile.h | |
FBaseLensTable * GetDataTable
(
ELensDataCategory InDataCategory |
Get data table reference based on given category | LensFile.h | |
bool GetDistortionPoint
(
float InFocus, |
Gets a Distortion point by given focus and zoom, if point does not exists returns false | LensFile.h |
|
TArray< FDistortionPointInfo > GetDistortionPoints() |
Gets all Distortion points struct with focus, zoom and info | LensFile.h |
|
bool GetFocalLengthPoint
(
float InFocus, |
Gets a Focal Length point by given focus and zoom, if point does not exists returns false | LensFile.h |
|
TArray< FFocalLengthPointInfo > GetFocalLengthPoints() |
Gets all Focal Length points struct with focus, zoom and info | LensFile.h |
|
bool GetImageCenterPoint
(
float InFocus, |
Gets a Image Center point by given focus and zoom, if point does not exists returns false | LensFile.h |
|
TArray< FImageCenterPointInfo > GetImageCenterPoints() |
Gets all Image Center points struct with focus, zoom and info | LensFile.h |
|
bool GetNodalOffsetPoint
(
float InFocus, |
Gets a Nodal Offset point by given focus and zoom, if point does not exists returns false | LensFile.h |
|
TArray< FNodalOffsetPointInfo > GetNodalOffsetPoints() |
Gets all Nodal Offset points struct with focus, zoom and info | LensFile.h |
|
bool GetSTMapPoint
(
float InFocus, |
Gets a ST Map point by given focus and zoom, if point does not exists returns false | LensFile.h |
|
TArray< FSTMapPointInfo > GetSTMapPoints() |
Gets all ST Map points struct with focus, zoom and info | LensFile.h |
|
int32 GetTotalPointNum
(
ELensDataCategory InDataCategory |
Returns total number of the points for given category | LensFile.h |
|
bool HasFocusEncoderMapping() |
Whether focus encoder mapping is configured | LensFile.h |
|
bool HasFocusPoint
(
ELensDataCategory InDataCategory, |
Checks to see if there is a focal point for the specified focus in the data category | LensFile.h |
|
bool HasIrisEncoderMapping() |
Whether iris encoder mapping is configured | LensFile.h |
|
bool HasSamples
(
ELensDataCategory InDataCategory |
Returns whether a category has data samples | LensFile.h |
|
bool HasZoomPoint
(
ELensDataCategory InDataCategory, |
Removes a zoom point | LensFile.h |
|
void MergeFocusPoint
(
ELensDataCategory InDataCategory, |
Merges the contents of one focus point into another focus point | LensFile.h |
|
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, |
Removes a focus point | LensFile.h |
|
void RemoveZoomPoint
(
ELensDataCategory InDataCategory, |
Removes a zoom point | LensFile.h |
|
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, |
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, |
Evaluates distortion based on InFocus and InZoom using parameters | LensFile.h | |
bool EvaluateDistortionForSTMaps
(
float InFocus, |
Evaluates distortion based on InFocus and InZoom using STMaps | LensFile.h | |
void SetupNoDistortionOutput
(
ULensDistortionModelHandlerBase* LensHandler |
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 |