unreal.LensDistortionModelHandlerBase

class unreal.LensDistortionModelHandlerBase(outer=None, name='None')

Bases: unreal.Object

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

C++ Source:

  • Plugin: CameraCalibrationCore

  • Module: CameraCalibrationCore

  • File: LensDistortionModelHandlerBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • current_state (LensDistortionState): [Read-Write] Current State: Current state as set by the most recent call to Update()

  • display_name (str): [Read-Only] Display Name: Display name, used to identify handler in-editor details panels

  • distortion_post_process_mid (MaterialInstanceDynamic): [Read-Only] Distortion Post Process MID: Dynamically created post-process material instance for the currently specified lens model

  • lens_model_class (type(Class)): [Read-Only] Lens Model Class: Lens Model describing how to interpret the distortion parameters

  • overscan_factor (float): [Read-Only] Overscan Factor: Computed overscan factor needed to scale the camera’s FOV (read-only)

property current_state

[Read-Only] Current State: Current state as set by the most recent call to Update()

Type

(LensDistortionState)

property distortion_post_process_mid

[Read-Only] Distortion Post Process MID: Dynamically created post-process material instance for the currently specified lens model

Type

(MaterialInstanceDynamic)

get_distortion_displacement_map() → TextureRenderTarget2D

Get the UV displacement map used to distort an undistorted image

Return type

TextureRenderTarget2D

get_undistortion_displacement_map() → TextureRenderTarget2D

Get the UV displacement map used to undistort a distorted image

Return type

TextureRenderTarget2D

is_model_supported(model_to_support) → bool

Returns true if the input model is supported by this model handler, false otherwise.

Parameters

model_to_support (type(Class)) –

Return type

bool

property lens_model_class

[Read-Only] Lens Model Class: Lens Model describing how to interpret the distortion parameters

Type

(type(Class))

property overscan_factor

[Read-Only] Overscan Factor: Computed overscan factor needed to scale the camera’s FOV (read-only)

Type

(float)

set_distortion_state(new_state) → None

Update the lens distortion state, recompute the overscan factor, and set all material parameters

Parameters

new_state (LensDistortionState) –