1. Epic GamesDeveloper
  3. ULensDistortionModelHandlerBase

ULensDistortionModelHandlerBase

Asset user data that can be used on Camera Actors to manage lens distortion state and utilities

API > API/Plugins > API/Plugins/CameraCalibrationCore

Inheritance Hierarchy

References

   
Module CameraCalibrationCore
Header /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/LensDistortionModelHandlerBase.h
Include #include "LensDistortionModelHandlerBase.h"

Syntax

UCLASS&40;Abstract&41;  
class ULensDistortionModelHandlerBase : public UObject

Remarks

Asset user data that can be used on Camera Actors to manage lens distortion state and utilities

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite FCameraFilmbackSettings CameraFilmback Filmback settings of the camera that is being used for distortion
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FLensDistortionState CurrentState Current state as set by the most recent call to Update()
Protected variable UProperty Category visibleanywhere FString DisplayName Display name, used to identify handler in-editor details panels
Protected variable UProperty Transient TObjectPtr< UMaterialInstanceDynamic > DistortionDisplacementMapMID MID used to draw the distortion displacement map
Protected variable UProperty Transient TObjectPtr< UTextureRenderTarget2D > DistortionDisplacementMapRT UV displacement map used to distort an undistorted image
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UMaterialInstanceDynamic > DistortionPostProcessMID Dynamically created post-process material instance for the currently specified lens model
Protected variable UProperty FGuid DistortionProducerID UObject that is producing the distortion state for this handler
Protected variable UProperty Category BlueprintReadWrite visibleanywhere TSubclassOf< ULensModel > LensModelClass Lens Model describing how to interpret the distortion parameters
Protected variable UProperty Category BlueprintReadOnly visibleanywhere float OverscanFactor Computed overscan factor needed to scale the camera's FOV (read-only)
Protected variable UProperty Transient TObjectPtr< UMaterialInstanceDynamic > UndistortionDisplacementMapMID MID used to draw the undistortion displacement map
Protected variable UProperty Transient TObjectPtr< UTextureRenderTarget2D > UndistortionDisplacementMapRT UV displacement map used to undistort a distorted image

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const float Use the current distortion state to compute the overscan factor needed such that all distorted UVs will fall into the valid range of [0,1]
Public function void

CreateDisplacementMaps ( const FIntPoint DisplacementMapResolution
)

 Create two displacement maps, for distortion and undistortion, using the input resolution
Public function bool Draw the distortion displacement map associated with the current state to the DestinationTexture
Public function bool Draw the undistortion displacement map associated with the current state to the DestinationTexture
Public function Const FLensDistortionState Get the current distortion state (the lens model and properties that mathematically represent the distortion characteristics
Public function Const FString Get the display name of this lens distortion model handler
Public function Const TArray< FVector2D >

GetDistortedUVs ( TConstArrayView< FVector2D > UndistortedUVs
)

 Computes the distorted version of UndistortedUVs based on the current state
Public function Const UFunction BlueprintCallable, Category UTextureRenderTarget2D * Get the UV displacement map used to distort an undistorted image
Public function Const UMaterialInstanceDynamic * Get the post-process MID for the currently specified lens model
Public function Const FGuid Get the UObject that produces the distortion state for this handler
Public function Const FVector2D

GetFxFy ()

 Get the normalized focal length (unitless)
Public function Const const TSubclassOf< ULensModel > & Get the specified lens model that characterizes the distortion effect
Public function Const float Returns the last overscan factor that was set
Public function Const FVector2D Get the normalized center of projection of the image, in the range [0.0f, 1.0f]
Public function Const UFunction BlueprintCallable, Category UTextureRenderTarget2D * Get the UV displacement map used to undistort a distorted image
Public function Const UFunction BlueprintCallable, Category bool

IsModelSupported ( const TSubclassOf< ULensModel >& ModelToSupport
)

 Returns true if the input model is supported by this model handler, false otherwise.
Public function void Draws the current distortion state to the internal displacement map
Public function void

SetCameraFilmback ( const FCameraFilmbackSettings& InCameraFilmback
)

 Specify the filmback settings of the CineCamera that is being used for distortion
Public function void

SetDisplayName ( FString InDisplayName
)

 Set the display name of this lens distortion model handler
Public function void

SetDistortionProducerID ( const FGuid& InDistortionProducerID
)

 Set the UObject that produces the distortion state for this handler
Public function UFunction BlueprintCallable, Category void Update the lens distortion state, recompute the overscan factor, and set all material parameters
Public function void

SetOverscanFactor ( float OverscanFactor
)

 Updates overscan factor and applies to material instances

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page