UCameraCalibrationSubsystem

Camera Calibration subsystem

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CameraCalibrationCore

Header

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

Include

#include "CameraCalibrationSubsystem.h"

Syntax

UCLASS()
class UCameraCalibrationSubsystem : public UEngineSubsystem

Remarks

Camera Calibration subsystem

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

ULensDistort...

 

FindDistortionModelHandler

(
    FDistortionHandlerPicker& Distorti...,
    bool bUpdatePicker
)

Return the handler associated with the input distortion source, if one exists If bUpdatePicker is true, the input picker reference will be updated so that its properties match those of the found handler

Public function UFunction BlueprintCallable, Category

ULensDistort...

 

FindOrCreateDistortionModelHandler

(
    FDistortionHandlerPicker& Distorti...,
    const TSubclassOf< ULensModel > Len...
)

Return the handler associated with the input distortion source, if one exists that also matches the input model.

Public function Const UFunction BlueprintCallable, Category

TSubclassOf<...

 

GetCameraCalibrationStep

(
    FName Name
)

Returns the camera calibration step by name

Public function Const UFunction BlueprintCallable, Category

TArray< FNam...

 

GetCameraCalibrationSteps()

Returns an array with the names of the available camera calibration steps

Public function Const UFunction BlueprintCallable, Category

TSubclassOf<...

 

GetCameraImageCenterAlgo

(
    FName Name
)

Returns the image center algorithm by name

Public function Const UFunction BlueprintCallable, Category

TArray< FNam...

 

GetCameraImageCenterAlgos()

Returns an array with the names of the available image center algorithms

Public function Const UFunction BlueprintCallable, Category

TSubclassOf<...

 

GetCameraNodalOffsetAlgo

(
    FName Name
)

Returns the nodal offset algorithm by name

Public function Const UFunction BlueprintCallable, Category

TArray< FNam...

 

GetCameraNodalOffsetAlgos()

Returns an array with the names of the available nodal offset algorithms

Public function Const UFunction BlueprintCallable, Category

ULensFile &#...

 

GetDefaultLensFile()

Get the default lens file.

Public function UFunction BlueprintCallable, Category

TArray< ULen...

 

GetDistortionModelHandlers

(
    UCineCameraComponent* Componen...
)

Return all handlers associated with the input camera component

Public function Const UFunction BlueprintCallable, Category

ULensFile &#...

 

GetLensFile

(
    const FLensFilePicker& Picker
)

Facilitator around the picker to get the desired lens file.

Public function

bool

 

GetOriginalFocalLength

(
    UCineCameraComponent* Componen...,
    float& OutFocalLength
)

Get the original focal length of the input camera component, if it exists in the subsystems map.

Public function Const UFunction BlueprintCallable, Category

UMaterialInt...

 

GetOverlayMaterial

(
    const FName& OverlayName
)

Returns the overlay material associated with the input overlay name

Public function Const UFunction BlueprintCallable, Category

TArray< FNam...

 

GetOverlayMaterialNames()

Returns a list of all overlays known to the subsystem This includes the default overlays listed in the camera calibration settings as well as any of overlays that have been registered with this subsystem

Public function Const UFunction BlueprintCallable, Category

TSubclassOf<...

 

GetRegisteredLensModel

(
    FName ModelName
)

Return the ULensModel subclass that was registered with the input model name

Public function

void

 

RegisterDistortionModel

(
    TSubclassOf< ULensModel > LensModel
)

Add a new Lens Model to the registered model map

Public function

void

 

RegisterOverlayMaterial

(
    const FName& MaterialName,
    const FName& MaterialPath
)

Register a new overlay material name and path that can be queried from camera calibration tools

Public function UFunction BlueprintCallable, Category

void

 

SetDefaultLensFile

(
    ULensFile* NewDefaultLensFile
)

Get the default lens file.

Public function

void

 

UnregisterDistortionModel

(
    TSubclassOf< ULensModel > LensModel
)

Remove a Lens Model from the registered model map

Public function UFunction BlueprintCallable, Category

void

 

UnregisterDistortionModelHandler

(
    UCineCameraComponent* Componen...,
    ULensDistortionModelHandlerBase...
)

Disassociate the input handler from the input camera component in the subsystem's handler map

Public function

void

 

UnregisterOverlayMaterial

(
    const FName& MaterialName
)

Unregister an overlay material

Public function

void

 

UpdateOriginalFocalLength

(
    UCineCameraComponent* Componen...,
    float InFocalLength
)

Update the original focal length of the input camera componet

Public function

void

 

UpdateOverscanFocalLength

(
    UCineCameraComponent* Componen...,
    float InFocalLength
)

Update the overscanned focal length of the input camera component

Overridden from USubsystem

Name Description

Public function Virtual

void

 

Deinitialize()

Implement this for deinitialization of instances of the system

Public function Virtual

void

 

Initialize

(
    FSubsystemCollectionBase& Collecti...
)

Implement this for initialization of instances of the system