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
event (DisplayClusterClusterEventBinary) –
master_only (bool) –
-
emit_cluster_event_json
(event, master_only) → None¶ Emit Cluster Event Json
- Parameters
event (DisplayClusterClusterEventJson) –
master_only (bool) –
-
get_axis
(device_id, device_channel) -> (value=float, is_available=bool)¶ Axes
- Parameters
device_id (str) –
device_channel (int32) –
- Returns
value (float):
is_available (bool):
- Return type
tuple
-
get_axis_device_amount
() → int32¶ - /
Input API
- /
Device information
- Returns
- Return type
int32
-
get_buffer_ratio
(viewport_id) → float or None¶ Get Buffer Ratio
Get Button Device Amount
- Returns
- Return type
int32
Buttons
- 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
-
get_keyboard_device_ids
()¶ Get Keyboard Device Ids
-
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.
- Returns
viewport_i_ds (Array(str)):
projection_types (Array(str)):
viewport_locations (Array(IntPoint)):
viewport_sizes (Array(IntPoint)):
- Return type
tuple
-
get_nodes_amount
() → int32¶ Get Nodes Amount
- Returns
- Return type
int32
-
get_operation_mode
() → DisplayClusterOperationMode¶ Get Operation Mode
- Returns
- Return type
-
get_root_actor
() → DisplayClusterRootActor¶ - /
Game API
- /
Root
- Returns
- Return type
-
get_tracker_device_amount
() → int32¶ Get Tracker Device Amount
- Returns
- Return type
int32
-
get_tracker_device_ids
()¶ Get Tracker Device Ids
-
get_tracker_location
(device_id, device_channel) -> (location=Vector, is_channel_available=bool)¶ Trackers
- 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
- 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
Is Button Pressed
- Parameters
device_id (str) –
device_channel (int32) –
- Returns
is_pressed_currently (bool):
is_channel_available (bool):
- Return type
tuple
Is Button Released
- Parameters
device_id (str) –
device_channel (int32) –
- Returns
is_released_currently (bool):
is_channel_available (bool):
- Return type
tuple
-
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
- Parameters
- Returns
out_is_active_function (SceneViewExtensionIsActiveFunctor):
- Return type
-
set_final_post_processing_settings
(viewport_id, final_post_processing_settings) → None¶ Set Final Post Processing Settings
- Parameters
viewport_id (str) –
final_post_processing_settings (PostProcessSettings) –
-
set_override_post_processing_settings
(viewport_id, override_post_processing_settings, blend_weight=1.0) → None¶ Set Override Post Processing Settings
- Parameters
viewport_id (str) –
override_post_processing_settings (PostProcessSettings) –
blend_weight (float) –
-
set_start_post_processing_settings
(viewport_id, start_post_processing_settings) → None¶ Set Start Post Processing Settings
- Parameters
viewport_id (str) –
start_post_processing_settings (PostProcessSettings) –
Was Button Pressed
- Parameters
device_id (str) –
device_channel (int32) –
- Returns
was_pressed (bool):
is_channel_available (bool):
- Return type
tuple
Was Button Released
- Parameters
device_id (str) –
device_channel (int32) –
- Returns
was_released (bool):
is_channel_available (bool):
- Return type
tuple