Skip to content

get_scene_engine_paramGetSceneEngineParamGetSceneEngineParamget_scene_engine_paramT_get_scene_engine_param🔗

Short description🔗

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

Signature🔗

get_scene_engine_param( scene_engine SceneEngine, attribute.name GenParamName, out attribute.value GenParamValue )void GetSceneEngineParam( const HTuple& SceneEngine, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetSceneEngineParam( HTuple sceneEngine, HTuple genParamName, out HTuple genParamValue )def get_scene_engine_param( scene_engine: HHandle, gen_param_name: MaybeSequence[str] ) -> Sequence[HTupleElementType]

def get_scene_engine_param_s( scene_engine: HHandle, gen_param_name: MaybeSequence[str] ) -> HTupleElementTypeHerror T_get_scene_engine_param( const Htuple SceneEngine, const Htuple GenParamName, Htuple* GenParamValue )

static HTuple HDeepMatching3D::GetSceneEngineParam( const HSceneEngine& SceneEngine, const HTuple& GenParamName )

static HTuple HDeepMatching3D::GetSceneEngineParam( const HSceneEngine& SceneEngine, const HString& GenParamName )

static HTuple HDeepMatching3D::GetSceneEngineParam( const HSceneEngine& SceneEngine, const char* GenParamName )

static HTuple HDeepMatching3D::GetSceneEngineParam( const HSceneEngine& SceneEngine, const wchar_t* GenParamName ) (Windows only)

static HTuple HDeepMatching3D.GetSceneEngineParam( HSceneEngine sceneEngine, HTuple genParamName )

static HTuple HDeepMatching3D.GetSceneEngineParam( HSceneEngine sceneEngine, string genParamName )

Description🔗

The operator get_scene_engine_paramGetSceneEngineParam returns the parameter values of GenParamNamegenParamNamegen_param_name for the running Scene Engine instance SceneEnginesceneEnginescene_engine in GenParamValuegenParamValuegen_param_value.

The following parameter names are supported:

  • 'assets'"assets": Returns a dictionary that contains information about the available assets. This includes the asset base directory (see set_scene_engine_paramSetSceneEngineParam for how to change this directory), the available 'tags'"tags" and 'categories'"categories", as well as information about the detected asset providers.

  • 'devices'"devices": Returns a tuple containing the available rendering devices.

  • '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"), 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_engineRunSceneEngine).

  • 'selected_device'"selected_device": The device currently selected for data generation. See set_scene_engine_paramSetSceneEngineParam, 'select_device_idx'"select_device_idx" for how to change the selected device.

  • 'version'"version": Returns a string that contains the version number of the Scene Engine.

Execution information🔗

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🔗

SceneEnginesceneEnginescene_engine (input_control) scene_engine → (handle)HTuple (HHandle)HSceneEngine, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the Scene Engine connection.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Names of parameters.

Default: [][]
Suggested values: 'version', 'devices', 'selected_device', 'assets', 'material_presets'"version", "devices", "selected_device", "assets", "material_presets"

GenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → (string / real / integer / handle)HTuple (HString / double / Hlong / HHandle)HTuple (string / double / int / long / HHandle)Sequence[HTupleElementType]Htuple (char* / double / Hlong / handle)

Values of parameters.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_scene_engineOpenSceneEngine, set_scene_engine_paramSetSceneEngineParam

Possible successors

run_scene_engineRunSceneEngine, set_scene_engine_paramSetSceneEngineParam

See also

create_deep_matching_3dCreateDeepMatching3d

Module🔗

3D Metrology