Skip to content

set_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_paramT_set_scene_3d_param🔗

Short description🔗

set_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_paramT_set_scene_3d_param — Set parameters of a 3D scene.

Signature🔗

set_scene_3d_param( scene_3d Scene3D, string GenParamName, string GenParamValue )void SetScene3dParam( const HTuple& Scene3D, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetScene3dParam( HTuple scene3D, HTuple genParamName, HTuple genParamValue )def set_scene_3d_param( scene_3d: HHandle, gen_param_name: str, gen_param_value: Union[str, int, float] ) -> None

Herror T_set_scene_3d_param( const Htuple Scene3D, const Htuple GenParamName, const Htuple GenParamValue )

void HScene3D::SetScene3dParam( const HString& GenParamName, const HTuple& GenParamValue ) const

void HScene3D::SetScene3dParam( const HString& GenParamName, const HString& GenParamValue ) const

void HScene3D::SetScene3dParam( const char* GenParamName, const char* GenParamValue ) const

void HScene3D::SetScene3dParam( const wchar_t* GenParamName, const wchar_t* GenParamValue ) const (Windows only)

void HScene3D.SetScene3dParam( string genParamName, HTuple genParamValue )

void HScene3D.SetScene3dParam( string genParamName, string genParamValue )

Description🔗

set_scene_3d_paramSetScene3dParam sets parameters of the 3D scene Scene3Dscene3Dscene_3d. The name and value of a parameter must be given in GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value.

All parameters that can be set with set_scene_3d_instance_paramSetScene3dInstanceParam can be set with set_scene_3d_paramSetScene3dParam for all instances of a scene.

Additionally, the following parameters can be set:

  • 'disp_background'"disp_background": Flag, if the current window content should be used as background.

    List of values: 'true'"true", 'false'"false".

    Default: 'false'"false".

  • 'colored'"colored": Set the colors of all currently added instances to different colors. The value of this parameter defines the number of colors that are used.

    List of values: 33, 66, 1212.

    Default: All objects are displayed white.

  • 'object_index_persistence'"object_index_persistence": Must be set to 'true'"true" to enable the object index query with get_display_scene_3d_infoGetDisplayScene3dInfo.

    List of values: 'true'"true", 'false'"false".

    Default: 'false'"false".

  • 'depth_persistence'"depth_persistence": Must be set to 'true'"true" to enable the depth query with get_display_scene_3d_infoGetDisplayScene3dInfo.

    List of values: 'true'"true", 'false'"false".

    Default: 'false'"false".

  • 'quality'"quality": Must be set to 'low'"low" to enable faster rendering without anti aliasing.

    List of values: 'low'"low", 'high'"high".

    Default: 'high'"high".

  • 'compatibility_mode_enable'"compatibility_mode_enable": Enforce the usage of the fallback mode to OpenGL 1.1.

    List of values: 'true'"true", 'false'"false".

    Default: 'false'"false".

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🔗

Scene3Dscene3Dscene_3d (input_control) scene_3d → (handle)HTuple (HHandle)HScene3D, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the 3D scene.

GenParamNamegenParamNamegen_param_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Names of the generic parameters.

Default: 'quality'"quality"
List of values: 'alpha', 'attribute', 'blue_channel_attrib', 'color', 'color_attrib', 'color_attrib_end', 'color_attrib_start', 'colored', 'compatibility_mode_enable', 'depth_persistence', 'disp_background', 'disp_lines', 'disp_normals', 'disp_pose', 'green_channel_attrib', 'line_color', 'line_width', 'lut', 'normal_color', 'object_index_persistence', 'point_size', 'quality', 'red_channel_attrib', 'rgb_channel_attrib_end', 'rgb_channel_attrib_start', 'visible'"alpha", "attribute", "blue_channel_attrib", "color", "color_attrib", "color_attrib_end", "color_attrib_start", "colored", "compatibility_mode_enable", "depth_persistence", "disp_background", "disp_lines", "disp_normals", "disp_pose", "green_channel_attrib", "line_color", "line_width", "lut", "normal_color", "object_index_persistence", "point_size", "quality", "red_channel_attrib", "rgb_channel_attrib_end", "rgb_channel_attrib_start", "visible"

GenParamValuegenParamValuegen_param_value (input_control) string → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Union[str, int, float]Htuple (char* / Hlong / double)

Values of the generic parameters.

Default: 'high'"high"
Suggested values: 'true', 'false', 'high', 'low', 'coord_x', 'coord_y', 'coord_z', 'normal_x', 'normal_y', 'normal_z', 'red', 'green', 'blue', 'auto', 'faces', 'primitive', 'points', 'lines'"true", "false", "high", "low", "coord_x", "coord_y", "coord_z", "normal_x", "normal_y", "normal_z", "red", "green", "blue", "auto", "faces", "primitive", "points", "lines"

Result🔗

set_scene_3d_paramSetScene3dParam returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_scene_3dCreateScene3d

See also

set_scene_3d_instance_paramSetScene3dInstanceParam

Module🔗

3D Metrology