Navigation
API > API/Plugins > API/Plugins/CameraCalibrationCore
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCameraLensDistortionAlgo
References
| Module | CameraCalibrationCore |
| Header | /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraLensDistortionAlgo.h |
| Include | #include "CameraLensDistortionAlgo.h" |
Syntax
UCLASS&40;Abstract&41;
class UCameraLensDistortionAlgo : public UObject
Remarks
Defines the interface that any lens distortion algorithm should implement in order to be used and listed by the Lens Distortion Tool.
Functions
| Type | Name | Description | |
|---|---|---|---|
| TSharedRef< SWidget > | Called to present the user with instructions on how to use this algo | ||
| TSharedRef< SWidget > | BuildUI () |
Returns the UI of this calibrator. Expected to only be called once | |
| FName | FriendlyName () |
Returns a descriptive name/title for this algorithm | |
| bool | GetLensDistortion
(
float& OutFocus, |
Returns the lens distortion calibration data | |
| UMaterialInterface * | Returns the overlay material used by this algo (if any) | ||
| bool | Returns true if there is any existing calibration data | ||
| int32 | ImportCalibrationRow
(
const TSharedRef< FJsonObject >& CalibrationRowObject, |
Import a JsonObject of calibration data that represents a single calibration row. | |
| 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 | |
| void | Initialize
(
ULensDistortionTool* InTool |
Make sure you initialize before using the object | |
| bool | Returns true is this algo has enabled an overlay | ||
| void | Called when the data sample was saved to the lens file | ||
| bool | OnViewportClicked
(
const FGeometry& MyGeometry, |
Callback when viewport is clicked. Returns false if the event was not handled. | |
| void | Performs any necessary steps after importing a calibration dataset | ||
| void | Performs any necessary steps (such as clearing existing calibration data) before importing a calibration dataset | ||
| FName | ShortName () |
Returns a shorter name for this algorithm | |
| void | Shutdown () |
Clean up resources | |
| bool | SupportsModel
(
const TSubclassOf< ULensModel >& LensModel |
Returns true if the algo supports the input Lens Model | |
| void | Tick
(
float DeltaTime |
Called every frame |