unreal.DisplayClusterConfigurationData

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

Bases: DisplayClusterConfigurationData_Base

/

Main configuration data container

C++ Source:

• Plugin: nDisplay

• Module: DisplayClusterConfiguration

• File: DisplayClusterConfigurationTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

• cluster (DisplayClusterConfigurationCluster): [Read-Only]

• custom_parameters (Map[str, str]): [Read-Write]

• default_frame_size_ref (DisplayClusterEditorPropertyReference): [Read-Write]

• diagnostics (DisplayClusterConfigurationDiagnostics): [Read-Write]

• exit_on_esc (bool): [Read-Write]

• follow_local_player_camera (bool): [Read-Write]

• info (DisplayClusterConfigurationInfo): [Read-Write]

• media_settings (DisplayClusterConfigurationGlobalMediaSettings): [Read-Write]

• override_transforms_from_external_config (bool): [Read-Write]

• override_viewports_from_external_config (bool): [Read-Write]

• render_frame_settings (DisplayClusterConfigurationRenderFrame): [Read-Write]

• scene (DisplayClusterConfigurationScene): [Read-Only]

• stage_settings (DisplayClusterConfigurationICVFX_StageSettings): [Read-Write]

assign_postprocess(node_id, postprocess_id, type, parameters, order=-1) → bool

UpdateCreate node postprocess

Parameters:

• node_id (str)

• postprocess_id (str) – Unique postprocess name

• type (str) – Postprocess type id

• parameters (Map[str, str]) – Postprocess parameters

• order (int32) – Control the rendering order of post-processing. Larger value is displayed last

Returns:

true, if success

Return type:

bool

property cluster: DisplayClusterConfigurationCluster

[Read-Only]

Type:

(DisplayClusterConfigurationCluster)

property custom_parameters: None

[Read-Write]

Type:

(Map[str, str])

property diagnostics: DisplayClusterConfigurationDiagnostics

[Read-Write]

Type:

(DisplayClusterConfigurationDiagnostics)

property exit_on_esc: bool

[Read-Write]

Type:

(bool)

property follow_local_player_camera: bool

[Read-Write]

Type:

(bool)

get_node(node_id) → DisplayClusterConfigurationClusterNode

Returns specific node configuration. Otherwise nullptr.

Parameters:

node_id (str)

Return type:

DisplayClusterConfigurationClusterNode

get_postprocess(node_id, postprocess_id) → DisplayClusterConfigurationPostprocess or None

Get Postprocess

Parameters:

• node_id (str)

• postprocess_id (str)

Returns:

out_postprocess (DisplayClusterConfigurationPostprocess):

Return type:

DisplayClusterConfigurationPostprocess or None

get_primary_node() → DisplayClusterConfigurationClusterNode

Returns primary node configuration. Otherwise nullptr.

Return type:

DisplayClusterConfigurationClusterNode

get_projection_policy(node_id, viewport_id) → DisplayClusterConfigurationProjection or None

Get Projection Policy

Parameters:

• node_id (str)

• viewport_id (str)

Returns:

out_projection (DisplayClusterConfigurationProjection):

Return type:

DisplayClusterConfigurationProjection or None

get_referenced_mesh_names() → Array[str]

Return all references to meshes from policy, and other

Returns:

out_mesh_names (Array[str]):

Return type:

Array[str]

get_viewport(node_id, viewport_id) → DisplayClusterConfigurationViewport

Viewports API

Parameters:

• node_id (str)

• viewport_id (str)

Return type:

DisplayClusterConfigurationViewport

property info: DisplayClusterConfigurationInfo

[Read-Write]

Type:

(DisplayClusterConfigurationInfo)

property media_settings: DisplayClusterConfigurationGlobalMediaSettings

[Read-Write]

Type:

(DisplayClusterConfigurationGlobalMediaSettings)

property override_transforms_from_external_config: bool

[Read-Write]

Type:

(bool)

property override_viewports_from_external_config: bool

[Read-Write]

Type:

(bool)

remove_postprocess(node_id, postprocess_id) → bool

Remove Postprocess

Parameters:

• node_id (str)

• postprocess_id (str)

Return type:

bool

property render_frame_settings: DisplayClusterConfigurationRenderFrame

[Read-Write]

Type:

(DisplayClusterConfigurationRenderFrame)

property scene: DisplayClusterConfigurationScene

[Read-Only]

Type:

(DisplayClusterConfigurationScene)

property stage_settings: DisplayClusterConfigurationICVFX_StageSettings

[Read-Write]

Type:

(DisplayClusterConfigurationICVFX_StageSettings)