Navigation
API > API/Plugins > API/Plugins/CameraCalibrationCore
UCameraNodalOffsetAlgo defines the interface that any nodal calibration point algorithm should implement in order to be used and listed by the Nodal Offset Tool.
| Name | UCameraNodalOffsetAlgo |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraNodalOffsetAlgo.h |
| Include Path | #include "CameraNodalOffsetAlgo.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UCameraNodalOffsetAlgo : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraNodalOffsetAlgo
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > BuildHelpWidget() |
Called to present the user with instructions on how to use this algo | CameraNodalOffsetAlgo.h | |
virtual TSharedRef< SWidget > BuildUI() |
Returns the UI of this calibrator. Expected to only be called once | CameraNodalOffsetAlgo.h | |
virtual FName FriendlyName() |
Returns a descriptive name/title for this algorithm | CameraNodalOffsetAlgo.h | |
virtual bool GetNodalOffset
(
FNodalPointOffset& OutNodalOffset, |
Returns the most recently calibrated nodal offset transform, with an error metric | CameraNodalOffsetAlgo.h | |
virtual UMaterialInterface * GetOverlayMaterial() |
Returns the overlay material used by this algo (if any) | CameraNodalOffsetAlgo.h | |
virtual bool HasCalibrationData() |
Returns true if there is any existing calibration data | CameraNodalOffsetAlgo.h | |
virtual int32 ImportCalibrationRow
(
const TSharedRef< FJsonObject >& CalibrationRowObject, |
Import a JsonObject of calibration data that represents a single calibration row. | CameraNodalOffsetAlgo.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 | CameraNodalOffsetAlgo.h | |
virtual void Initialize
(
UNodalOffsetTool* InNodalOffsetTool |
Make sure you initialize before using the object | CameraNodalOffsetAlgo.h | |
virtual bool IsOverlayEnabled() |
Returns true is this algo has enabled an overlay | CameraNodalOffsetAlgo.h | |
virtual void OnSavedNodalOffset() |
Called when the current offset was saved | CameraNodalOffsetAlgo.h | |
virtual bool OnViewportClicked
(
const FGeometry& MyGeometry, |
Callback when viewport is clicked. Returns false if the event was not handled. | CameraNodalOffsetAlgo.h | |
virtual bool OnViewportInputKey
(
const FKey& InKey, |
Callback when viewport receives input key presses. Returns false if the event was not handled. | CameraNodalOffsetAlgo.h | |
virtual void PostImportCalibrationData() |
Performs any necessary steps after importing a calibration dataset | CameraNodalOffsetAlgo.h | |
virtual void PreImportCalibrationData() |
Performs any necessary steps (such as clearing existing calibration data) before importing a calibration dataset | CameraNodalOffsetAlgo.h | |
virtual FName ShortName() |
Returns a shorter name for this algorithm | CameraNodalOffsetAlgo.h | |
virtual void Shutdown() |
Clean up resources and don't use NodalOffsetTool anymore | CameraNodalOffsetAlgo.h | |
virtual void Tick
(
float DeltaTime |
Called every frame | CameraNodalOffsetAlgo.h |