UCameraCalibrationStep

Interface of a camera calibration step. These will appear in a Camera Calibration Toolkit tab.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCameraCalibrationStep

References

Module

CameraCalibrationCore

Header

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

Include

#include "CameraCalibrationStep.h"

Syntax

UCLASS(Abstract)
class UCameraCalibrationStep : public UObject

Remarks

Interface of a camera calibration step. These will appear in a Camera Calibration Toolkit tab.

Functions

Name Description

Public function Virtual

void

 

Activate()

Called when this step is the active step in the UI

Public function Virtual

TSharedRef< ...

 

BuildUI()

Returns the UI of this camera calibration step. Expected to only be called once

Public function Virtual

void

 

Deactivate()

Called when this step is no longer the active step in the UI

Public function Virtual Const

bool

 

DependsOnStep

(
    UCameraCalibrationStep* Step
)

Returns true if the given calibration step is a known prerequisite for this step

Public function Virtual Const

FName

 

FriendlyName()

Returns a title or friendly name that can be placed in UI

Public function Virtual Const

FCameraCalib...

 

GetCameraCalibrationStepsController()

Returns the parent camera calibration steps controller

Public function Virtual Const

UMaterialIns...

 

GetOverlayMID()

Returns the overlay MID used by this step

Public function Virtual

void

 

Initialize

(
    TWeakPtr< FCameraCalibrationStepsCo...
)

Make sure you initialize before using the object

Public function Virtual Const

bool

 

IsActive()

Returns true if the step is active

Public function Virtual Const

bool

 

IsOverlayEnabled()

Returns true if this step has enabled its overlay

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 key is pressed while viewport is focused. Returns false if the event was not handled.

Public function Virtual

void

 

Shutdown()

Clean up resources and don't use CameraCalibrationStepController anymore

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Called every frame