unreal.DisplayClusterBlueprintAPI

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

Bases: unreal.Interface

Display Cluster Blueprint API

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayCluster

  • File: IDisplayClusterBlueprintAPI.h

add_cluster_event_listener(listener) → None

Adds cluster event listener.

Parameters

listener (DisplayClusterClusterEventListener) –

emit_cluster_event(event, master_only) → None

Emits cluster event. deprecated: Please, use EmitClusterEventJson

Parameters
emit_cluster_event_binary(event, master_only) → None

Emits cluster event.

Parameters
emit_cluster_event_json(event, master_only) → None

Emits cluster event.

Parameters
get_all_cameras()

Returns array of all available camera components. deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

Array(DisplayClusterCameraComponent)

get_all_nodes()

Returns array of all scene components (nodes). deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

Array(DisplayClusterSceneComponent)

get_all_screens()

Returns array of all screen components. deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

Array(DisplayClusterScreenComponent)

get_axis(device_id, device_channel) -> (value=float, is_available=bool)

Returns axis value at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

value (float):

is_available (bool):

Return type

tuple

get_axis_device_amount() → int32

Returns amount of VRPN axis devices.

Returns

Return type

int32

get_axis_device_ids()

Returns array of names of all VRPN axis devices.

Returns

device_i_ds (Array(str)):

Return type

Array(str)

get_buffer_ratio(viewport_id) → float or None

Returns current buffer ratio for specified viewport.

Parameters

viewport_id (str) –

Returns

buffer_ratio (float):

Return type

float or None

get_button_device_amount() → int32

Returns amount of VRPN button devices.

Returns

Return type

int32

get_button_device_ids()

Returns array of names of all VRPN button devices.

Returns

device_i_ds (Array(str)):

Return type

Array(str)

get_button_state(device_id, device_channel) -> (current_state=bool, is_channel_available=bool)

Returns state of VRPN button at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

current_state (bool):

is_channel_available (bool):

Return type

tuple

get_camera_by_id(camera_id) → DisplayClusterCameraComponent

Returns camera component with specified ID. deprecated: This function has been moved to ADisplayClusterRootActor.

Parameters

camera_id (str) –

Returns

Return type

DisplayClusterCameraComponent

get_cameras_amount() → int32

Returns amount of cameras. deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

int32

get_config() → DisplayClusterConfigurationData

Return current configuration data

Returns

Return type

DisplayClusterConfigurationData

get_default_camera() → DisplayClusterCameraComponent

Returns default camera component. deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

DisplayClusterCameraComponent

get_eyes_swap(camera_id) → bool

Gets Swap eye rendering state. deprecated: This function has been moved to UDisplayClusterCameraComponent.

Parameters

camera_id (str) –

Returns

Return type

bool

get_interpupillary_distance(camera_id) → float

Returns interpupillary distance (eye separation) for stereoscopic rendering. deprecated: This function has been moved to UDisplayClusterCameraComponent.

Parameters

camera_id (str) –

Returns

Return type

float

get_keyboard_device_ids()

Returns array of names of all keyboard devices.

Returns

device_i_ds (Array(str)):

Return type

Array(str)

get_local_viewports() -> (viewport_i_ds=Array(str), viewport_types=Array(str), viewport_locations=Array(IntPoint), viewport_sizes=Array(IntPoint))

Returns list of local viewports.

Returns

viewport_i_ds (Array(str)):

viewport_types (Array(str)):

viewport_locations (Array(IntPoint)):

viewport_sizes (Array(IntPoint)):

Return type

tuple

get_node_by_id(scene_node_id) → DisplayClusterSceneComponent

Returns scene component by its ID. deprecated: This function has been moved to ADisplayClusterRootActor.

Parameters

scene_node_id (str) –

Returns

Return type

DisplayClusterSceneComponent

get_node_id() → str

Returns cluster node name of the current application instance.

Returns

Return type

str

get_nodes_amount() → int32

Returns amount of nodes in a cluster.

Returns

Return type

int32

get_operation_mode() → DisplayClusterOperationMode

Returns current operation mode.

Returns

Return type

DisplayClusterOperationMode

get_root_actor() → DisplayClusterRootActor

Returns DisplayCluster root actor.

Returns

Return type

DisplayClusterRootActor

get_root_component() → DisplayClusterRootComponent

Returns DisplayCluster root component. deprecated: UDisplayClusterRootComponent has been deprecated. Please use ADisplayClusterRootActor.

Returns

Return type

DisplayClusterRootComponent

get_screen_by_id(screen_id) → DisplayClusterScreenComponent

Returns screen component by ID. deprecated: This function has been moved to ADisplayClusterRootActor.

Parameters

screen_id (str) –

Returns

Return type

DisplayClusterScreenComponent

