Operator Reference

HALCON Operator Reference / Graphics / 3D Scene

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

set_scene_3d_paramT_set_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_param (Operator)

set_scene_3d_paramT_set_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_param — Set parameters of a 3D scene.

Signature

set_scene_3d_param( : : Scene3D, GenParamName, GenParamValue : )

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

void SetScene3dParam(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)

static void HOperatorSet.SetScene3dParam(HTuple scene3D, HTuple genParamName, HTuple genParamValue)

void HScene3D.SetScene3dParam(string genParamName, HTuple genParamValue)

void HScene3D.SetScene3dParam(string genParamName, string genParamValue)

def set_scene_3d_param(scene_3d: HHandle, gen_param_name: str, gen_param_value: Union[str, int, float]) -> None

Description

set_scene_3d_paramset_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_param sets parameters of the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d. The name and value of a parameter must be given in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

All parameters that can be set with set_scene_3d_instance_paramset_scene_3d_instance_paramSetScene3dInstanceParamSetScene3dInstanceParamset_scene_3d_instance_param can be set with set_scene_3d_paramset_scene_3d_paramSetScene3dParamSetScene3dParamset_scene_3d_param for all instances of a scene.

Additionally, the following parameters can be set:

'disp_background'"disp_background""disp_background""disp_background""disp_background":

Flag, if the current window content should be used as background.

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

Default: 'false'"false""false""false""false".

'colored'"colored""colored""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: 3, 6, 12.

Default: All objects are displayed white.

'object_index_persistence'"object_index_persistence""object_index_persistence""object_index_persistence""object_index_persistence":

Must be set to 'true'"true""true""true""true" to enable the object index query with get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info.

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

Default: 'false'"false""false""false""false".

'depth_persistence'"depth_persistence""depth_persistence""depth_persistence""depth_persistence":

Must be set to 'true'"true""true""true""true" to enable the depth query with get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info.

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

Default: 'false'"false""false""false""false".

'quality'"quality""quality""quality""quality":

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

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

Default: 'high'"high""high""high""high".

'compatibility_mode_enable'"compatibility_mode_enable""compatibility_mode_enable""compatibility_mode_enable""compatibility_mode_enable":

Enforce the usage of the fallback mode to OpenGL 1.1.

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

Default: 'false'"false""false""false""false".

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

Scene3DScene3DScene3Dscene3Dscene_3d (input_control)  scene_3d → HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 3D scene.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters.

Default: 'quality' "quality" "quality" "quality" "quality"

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

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  string → HTupleUnion[str, int, float]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Values of the generic parameters.

Default: 'high' "high" "high" "high" "high"

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

Result

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

Possible Predecessors

create_scene_3dcreate_scene_3dCreateScene3dCreateScene3dcreate_scene_3d

See also

set_scene_3d_instance_paramset_scene_3d_instance_paramSetScene3dInstanceParamSetScene3dInstanceParamset_scene_3d_instance_param

Module

3D Metrology

---

ClassesClasses | | Operators