unreal.DisplayClusterBlueprintAPIImpl

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

Bases: unreal.Object

Blueprint API interface implementation

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayCluster

  • File: DisplayClusterBlueprintAPIImpl.h

add_cluster_event_listener(listener) → None

Add Cluster Event Listener

Parameters

listener (DisplayClusterClusterEventListener) –

emit_cluster_event_binary(event, master_only) → None

Emit Cluster Event Binary

Parameters
emit_cluster_event_json(event, master_only) → None

Emit Cluster Event Json

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

Axes deprecated: VRPN functionality has been moved to LiveLinkVRPN

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

value (float):

is_channel_available (bool):

Return type

tuple

get_axis_device_amount() → int32
/

Input API

/

Device information

deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

Return type

int32

get_axis_device_ids()

Get Axis Device Ids deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

device_i_ds (Array(str)):

Return type

Array(str)

get_buffer_ratio(viewport_id) → float or None

Get Buffer Ratio deprecated: Use Configuration structures

Parameters

viewport_id (str) –

Returns

buffer_ratio (float):

Return type

float or None

get_button_device_amount() → int32

Get Button Device Amount deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

Return type

int32

get_button_device_ids()

Get Button Device Ids deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

device_i_ds (Array(str)):

Return type

Array(str)

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

Buttons deprecated: VRPN functionality has been moved to LiveLinkVRPN

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

current_state (bool):

is_channel_available (bool):

Return type

tuple

get_config() → DisplayClusterConfigurationData
/

Config API

Returns

Return type

DisplayClusterConfigurationData

get_keyboard_device_ids()

Get Keyboard Device Ids deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

device_i_ds (Array(str)):

Return type

Array(str)

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

Returns list of local viewports. deprecated: Use new api

Returns

viewport_i_ds (Array(str)):

projection_types (Array(str)):

viewport_locations (Array(IntPoint)):

viewport_sizes (Array(IntPoint)):

Return type

tuple

get_node_id() → str

Get Node Id

Returns

Return type

str

get_nodes_amount() → int32

Get Nodes Amount

Returns

Return type

int32

get_operation_mode() → DisplayClusterOperationMode

Get Operation Mode

Returns

Return type

DisplayClusterOperationMode

get_root_actor() → DisplayClusterRootActor
/

Game API

/

Root

Returns

Return type

DisplayClusterRootActor

get_tracker_device_amount() → int32

Get Tracker Device Amount deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

Return type

int32

get_tracker_device_ids()

Get Tracker Device Ids deprecated: VRPN functionality has been moved to LiveLinkVRPN

Returns

device_i_ds (Array(str)):

Return type

Array(str)

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

Trackers deprecated: VRPN functionality has been moved to LiveLinkVRPN

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)

Get Tracker Quat deprecated: VRPN functionality has been moved to LiveLinkVRPN

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

Get Viewport Rect deprecated: Use new api

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)

Is Button Pressed deprecated: VRPN functionality has been moved to LiveLinkVRPN

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)

Is Button Released deprecated: VRPN functionality has been moved to LiveLinkVRPN

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

is_released_currently (bool):

is_channel_available (bool):

Return type

tuple

is_master() → bool
/

Cluster API

Returns

Return type

bool

is_module_initialized() → bool
/

DisplayCluster module API

Returns

Return type

bool

is_slave() → bool

Is Slave

Returns

Return type

bool

remove_cluster_event_listener(listener) → None

Remove Cluster Event Listener

Parameters

listener (DisplayClusterClusterEventListener) –

scene_view_extension_is_active_in_context_function(viewport_i_ds) → SceneViewExtensionIsActiveFunctor

Scene View Extension Is Active in Context Function deprecated: Use Configuration structures

Parameters

viewport_i_ds (Array(str)) –

Returns

out_is_active_function (SceneViewExtensionIsActiveFunctor):

Return type

SceneViewExtensionIsActiveFunctor

send_cluster_event_binary_to(address, port, event, master_only) → None

Send Cluster Event Binary To

Parameters
send_cluster_event_json_to(address, port, event, master_only) → None

Send Cluster Event Json To

Parameters
set_buffer_ratio(viewport_id, buffer_ratio) → bool

Set Buffer Ratio deprecated: Use Configuration structures

Parameters

  • viewport_id (str) –

  • buffer_ratio (float) –

Returns

Return type

bool

set_final_post_processing_settings(viewport_id, final_post_processing_settings) → None

Set Final Post Processing Settings deprecated: Use Configuration structures

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

Set Override Post Processing Settings deprecated: Use Configuration structures

Parameters
set_start_post_processing_settings(viewport_id, start_post_processing_settings) → None

Set Start Post Processing Settings deprecated: Use Configuration structures

Parameters
set_viewport_camera(camera_id, viewport_id) → None
/

Render API

deprecated: Use Configuration structures

Parameters

  • camera_id (str) –

  • viewport_id (str) –

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

Was Button Pressed deprecated: VRPN functionality has been moved to LiveLinkVRPN

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)

Was Button Released deprecated: VRPN functionality has been moved to LiveLinkVRPN

Parameters

  • device_id (str) –

  • device_channel (int32) –

Returns

was_released (bool):

is_channel_available (bool):

Return type

tuple