1. Epic GamesDeveloper
  3. UCameraCalibrationSettings

UCameraCalibrationSettings

Settings for the CameraCalibration plugin modules.

API > API/Plugins > API/Plugins/CameraCalibrationCore

Settings for the CameraCalibration plugin modules.

   
Name UCameraCalibrationSettings
Type class
Header File /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/CameraCalibrationSettings.h
Include Path #include "CameraCalibrationSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Game)  
class UCameraCalibrationSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCameraCalibrationSettings()

   CameraCalibrationSettings.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnableCalibrationDatasetImportExport bool Setting to toggle the calibration dataset import and export features CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Settings"
CalibrationInputTolerance float Tolerance to use when adding or accessing data in a calibrated LensFile CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Settings"
CalibrationOverlayMaterialOverrides TMap< FName, TSoftObjectPtr< UMaterialInterface > > Map of overlay names to override overlay materials CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Overlays"
CheckerboardDetectionTimeout float Length of time (in seconds) the calibration tool will wait when attempting to detect a checkerboard pattern in the media image CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Settings"
DefaultDistortionDisplacementMaterials TMap< TSubclassOf< ULensDistortionModelHandlerBase >, TSoftObjectPtr< UMaterialInterface > > Map of Lens Distortion Model Handler classes to the default displacement map material used by that class CameraCalibrationSettings.h
  • Config
DefaultDistortionMaterials TMap< TSubclassOf< ULensDistortionModelHandlerBase >, TSoftObjectPtr< UMaterialInterface > > Map of Lens Distortion Model Handler classes to the default lens distortion post-process material used by that class CameraCalibrationSettings.h
  • Config
DefaultUndistortionDisplacementMaterials TMap< TSubclassOf< ULensDistortionModelHandlerBase >, TSoftObjectPtr< UMaterialInterface > > Map of Lens Distortion Model Handler classes to the default displacement map material used by that class CameraCalibrationSettings.h
  • Config
DisplacementMapResolution FIntPoint Resolution used when creating new distortion and undistortion displacement maps CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Settings"
PostEngineInitHandle FDelegateHandle Delegate handle to run after the engine is initialized CameraCalibrationSettings.h  
StartupLensFile TSoftObjectPtr< ULensFile > Startup lens file for the project Can be overriden. CameraCalibrationSettings.h
  • Config
  • EditAnywhere
  • Category="Settings"
  • Meta=(ConfigRestartRequired=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetCalibrationInputTolerance()

 Get the tolerance to use when adding or accessing data in a calibrated LensFile CameraCalibrationSettings.h  

UMaterialInterface * GetCalibrationOverlayMaterialOverride ( const FName OverlayName
) const

 Get the override MaterialInterface associated with the input overlay name CameraCalibrationSettings.h  

TArray< FName > GetCalibrationOverlayMaterialOverrideNames()

 Get the list of calibration overlay override names CameraCalibrationSettings.h  

float GetCheckerboardDetectionTimeout()

 Get the length of time (in seconds) the calibration tool will wait when attempting to detect a checkerboard pattern in the media image CameraCalibrationSettings.h  

UMaterialInterface * GetDefaultDistortionDisplacementMaterial ( const TSubclassOf< ULensDistortionModelHandlerBase >& InModelHandler
) const

 Get the default MaterialInterface used by the input Model Handler class to write the distortion displacement map CameraCalibrationSettings.h  

UMaterialInterface * GetDefaultDistortionMaterial ( const TSubclassOf< ULensDistortionModelHandlerBase >& InModelHandler
) const

 Get the default MaterialInterface used by the input Model Handler class to apply the post-process lens distortion effect CameraCalibrationSettings.h  

UMaterialInterface * GetDefaultUndistortionDisplacementMaterial ( const TSubclassOf< ULensDistortionModelHandlerBase >& InModelHandler
) const

 Get the default MaterialInterface used by the input Model Handler class to write the undistortion displacement map CameraCalibrationSettings.h  

FIntPoint GetDisplacementMapResolution()

 Get the resolution that should be used for distortion and undistortion displacement maps CameraCalibrationSettings.h  

ULensFile * GetStartupLensFile()

 Get the default startup lens file. CameraCalibrationSettings.h  

bool IsCalibrationDatasetImportExportEnabled()

 Returns true if the calibration dataset import and export featuers are enabled, false otherwise CameraCalibrationSettings.h  

FOnCalibrationInputToleranceChanged & OnCalibrationInputToleranceChanged()

 Gets a multicast delegate which is called whenever the displacement map resolution project setting changes CameraCalibrationSettings.h  

FOnDisplacementMapResolutionChanged & OnDisplacementMapResolutionChanged()

 Gets a multicast delegate which is called whenever the displacement map resolution project setting changes CameraCalibrationSettings.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   CameraCalibrationSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetCategoryName()

   CameraCalibrationSettings.h  

virtual FName GetSectionName()

   CameraCalibrationSettings.h  

virtual FText GetSectionText()

   CameraCalibrationSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page