get_screens_amount() → int32

Returns amount of screens defined in current configuration file. deprecated: This function has been moved to ADisplayClusterRootActor.

Returns

Return type

int32

get_tracker_device_amount() → int32

Returns amount of VRPN tracker devices.

Returns

Return type

int32

get_tracker_device_ids()

Returns array of names of all VRPN tracker devices.

Returns

device_i_ds (Array(str)):

Return type

Array(str)

get_tracker_location(device_id, device_channel) -> (location=Vector, is_channel_available=bool)

Returns tracker location values at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

location (Vector):

is_channel_available (bool):

Return type

tuple

get_tracker_quat(device_id, device_channel) -> (rotation=Quat, is_channel_available=bool)

Returns tracker quaternion values at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

rotation (Quat):

is_channel_available (bool):

Return type

tuple

get_viewport_rect(viewport_id) → (viewport_loc=IntPoint, viewport_size=IntPoint) or None

Returns location and size of specified viewport.

Parameters

viewport_id (str) –

Returns

viewport_loc (IntPoint):

viewport_size (IntPoint):

Return type

tuple or None

is_button_pressed(device_id, device_channel) -> (is_pressed_currently=bool, is_channel_available=bool)

Returns whether VRPN button is pressed at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

is_pressed_currently (bool):

is_channel_available (bool):

Return type

tuple

is_button_released(device_id, device_channel) -> (is_released_currently=bool, is_channel_available=bool)

Returns whether VRPN button is released at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

is_released_currently (bool):

is_channel_available (bool):

Return type

tuple

is_cluster() → bool

Returns true if current application is running in cluster mode. deprecated: This feature is no longer supported.

Returns

Return type

bool

is_master() → bool

Returns true if current node is a master computer in a cluster.

Returns

Return type

bool

is_module_initialized() → bool

Returns true if the module has been initialized.

Returns

Return type

bool

is_slave() → bool

Returns true if current node is a slave computer in a cluster.

Returns

Return type

bool

is_standalone() → bool

Returns true if current application is running in standalone mode. deprecated: This feature is no longer supported.

Returns

Return type

bool

remove_cluster_event_listener(listener) → None

Removes cluster event listener.

Parameters

listener (DisplayClusterClusterEventListener) –

scene_view_extension_is_active_in_context_function(viewport_i_ds) → SceneViewExtensionIsActiveFunctor

Returns a functor that determines if any given scene view extension should be active in the given context for the current frame

Parameters

viewport_i_ds (Array(str)) –

Returns

out_is_active_function (SceneViewExtensionIsActiveFunctor):

Return type

SceneViewExtensionIsActiveFunctor

set_buffer_ratio(viewport_id, buffer_ratio) → bool

Sets buffer ratio for specified viewport.

Parameters

  • viewport_id (str) –

  • buffer_ratio (float) –

Returns

Return type

bool

set_default_camera_by_id(camera_id) → None

Sets default camera component specified by ID. deprecated: This function has been moved to ADisplayClusterRootActor.

Parameters

camera_id (str) –

set_eyes_swap(camera_id, eye_swapped) → None

Sets Swap eye rendering state. deprecated: This function has been moved to UDisplayClusterCameraComponent.

Parameters

  • camera_id (str) –

  • eye_swapped (bool) –

set_final_post_processing_settings(viewport_id, final_post_processing_settings) → None

Overrides postprocess settings for specified viewport.

Parameters
set_interpupillary_distance(camera_id, eye_distance) → None

Sets interpupillary distance (eye separation) for stereoscopic rendering. deprecated: This function has been moved to UDisplayClusterCameraComponent.

Parameters

  • camera_id (str) –

  • eye_distance (float) –

set_override_post_processing_settings(viewport_id, override_post_processing_settings, blend_weight=1.0) → None

Overrides postprocess settings for specified viewport.

Parameters
set_start_post_processing_settings(viewport_id, start_post_processing_settings) → None

Overrides postprocess settings for specified viewport.

Parameters
set_viewport_camera(camera_id, viewport_id) → None

Binds camera to a viewport.

Parameters

  • camera_id (str) –

  • viewport_id (str) –

toggle_eyes_swap(camera_id) → bool

Toggles current eye swap state. deprecated: This function has been moved to UDisplayClusterCameraComponent.

Parameters

camera_id (str) –

Returns

Return type

bool

was_button_pressed(device_id, device_channel) -> (was_pressed=bool, is_channel_available=bool)

Returns whether VRPN button was released at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

was_pressed (bool):

is_channel_available (bool):

Return type

tuple

was_button_released(device_id, device_channel) -> (was_released=bool, is_channel_available=bool)

Returns whether VRPN button was released at specified device and channel.

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

was_released (bool):

is_channel_available (bool):

Return type

tuple