Navigation
API > API/Plugins > API/Plugins/CameraCalibrationCore
Defines the interface that any lens distortion algorithm should implement in order to be used and listed by the Lens Distortion Tool.
| Name | UCameraLensDistortionAlgo |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraLensDistortionAlgo.h |
| Include Path | #include "CameraLensDistortionAlgo.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UCameraLensDistortionAlgo : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraLensDistortionAlgo
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDistortionCalibrationTask BeginCalibration
(
FText& OutErrorMessage |
Launches an asynchronous task to perform the distortion calibration. | CameraLensDistortionAlgo.h | |
virtual TSharedRef< SWidget > BuildHelpWidget() |
Called to present the user with instructions on how to use this algo | CameraLensDistortionAlgo.h | |
virtual TSharedRef< SWidget > BuildUI() |
Returns the UI of this calibrator. Expected to only be called once | CameraLensDistortionAlgo.h | |
virtual void CancelCalibration() |
Cancel an in-progress async calibration task | CameraLensDistortionAlgo.h | |
virtual FName FriendlyName() |
Returns a descriptive name/title for this algorithm | CameraLensDistortionAlgo.h | |
virtual bool GetCalibrationStatus
(
FText& StatusText |
Get the latest status from the lens distortion calibration. | CameraLensDistortionAlgo.h | |
virtual bool GetLensDistortion
(
float& OutFocus, |
Returns the lens distortion calibration data | CameraLensDistortionAlgo.h | |
virtual UMaterialInterface * GetOverlayMaterial() |
Returns the overlay material used by this algo (if any) | CameraLensDistortionAlgo.h | |
virtual bool HasCalibrationData() |
Returns true if there is any existing calibration data | CameraLensDistortionAlgo.h | |
virtual int32 ImportCalibrationRow
(
const TSharedRef< FJsonObject >& CalibrationRowObject, |
Import a JsonObject of calibration data that represents a single calibration row. | CameraLensDistortionAlgo.h | |
virtual void ImportSessionData
(
const TSharedRef< FJsonObject >& SessionDataObject |
Import a JsonObject of calibration data that is needed by the algorithm, but is not associated with a single row of data | CameraLensDistortionAlgo.h | |
virtual void Initialize
(
ULensDistortionTool* InTool |
Make sure you initialize before using the object | CameraLensDistortionAlgo.h | |
virtual bool IsOverlayEnabled() |
Returns true is this algo has enabled an overlay | CameraLensDistortionAlgo.h | |
virtual void OnDistortionSavedToLens() |
Called when the data sample was saved to the lens file | CameraLensDistortionAlgo.h | |
virtual bool OnViewportClicked
(
const FGeometry& MyGeometry, |
Callback when viewport is clicked. Returns false if the event was not handled. | CameraLensDistortionAlgo.h | |
virtual void PostImportCalibrationData() |
Performs any necessary steps after importing a calibration dataset | CameraLensDistortionAlgo.h | |
virtual void PreImportCalibrationData() |
Performs any necessary steps (such as clearing existing calibration data) before importing a calibration dataset | CameraLensDistortionAlgo.h | |
virtual FName ShortName() |
Returns a shorter name for this algorithm | CameraLensDistortionAlgo.h | |
virtual void Shutdown() |
Clean up resources | CameraLensDistortionAlgo.h | |
virtual bool SupportsAsyncCalibration () |
If true, the algo must override BeginCalibration() and use it to launch the calibration as an asynchronous task. | CameraLensDistortionAlgo.h | |
virtual bool SupportsModel
(
const TSubclassOf< ULensModel >& LensModel |
Returns true if the algo supports the input Lens Model | CameraLensDistortionAlgo.h | |
virtual void Tick
(
float DeltaTime |
Called every frame | CameraLensDistortionAlgo.h |