1. Epic GamesDeveloper
  3. UCameraCalibrationSubsystem

UCameraCalibrationSubsystem

Camera Calibration subsystem

API > API/Plugins > API/Plugins/CameraCalibrationCore

Camera Calibration subsystem

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

Syntax

UCLASS (MinimalAPI)  
class UCameraCalibrationSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CameraCalibrationStepsMap TMap< FName, TSubclassOf< UCameraCalibrationStep > > Holds the registered camera calibration steps CameraCalibrationSubsystem.h
  • Transient
CameraImageCenterAlgosMap TMap< FName, TSubclassOf< UCameraImageCenterAlgo > > Holds the registered camera image center algos CameraCalibrationSubsystem.h
  • Transient
CameraNodalOffsetAlgosMap TMap< FName, TSubclassOf< UCameraNodalOffsetAlgo > > Holds the registered camera nodal offset algos CameraCalibrationSubsystem.h
  • Transient
ComponentsWithAuthoritativeModels TMap< FObjectKey, TSubclassOf< ULensModel > > Map of actor components to the authoritative lens model that should be used with that component CameraCalibrationSubsystem.h  
DefaultLensFile TObjectPtr< ULensFile > Default lens file to use when no override has been provided CameraCalibrationSubsystem.h
  • Transient
LensModelMap TMap< FName, TSubclassOf< ULensModel > > Map of model names to ULensModel subclasses CameraCalibrationSubsystem.h
  • Transient
PostEngineInitHandle FDelegateHandle   CameraCalibrationSubsystem.h  
RegisteredOverlayMaterials TMap< FName, TSoftObjectPtr< UMaterialInterface > > Map of overlay names to overlay materials CameraCalibrationSubsystem.h  
SceneViewExtension TSharedPtr< FLensDistortionSceneViewExtension, ESPMode::ThreadSafe > Lens Distortion Scene View Extension, used to render distortion and undistortion displacement maps CameraCalibrationSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearLensDistortionSVEState ( ACameraActor* CameraActor
)

 Removes all distortion state from the Lens Distortion Scene View Extension for the input camera actor CameraCalibrationSubsystem.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSULensDistortionModelHandlerBase * FindDistortionModelHandler ( FDistortionHandlerPicker& DistortionHandlerPicker,
bool bUpdatePicker
) const

   CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

ULensDistortionModelHandlerBase * FindOrCreateDistortionModelHandler ( FDistortionHandlerPicker& DistortionHandlerPicker,
const TSubclassOf< ULensModel > LensModelClass
)

   CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TSubclassOf< UCameraCalibrationStep > GetCameraCalibrationStep ( FName Name
) const

 Returns the camera calibration step by name CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TArray< FName > GetCameraCalibrationSteps()

 Returns an array with the names of the available camera calibration steps CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TSubclassOf< UCameraImageCenterAlgo > GetCameraImageCenterAlgo ( FName Name
) const

 Returns the image center algorithm by name CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TArray< FName > GetCameraImageCenterAlgos()

 Returns an array with the names of the available image center algorithms CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TSubclassOf< UCameraNodalOffsetAlgo > GetCameraNodalOffsetAlgo ( FName Name
) const

 Returns the nodal offset algorithm by name CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TArray< FName > GetCameraNodalOffsetAlgos()

 Returns an array with the names of the available nodal offset algorithms CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

ULensFile * GetDefaultLensFile()

 Get the default lens file. CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TArray< ULensDistortionModelHandlerBase * > GetDistortionModelHandlers ( UCineCameraComponent* Component
)

   CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

ULensFile * GetLensFile ( const FLensFilePicker& Picker
) const

 Facilitator around the picker to get the desired lens file. CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

UMaterialInterface * GetOverlayMaterial ( const FName& OverlayName
) const

 Returns the overlay material associated with the input overlay name CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TArray< FName > 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 CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

TSubclassOf< ULensModel > GetRegisteredLensModel ( FName ModelName
) const

 Return the ULensModel subclass that was registered with the input model name CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

void RegisterDistortionModel ( TSubclassOf< ULensModel > LensModel
)

 Add a new Lens Model to the registered model map CameraCalibrationSubsystem.h  

void RegisterOverlayMaterial ( const FName& MaterialName,
const FSoftObjectPath& MaterialPath
)

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

void SetDefaultLensFile ( ULensFile* NewDefaultLensFile
)

 Get the default lens file. CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

void SetLensDistortionSVEState ( ACameraActor* CameraActor,
FDisplacementMapBlendingParams DistortionState,
ULensDistortionModelHandlerBase* LensDistortionHandler
)

 Adds the input distortion state and blending parameters to the Lens Distortion Scene View Extension for the input camera actor CameraCalibrationSubsystem.h  

void UnregisterDistortionModel ( TSubclassOf< ULensModel > LensModel
)

 Remove a Lens Model from the registered model map CameraCalibrationSubsystem.h  

void UnregisterDistortionModelHandler ( UCineCameraComponent* Component,
ULensDistortionModelHandlerBase* Handler
)

   CameraCalibrationSubsystem.h
  • BlueprintCallable
  • Category="Lens Distortion"

void UnregisterOverlayMaterial ( const FName& MaterialName
)

 Unregister an overlay material CameraCalibrationSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   CameraCalibrationSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   CameraCalibrationSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page