unreal.LensDistortionComponent

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

Bases: unreal.ActorComponent

Component for applying a post-process lens distortion effect to a CineCameraComponent on the same actor

C++ Source:

• Plugin: CameraCalibration

• Module: CameraCalibration

• File: LensDistortionComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

• apply_distortion (bool): [Read-Write] Apply Distortion: Whether or not to apply distortion to the target camera component

• apply_nodal_offset (bool): [Read-Write] Apply Nodal Offset: Whether to apply nodal offset to the target camera

• asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

• auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

• can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

• component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

• distortion_source (DistortionHandlerPicker): [Read-Write] Distortion Source: Structure used to query the camera calibration subsystem for a lens distortion model handler

• editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

• evaluate_lens_file_for_distortion (bool): [Read-Write] Evaluate Lens File for Distortion: Whether to use the specified lens file to drive distortion Enabling this will create a new distortion source and automatically set this component to use it

• is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

• lens_file_picker (LensFilePicker): [Read-Write] Lens File Picker: Lens File used to drive distortion with current camera settings

• on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

• on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

• overscan_multiplier (float): [Read-Write] Overscan Multiplier: The percentage of the computed overscan that should be applied to the target camera

• primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

• replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

• scale_overscan (bool): [Read-Write] Scale Overscan: Whether to scale the computed overscan by the overscan percentage

• target_camera_component (ComponentReference): [Read-Write] Target Camera Component: The CineCameraComponent on which to apply the post-process distortion effect

property apply_distortion

[Read-Write] Apply Distortion: Whether or not to apply distortion to the target camera component

Type

(bool)

property distortion_source

[Read-Write] Distortion Source: Structure used to query the camera calibration subsystem for a lens distortion model handler

Type

(DistortionHandlerPicker)

property overscan_multiplier

[Read-Write] Overscan Multiplier: The percentage of the computed overscan that should be applied to the target camera

Type

(float)

property scale_overscan

[Read-Write] Scale Overscan: Whether to scale the computed overscan by the overscan percentage

Type

(bool)