get_scene_engine_paramT_get_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param (Operator)

Name

get_scene_engine_paramT_get_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param — Read a parameter from a running Scene Engine instance.

Signature

get_scene_engine_param( : : SceneEngine, GenParamName : GenParamValue)

Description

The operator get_scene_engine_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param returns the parameter values of GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for the running Scene Engine instance SceneEngineSceneEngineSceneEnginesceneEnginescene_engine in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

The following parameter names are supported:

'version'"version""version""version""version": Returns a string that contains the version number of the Scene Engine.
'devices'"devices""devices""devices""devices": Returns a tuple containing the available rendering devices.
'selected_device'"selected_device""selected_device""selected_device""selected_device": The device currently selected for data generation. See set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param, 'select_device_idx'"select_device_idx""select_device_idx""select_device_idx""select_device_idx" for how to change the selected device.
'assets'"assets""assets""assets""assets": Returns a dictionary that contains information about the available assets. This includes the asset base directory (see set_scene_engine_paramset_scene_engine_paramSetSceneEngineParamSetSceneEngineParamset_scene_engine_param for how to change this directory), the available tags and categories, as well as information about the detected asset providers.
'material_presets'"material_presets""material_presets""material_presets""material_presets": Returns a dictionary that contains the pre-set material properties. In each entry of the dictionary, the key corresponds to the name of the preset (such as 'metal'"metal""metal""metal""metal"), and the value contains the rendering properties to obtain a surface that mimics this material. This allows setting the surface / material properties of an object (see run_scene_enginerun_scene_engineRunSceneEngineRunSceneEnginerun_scene_engine).

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

SceneEngineSceneEngineSceneEnginesceneEnginescene_engine (input_control) scene_engine → (handle)

Handle of the SceneEngine connection.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)

Names of parameters.

Default: []

Suggested values: 'version'"version""version""version""version", 'devices'"devices""devices""devices""devices", 'selected_device'"selected_device""selected_device""selected_device""selected_device", 'assets'"assets""assets""assets""assets", 'material_presets'"material_presets""material_presets""material_presets""material_presets"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → (string / real / integer / handle)

Values of parameters.

Result

If the parameters are valid, the operator get_scene_engine_paramget_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_param returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.