unreal.DisplayClusterConfigurationData

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

Bases: unreal.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] Cluster

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

  • default_frame_size_ref (DisplayClusterEditorPropertyReference): [Read-Write] Default Frame Size Ref

  • diagnostics (DisplayClusterConfigurationDiagnostics): [Read-Write] Diagnostics

  • exit_on_esc (bool): [Read-Write] Exit on Esc

  • follow_local_player_camera (bool): [Read-Write] Follow Local Player Camera

  • info (DisplayClusterConfigurationInfo): [Read-Write] Info

  • override_viewports_from_external_config (bool): [Read-Write] Override Viewports from External Config

  • render_frame_settings (DisplayClusterConfigurationRenderFrame): [Read-Write] Render Frame Settings

  • scene (DisplayClusterConfigurationScene): [Read-Only] Scene

  • stage_settings (DisplayClusterConfigurationICVFX_StageSettings): [Read-Write] Stage Settings

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

[Read-Only] Cluster

Type

(DisplayClusterConfigurationCluster)

property custom_parameters

[Read-Write] Custom Parameters

Type

(Map(str, str))

property diagnostics

[Read-Write] Diagnostics

Type

(DisplayClusterConfigurationDiagnostics)

property exit_on_esc

[Read-Write] Exit on Esc

Type

(bool)

property follow_local_player_camera

[Read-Write] Follow Local Player Camera

Type

(bool)

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_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()

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

[Read-Write] Info

Type

(DisplayClusterConfigurationInfo)

property override_viewports_from_external_config

[Read-Write] Override Viewports from External Config

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

[Read-Write] Render Frame Settings

Type

(DisplayClusterConfigurationRenderFrame)

property scene

[Read-Only] Scene

Type

(DisplayClusterConfigurationScene)

property stage_settings

[Read-Write] Stage Settings

Type

(DisplayClusterConfigurationICVFX_StageSettings)