set_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParamset_scene_3d_label_paramT_set_scene_3d_label_param🔗

Short description🔗

set_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParamset_scene_3d_label_paramT_set_scene_3d_label_param — Set parameters of a text label in a 3D scene.

Signature🔗

set_scene_3d_label_param( scene_3d Scene3D, integer LabelIndex, string GenParamName, string GenParamValue )

Description🔗

set_scene_3d_label_paramSetScene3dLabelParam sets parameters of the label LabelIndexlabelIndexlabel_index in the 3D scene Scene3Dscene3Dscene_3d. The name and value of a parameter must be given in GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value. It is only possible to provide one GenParamNamegenParamNamegen_param_name,GenParamValuegenParamValuegen_param_value pair but multiple labels. The parameter is applied to all labels in LabelIndexlabelIndexlabel_index.

The following values can be set:

'reference_point'"reference_point": Coordinates of the reference point, as a tuple of [X, Y, Z][X, Y, Z] coordinates. To remove the current reference point, it is possible to pass an empty tuple for 'reference_point'"reference_point". This is only possible if 'relates_to'"relates_to" is 'window'"window".
'position'"position": Position (relative or absolute depending on the parameter 'relates_to'"relates_to") of the label, as a tuple of [Row, Column][Row, Column] coordinates or one of the following predefined positions.

List of values: 'top_left'"top_left", 'top'"top", 'top_right'"top_right", 'left'"left", 'center'"center", 'right'"right", 'bottom_left'"bottom_left", 'bottom'"bottom", or 'bottom_right'"bottom_right".
'relates_to'"relates_to": Relation of the position. May be 'window'"window" (fixed positioning in window coordinates) or 'point'"point" (positioning relative to the reference point). 'relates_to'"relates_to" cannot be set to 'point'"point" if the reference point has been set to an empty tuple.

List of values: 'window'"window" , 'point'"point".

Default: 'window'"window".
'text'"text": Text of the label. Multiple Lines must be separated with ‘n‘.
'font'"font": Font of the text label.

Suggested values: Available fonts can be queried using query_fontQueryFont.

Default: Font of the first window the scene is displayed in, default system font otherwise.
'text_color'"text_color": Color of the text on the label. The available colors can be queried with the operator query_colorQueryColor. In addition, the color may be specified as an RGB triplet in the form '#rrggbb'"#rrggbb", where 'rr'"rr", 'gg'"gg", and 'bb'"bb" are hexadecimal numbers between '00'"00" and 'ff'"ff", respectively.

Suggested values: 'red'"red", 'green'"green".

Default: 'white'"white".
'alpha'"alpha": Transparency of the text label’s background.

Value range: floating point value between 0.0 (fully transparent) and 1.0 (fully opaque).

Default: 1.01.0.
'color'"color": Color of the label itself. The available colors can be queried with the operator query_colorQueryColor. In addition, the color may be specified as an RGB triplet in the form '#rrggbb'"#rrggbb", where 'rr'"rr", 'gg'"gg", and 'bb'"bb" are hexadecimal numbers between '00'"00" and 'ff'"ff", respectively.

Suggested values: 'red'"red", 'green'"green".

Default: 'gray'"gray".
'disp_background'"disp_background": Flag that determines if the background of the label should be visualized.

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

Default: 'true'"true".
'disp_connecting_line'"disp_connecting_line": Flag that determines if the connecting line between the label and reference 3D point should be visualized.

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

Default: 'true'"true".
'visible'"visible": Sets the visibility of the label. If set to 'if_point_is_visible'"if_point_is_visible", the label is only visible if its reference point is visible. If the compatibility mode is enabled or no reference point is set, 'if_point_is_visible'"if_point_is_visible" is equal to 'true'"true".

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

Default: 'true'"true".

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.

LabelIndexlabelIndexlabel_index (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Index of the text label.

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

Names of the generic parameters.

Default: 'color'"color"
List of values: 'color', 'disp_background', 'disp_connecting_line', 'font', 'position', 'reference_point', 'relates_to', 'text', 'text_color', 'visible'

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

Values of the generic parameters.

Default: 'red'"red"
List of values: 'blue', 'bottom', 'bottom_left', 'bottom_right', 'center', 'green', 'left', 'point', 'red', 'right', 'top', 'top_left', 'top_right', 'window'

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

add_scene_3d_labelAddScene3dLabel

Module🔗

3D Metrology