Navigation
API > API/Plugins > API/Plugins/CameraCalibrationCore
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&40;Abstract&41;
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
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bIsActive | Whether this algo is current active or not |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | Activate () |
Perform any required set when this algo becomes the active one |
  |
TSharedRef< SWidget > | Called to present the user with instructions on how to use this algo | |
  |
TSharedRef< SWidget > | BuildUI () |
Returns the UI of this calibrator. Expected to only be called once |
  |
void | Deactivate () |
Perform any required cleanup when this algo is no longer active |
   |
FName | FriendlyName () |
Returns a descriptive name/title of this image center algorithm |
   |
UMaterialInterface * | Returns the overlay material used by this algo (if any) | |
  |
bool | Returns true if the algo has changed the image center for the current focus/zoom | |
  |
void | Initialize
(
UImageCenterTool* InImageCenterTool |
Make sure you initialize before using the object |
   |
bool | IsActive () |
Returns true if this algo is active |
   |
bool | Returns true is this algo has enabled an overlay | |
  |
void | Called when the current offset was saved | |
  |
bool | OnViewportClicked
(
const FGeometry& MyGeometry, |
Callback when viewport is clicked. Returns false if the event was not handled. |
  |
bool | OnViewportInputKey
(
const FKey& InKey, |
Callback when viewport receives input key presses. Returns false if the event was not handled. |
  |
void | Shutdown () |
Clean up resources and don't use ImageCenterTool anymore |
  |
void | Tick
(
float DeltaTime |
Called every frame |