unreal.DMXPixelMappingRendererComponent

class unreal.DMXPixelMappingRendererComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: DMXPixelMappingOutputComponent

Component for rendering input texture.

C++ Source:

  • Plugin: DMXPixelMapping

  • Module: DMXPixelMappingRuntime

  • File: DMXPixelMappingRendererComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • brightness (float): [Read-Write] The exposure of the pixel mapping renderer. This property affects the DMX output.

  • children_follow_size (bool): [Read-Write] If true, children are positioned relative to the size of this renderer

  • editor_color (LinearColor): [Read-Write]

  • editor_position_with_rotation (Vector2D): [Read-Write]

  • input_material (MaterialInterface): [Read-Write] The material used for pixel mapping

  • input_texture (Texture): [Read-Write] The texture used for pixel mapping

  • input_widget (type(Class)): [Read-Write] The UMG widget used for pixel mapping

  • layout_script (DMXPixelMappingLayoutScript): [Read-Write] Layout script for the children of this component (hidden in customizations and displayed in its own panel).

  • lock_in_designer (bool): [Read-Write]

  • parent (DMXPixelMappingBaseComponent): [Read-Write] Parent component deprecated: Leads to entangled references. Use GetParent() or WeakParent instead.

  • pixel_format (DMXPixelMappingRendererPixelFormat): [Read-Write] The dynamic range of the renderer

  • position_x (float): [Read-Write]

  • position_y (float): [Read-Write]

  • preprocess_renderer (DMXPixelMappingPreprocessRenderer): [Read-Only] Renderer responsible to preprocess the input texture / material / user widget

  • renderer_type (DMXPixelMappingRendererType): [Read-Write] Selects the input type. It can be a Texture, a Material or a User Widget.

  • rotation (double): [Read-Write]

  • size_x (float): [Read-Write]

  • size_y (float): [Read-Write]

  • visible_in_designer (bool): [Read-Write]

property brightness: float

[Read-Write] The exposure of the pixel mapping renderer. This property affects the DMX output.

Type:

(float)

get_pixel_mapping_component_modulators(fixture_patch_ref) Array[DMXModulator] or None

Returns the Modulators of the component corresponding to the patch specified. Note, this node does a lookup on all fixture patches in use, hence may be slow and shouldn’t be called on tick.

Parameters:

fixture_patch_ref (DMXEntityFixturePatchRef) –

Returns:

dmx_modulators (Array[DMXModulator]):

Return type:

Array[DMXModulator] or None

property input_material: MaterialInterface

[Read-Only] The material used for pixel mapping

Type:

(MaterialInterface)

property input_texture: Texture

[Read-Only] The texture used for pixel mapping

Type:

(Texture)

property input_widget: Class

[Read-Only] The UMG widget used for pixel mapping

Type:

(type(Class))

property pixel_format: DMXPixelMappingRendererPixelFormat

[Read-Only] The dynamic range of the renderer

Type:

(DMXPixelMappingRendererPixelFormat)

property renderer_type: DMXPixelMappingRendererType

[Read-Only] Selects the input type. It can be a Texture, a Material or a User Widget.

Type:

(DMXPixelMappingRendererType)