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

Returns amount of nodes in cluster.

Parameters:listener (DisplayClusterClusterEventListener) –
emit_cluster_event(event, master_only) → None

Returns amount of nodes in cluster.

Parameters:
get_all_cameras() -> Array(DisplayClusterCameraComponent)

Returns array of all available cameras.

Returns:
Return type:Array(DisplayClusterCameraComponent)
get_all_nodes() -> Array(DisplayClusterSceneComponent)

Returns array of all nodes references by its id name.

Returns:
Return type:Array(DisplayClusterSceneComponent)
get_all_screens() -> Array(DisplayClusterScreenComponent)

Returns array of all screen references.

Returns:
Return type:Array(DisplayClusterScreenComponent)
get_axis(device_id, device_channel) -> (value=float, is_available=bool)

Return axis value at specified device and channel.

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

value (float):

is_available (bool):

Return type:

tuple

get_axis_device_amount() → int32

Return amount of VRPN axis devices.

Returns:
Return type:int32
get_axis_device_ids() → Array(str) or None

Return array of names of all VRPN axis devices.

Returns:i_ds (Array(str)):
Return type:Array(str) or None
get_buffer_ratio(viewport_id) → float

Get Buffer Ratio

Parameters:viewport_id (str) –
Returns:out_buffer_ratio (float):
Return type:float
get_button_device_amount() → int32

Return amount of VRPN button devices.

Returns:
Return type:int32
get_button_device_ids() → Array(str) or None

Return array of names of all VRPN button devices.

Returns:i_ds (Array(str)):
Return type:Array(str) or None
get_button_state(device_id, device_channel) -> (cur_state=bool, is_channel_available=bool)

Return state of VRPN button at specified device and channel.

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

cur_state (bool):

is_channel_available (bool):

Return type:

tuple

get_camera_by_id(id) → DisplayClusterCameraComponent

Returns camera component with specified ID.

Parameters:id (str) –
Returns:
Return type:DisplayClusterCameraComponent
get_cameras_amount() → int32

Returns amount of cameras.

Returns:
Return type:int32
get_default_camera() → DisplayClusterCameraComponent

Returns default camera component.

Returns:
Return type:DisplayClusterCameraComponent
get_eyes_swap(camera_id) → bool

Get Swap eye rendering state.

Parameters:camera_id (str) –
Returns:
Return type:bool
get_interpupillary_distance(camera_id) → float

Return eye interpupillary distance (eye separation) for stereoscopic rendering.

Parameters:camera_id (str) –
Returns:
Return type:float
get_local_viewports(is_rtt) -> (viewport_i_ds=Array(str), viewport_types=Array(str), viewport_locations=Array(IntPoint), viewport_sizes=Array(IntPoint))
/
Config API
Parameters:is_rtt (bool) –
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(id) → DisplayClusterSceneComponent

Returns node reference by its id name.

Parameters:id (str) –
Returns:
Return type:DisplayClusterSceneComponent
get_node_id() → str

Returns node name of the current application instance.

Returns:
Return type:str
get_nodes_amount() → int32

Returns amount of nodes in cluster.

Returns:
Return type:int32
get_operation_mode() → DisplayClusterOperationMode

Return 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.

Returns:
Return type:DisplayClusterRootComponent
get_screen_by_id(id) → DisplayClusterScreenComponent

Returns screen reference by id name.

Parameters:id (str) –
Returns:
Return type:DisplayClusterScreenComponent
get_screens_amount() → int32

Returns amount of screens defined in configuration file.

Returns:
Return type:int32
get_tracker_device_amount() → int32

Return amount of VRPN tracker devices.

Returns:
Return type:int32
get_tracker_device_ids() → Array(str) or None

Return array of names of all VRPN tracker devices.

Returns:i_ds (Array(str)):
Return type:Array(str) or None
get_tracker_location(device_id, device_channel) -> (location=Vector, is_channel_available=bool)

Return tracker location values at specified device and channel.

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

location (Vector):

is_channel_available (bool):

Return type:

tuple

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

Return tracker quaternion values at specified device and channel.

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
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

Parameters:viewport_id (str) –
Returns:viewport_loc (IntPoint):

viewport_size (IntPoint):

Return type:tuple or None
is_button_pressed(device_id, device_channel) -> (cur_pressed=bool, is_channel_available=bool)

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

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

cur_pressed (bool):

is_channel_available (bool):

Return type:

tuple

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

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

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

cur_released (bool):

is_channel_available (bool):

Return type:

tuple

is_cluster() → bool

Whether application is in cluster mode or not.

Returns:
Return type:bool
is_master() → bool

Return if current node is a master computer in cluster.

Returns:
Return type:bool
is_module_initialized() → bool

Return if the module has been initialized.

Returns:
Return type:bool
is_slave() → bool

Return if current node is not a master computer in cluster.

Returns:
Return type:bool
is_standalone() → bool

Whether application is in standalone mode or not.

Returns:
Return type:bool
remove_cluster_event_listener(listener) → None

Returns amount of nodes in cluster.

Parameters:listener (DisplayClusterClusterEventListener) –
set_buffer_ratio(viewport_id, buffer_ratio) → None

Set Buffer Ratio

Parameters:
  • viewport_id (str) –
  • buffer_ratio (float) –
set_default_camera_by_id(id) → None

Sets default camera component specified by ID.

Parameters:id (str) –
set_eyes_swap(camera_id, eye_swapped) → None

Swap eye rendering.

Parameters:
  • camera_id (str) –
  • eye_swapped (bool) –
set_final_post_processing_settings(viewport_id, final_post_processing_settings) → None

Set Final Post Processing Settings

Parameters:
set_interpupillary_distance(camera_id, eye_distance) → None

Set eye interpupillary distance (eye separation) for stereoscopic rendering.

Parameters:
  • camera_id (str) –
  • eye_distance (float) –
set_override_post_processing_settings(viewport_id, override_post_processing_settings, blend_weight=1.000000) → None

Set Override Post Processing Settings

Parameters:
set_start_post_processing_settings(viewport_id, start_post_processing_settings) → None

Set Start Post Processing Settings

Parameters:
set_viewport_camera(camera_id, viewport_id) → None
/
Render API
Parameters:
  • camera_id (str) –
  • viewport_id (str) –
toggle_eyes_swap(camera_id) → bool

Toggle current eye swap state.

Parameters:camera_id (str) –
Returns:
Return type:bool
was_button_pressed(device_id, device_channel) -> (was_pressed=bool, is_channel_available=bool)

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

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
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)

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

Parameters:
  • device_id (str) –
  • device_channel (uint8) –
Returns:

was_released (bool):

is_channel_available (bool):

Return type:

tuple