unreal.DMXPixelMappingLayoutScript

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

Bases: Object

Allows scripting of Pixel Mapping Component Layouts. Override the Layout function to implement a layout.

Note, layout scripts are applied in parent’s unrotated space.

C++ Source:

  • Plugin: DMXPixelMapping

  • Module: DMXPixelMappingRuntime

  • File: DMXPixelMappingLayoutScript.h

Editor Properties: (see get_editor_property/set_editor_property)

  • num_tokens (int32): [Read-Write] The number of tokens in the Layout.

  • parent_component_position (Vector2D): [Read-Write] The position of the parent component where the components that are being layouted reside in.

  • parent_component_size (Vector2D): [Read-Write] The size of the parent component where the components that are being layouted reside in.

  • parent_rotation (double): [Read-Write] The rotation of the parent component where the components that are being layouted reside in. Note, the position property does not consider this rotation to ease calculations.

  • texture_size (Vector2D): [Read-Write] The size of the texture this component is mapping.

layout(tokens) → Array[DMXPixelMappingLayoutToken]

Lays out children of the selection according to OutTokens. Tokens that are not returned remain unchanged. Called when the script is loaded (unless set otherwise in editor) and when Properties were changed.

Parameters:

tokens (Array[DMXPixelMappingLayoutToken]) – The child components of the current selection, as layout tokens.

Returns:

out_tokens (Array[DMXPixelMappingLayoutToken]): The layoyut of a component.

Return type:

Array[DMXPixelMappingLayoutToken]

property num_tokens: int

[Read-Only] The number of tokens in the Layout.

Type:

(int32)

property parent_component_position: Vector2D

[Read-Only] The position of the parent component where the components that are being layouted reside in.

Type:

(Vector2D)

property parent_component_size: Vector2D

[Read-Only] The size of the parent component where the components that are being layouted reside in.

Type:

(Vector2D)

property parent_rotation: float

[Read-Only] The rotation of the parent component where the components that are being layouted reside in. Note, the position property does not consider this rotation to ease calculations.

Type:

(double)

property texture_size: Vector2D

[Read-Only] The size of the texture this component is mapping.

Type:

(Vector2D)