Navigation
API > API/Plugins > 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.
| Name | UCameraImageCenterAlgo |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraImageCenterAlgo.h |
| Include Path | #include "CameraImageCenterAlgo.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UCameraImageCenterAlgo : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraImageCenterAlgo
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Activate() |
Perform any required set when this algo becomes the active one | CameraImageCenterAlgo.h | |
virtual TSharedRef< SWidget > BuildHelpWidget() |
Called to present the user with instructions on how to use this algo | CameraImageCenterAlgo.h | |
virtual TSharedRef< SWidget > BuildUI() |
Returns the UI of this calibrator. Expected to only be called once | CameraImageCenterAlgo.h | |
virtual void Deactivate() |
Perform any required cleanup when this algo is no longer active | CameraImageCenterAlgo.h | |
virtual FName FriendlyName() |
Returns a descriptive name/title of this image center algorithm | CameraImageCenterAlgo.h | |
virtual UMaterialInterface * GetOverlayMaterial() |
Returns the overlay material used by this algo (if any) | CameraImageCenterAlgo.h | |
virtual bool HasImageCenterChanged() |
Returns true if the algo has changed the image center for the current focus/zoom | CameraImageCenterAlgo.h | |
virtual void Initialize
(
UImageCenterTool* InImageCenterTool |
Make sure you initialize before using the object | CameraImageCenterAlgo.h | |
virtual bool IsActive() |
Returns true if this algo is active | CameraImageCenterAlgo.h | |
virtual bool IsOverlayEnabled() |
Returns true is this algo has enabled an overlay | CameraImageCenterAlgo.h | |
virtual void OnSavedImageCenter() |
Called when the current offset was saved | CameraImageCenterAlgo.h | |
virtual bool OnViewportClicked
(
const FGeometry& MyGeometry, |
Callback when viewport is clicked. Returns false if the event was not handled. | CameraImageCenterAlgo.h | |
virtual bool OnViewportInputKey
(
const FKey& InKey, |
Callback when viewport receives input key presses. Returns false if the event was not handled. | CameraImageCenterAlgo.h | |
virtual void Shutdown() |
Clean up resources and don't use ImageCenterTool anymore | CameraImageCenterAlgo.h | |
virtual void Tick
(
float DeltaTime |
Called every frame | CameraImageCenterAlgo.h |