UCameraImageCenterAlgo

[UCameraImageCenterAlgo](API\Plugins\CameraCalibrationCore\UCameraImageCenterAlgo) defines the interface that any image center algorithm should implement in order to be used and listed by the Image Center Tool.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraImageCenterAlgo

References

Module

CameraCalibrationCore

Header

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

Include

#include "CameraImageCenterAlgo.h"

Syntax

UCLASS(Abstract)
class UCameraImageCenterAlgo : public UObject

Remarks

UCameraImageCenterAlgo defines the interface that any image center algorithm should implement in order to be used and listed by the Image Center Tool.

Variables

Name Description

Protected variable

bool

 

bIsActive

Whether this algo is current active or not

Functions

Name Description

Public function Virtual

void

 

Activate()

Perform any required set when this algo becomes the active one

Public function Virtual

TSharedRef< ...

 

BuildHelpWidget()

Called to present the user with instructions on how to use this algo

Public function Virtual

TSharedRef< ...

 

BuildUI()

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

Public function Virtual

void

 

Deactivate()

Perform any required cleanup when this algo is no longer active

Public function Virtual Const

FName

 

FriendlyName()

Returns a descriptive name/title of this image center algorithm

Public function Virtual Const

UMaterialInt...

 

GetOverlayMaterial()

Returns the overlay material used by this algo (if any)

Public function Virtual

bool

 

HasImageCenterChanged()

Returns true if the algo has changed the image center for the current focus/zoom

Public function Virtual

void

 

Initialize

(
    UImageCenterTool* InImageCente...
)

Make sure you initialize before using the object

Public function Virtual Const

bool

 

IsActive()

Returns true if this algo is active

Public function Virtual Const

bool

 

IsOverlayEnabled()

Returns true is this algo has enabled an overlay

Public function Virtual

void

 

OnSavedImageCenter()

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

 

Shutdown()

Clean up resources and don't use ImageCenterTool anymore

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Called every frame