1. Epic GamesDeveloper
  3. UCameraNodalOffsetAlgo

UCameraNodalOffsetAlgo

[UCameraNodalOffsetAlgo](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.

API > API/Plugins > API/Plugins/CameraCalibrationCore

Inheritance Hierarchy

  • UObject
  • UCameraNodalOffsetAlgo

References

   
Module CameraCalibrationCore
Header /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraNodalOffsetAlgo.h
Include #include "CameraNodalOffsetAlgo.h"

Syntax

UCLASS (Abstract)  
class UCameraNodalOffsetAlgo : public UObject

Remarks

UCameraNodalOffsetAlgo defines the interface that any nodal calibration point algorithm should implement in order to be used and listed by the Nodal Offset Tool.

Functions

  Type Name Description
Public function Virtual TSharedRef< SWidget > Called to present the user with instructions on how to use this algo
Public function Virtual TSharedRef< SWidget >

BuildUI ()

 Returns the UI of this calibrator. Expected to only be called once
Public function Virtual Const FName Returns a descriptive name/title for this algorithm
Public function Virtual bool

GetNodalOffset ( FNodalPointOffset& OutNodalOffset,
float& OutFocus,
float& OutZoom,
float& OutError,
FText& OutErrorMessage
)

 Returns the most recently calibrated nodal offset transform, with an error metric
Public function Virtual Const UMaterialInterface * Returns the overlay material used by this algo (if any)
Public function Virtual Const bool Returns true if there is any existing calibration data
Public function Virtual int32

ImportCalibrationRow ( const TSharedRef< FJsonObject >& CalibrationRowObject,
const FImage& RowImage
)

 Import a JsonObject of calibration data that represents a single calibration row.
Public function 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
Public function Virtual void

Initialize ( UNodalOffsetTool* InNodalOffsetTool
)

 Make sure you initialize before using the object
Public function Virtual Const bool Returns true is this algo has enabled an overlay
Public function Virtual void Called when the current offset was saved
Public function Virtual bool

OnViewportClicked ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Callback when viewport is clicked. Returns false if the event was not handled.
Public function Virtual bool

OnViewportInputKey ( const FKey& InKey,
const EInputEvent& InEvent
)

 Callback when viewport receives input key presses. Returns false if the event was not handled.
Public function Virtual void Performs any necessary steps after importing a calibration dataset
Public function Virtual void Performs any necessary steps (such as clearing existing calibration data) before importing a calibration dataset
Public function Virtual Const FName Returns a shorter name for this algorithm
Public function Virtual void Clean up resources and don't use NodalOffsetTool anymore
Public function Virtual void

Tick ( float DeltaTime
)

 Called every frame

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page