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.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraNodalOffsetAlgo

References

Module

CameraCalibrationCore

Header

/Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraNodalOffsetAlgo.h

Include

#include "CameraNodalOffsetAlgo.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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

Name Description

Public function Virtual

TSharedRef< ...

 

BuildUI()

Returns the UI of this calibrator. Expected to only be called once

Public function Virtual Const

FName

 

FriendlyName()

Returns a descriptive name/title of this nodal offset 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

void

 

Initialize

(
    UNodalOffsetTool* InNodalOffse...
)

Make sure you initialize before using the object

Public function Virtual

void

 

OnSavedNodalOffset()

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

void

 

Shutdown()

Clean up resources and don't use NodalOffsetTool anymore

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Called every frame
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss