set_window_paramT_set_window_paramSetWindowParamSetWindowParamset_window_param (Operator)

Name

set_window_paramT_set_window_paramSetWindowParamSetWindowParamset_window_param — Set window parameters.

Signature

Description

The operator set_window_paramset_window_paramSetWindowParamSetWindowParamSetWindowParamset_window_param allows to set different parameters of an open window.

General window parameters:

'flush'

Enables or disables flushing the contents of the window after the display of every object. If 'flush'"flush""flush""flush""flush""flush" is set to 'false'"false""false""false""false""false", flush_bufferflush_bufferFlushBufferFlushBufferFlushBufferflush_buffer must be called to update the contents of the window. If you want to interact with the content of the graphics window (e.g., zoom or move the content), you have to set 'flush'"flush""flush""flush""flush""flush" to 'true'"true""true""true""true""true".

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

Default: 'true'"true""true""true""true""true".

'region_quality'

Influences the quality of the rendering of region objects. Especially if the region to display has to be scaled down for visualization, 'good'"good""good""good""good""good" produces a more accurate and pleasing impression. 'low'"low""low""low""low""low" is a bit inaccurate in these cases but significantly faster. If only the border of the region is displayed (see set_drawset_drawSetDrawSetDrawSetDrawset_draw), the fractional part of the line width (see set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width) is ignored.

Possible values: 'low'"low""low""low""low""low", 'good'"good""good""good""good""good".

Default: 'low'"low""low""low""low""low".

'background_color'

Sets the background color of the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle. The operator clear_windowclear_windowClearWindowClearWindowClearWindowclear_window uses this color to clear the window.

Possible values: a string containing the color name (e.g., 'black'"black""black""black""black""black", 'red'"red""red""red""red""red").

'window_title'

Allows to change the text in the title bar of an already opened HALCON window.

Possible values: a string containing up to 1023 characters.

'anti_aliasing'

Enables or disables the anti aliasing of contours and regions.

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

Default: 'true'"true""true""true""true""true".

'graphics_stack'

Enables or disables the graphics stack of a window. With activated graphics stack changing the window part with set_partset_partSetPartSetPartSetPartset_part triggers the display of previously displayed objects with respect to the new part. With this it is possible to move or scale the contents of the window. This parameter has no effect on the graphics stack of a HDevelop graphics window.

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

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

'graphics_stack_max_element_num'

Maximum number of elements in the graphics stack. This number corresponds to the number of display operations recorded. This parameter has no effect on the graphics stack of a HDevelop graphics window and is effective not before the next call to a display operator.

Possible values: positive number or 'unlimited'"unlimited""unlimited""unlimited""unlimited""unlimited". Default: 50.

'graphics_stack_max_memory_size'

Limits the memory consumption of the graphics stack. If this limit is exceeded, older display operations are removed from the graphics stack. This parameter has no effect on the graphics stack of a HDevelop graphics window and is effective not before the next call to a display operator.

Possible values: memory limit in bytes or 'unlimited'"unlimited""unlimited""unlimited""unlimited""unlimited".

Default: 'unlimited'"unlimited""unlimited""unlimited""unlimited""unlimited".

Parameters concerning the '3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot""3d_plot" (see set_paintset_paintSetPaintSetPaintSetPaintset_paint):

'angle_of_view'

Set the angle of view of the virtual camera used to display the 3D plot. The angle must be provided in radians and lie within the interval [0,PI). An angle of 0 radians implies orthogonal projection. Another way to choose orthogonal projection is to set 'angle_of_view'"angle_of_view""angle_of_view""angle_of_view""angle_of_view""angle_of_view" to 'orthogonal'"orthogonal""orthogonal""orthogonal""orthogonal""orthogonal".

Possible values: 'orthogonal'"orthogonal""orthogonal""orthogonal""orthogonal""orthogonal" or an angle in radians.

Default: 1.22173 (70 degrees).

'axis_captions'

The axis captions for row, column, and height can be set by passing a tuple containing the strings for the captions in the specified order row, column, and height axis, (e.g., ['row','col','height']). Pass empty strings to display no captions at all.

Possible values: A tuple containing three strings. Each string can contain up to 31 characters.

Default: [' ',' ',' '][" "," "," "][" "," "," "][" "," "," "][" "," "," "][" "," "," "].

'caption_color'

The color of the axis captions for row, column, and height. You can either pass one color for all three axes or a tuple of three colors to set individual colors for each axis.

Possible values: a string or tuple with three strings containing the color name (e.g., 'black'"black""black""black""black""black", 'red'"red""red""red""red""red").

Default: 'black'"black""black""black""black""black".

'plot_quality'

Influences the quality of the 3D plot. Depending on the capabilities of your graphics card better settings for the quality may reduce the frame rate of the 3D plot significantly.

Possible values: 'low'"low""low""low""low""low", 'medium'"medium""medium""medium""medium""medium", 'good'"good""good""good""good""good", 'best'"best""best""best""best""best".

Default: 'medium'"medium""medium""medium""medium""medium".

'scale_plot'

If set to 'true'"true""true""true""true""true" the height values of an image are transformed into the interval [0,255] before display. If set to 'false' the aspect ratio between row/column and height is considered. Images of the type byte, cyclic, or direction are not scaled, i.e. in their cases this parameter is ignored.

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

Default: 'true'"true""true""true""true""true".

'display_grid'

If set to 'true'"true""true""true""true""true" a grid is displayed at height 0.

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

Default: 'true'"true""true""true""true""true".

'display_axes'

If set to 'true'"true""true""true""true""true" coordinate axes are displayed. Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false".

Default: 'true'"true""true""true""true""true".

Attention

The parameters 'anti_aliasing'"anti_aliasing""anti_aliasing""anti_aliasing""anti_aliasing""anti_aliasing", 'flush'"flush""flush""flush""flush""flush", 'graphics_stack'"graphics_stack""graphics_stack""graphics_stack""graphics_stack""graphics_stack", 'graphics_stack_max_element_num'"graphics_stack_max_element_num""graphics_stack_max_element_num""graphics_stack_max_element_num""graphics_stack_max_element_num""graphics_stack_max_element_num", 'graphics_stack_max_memory_size'"graphics_stack_max_memory_size""graphics_stack_max_memory_size""graphics_stack_max_memory_size""graphics_stack_max_memory_size""graphics_stack_max_memory_size", and 'region_quality'"region_quality""region_quality""region_quality""region_quality""region_quality" depend on the library libcanvas, which might not be available on embedded systems.

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window

Possible Successors

disp_imagedisp_imageDispImageDispImageDispImagedisp_image

See also

get_window_paramget_window_paramGetWindowParamGetWindowParamGetWindowParamget_window_param, set_window_attrset_window_attrSetWindowAttrSetWindowAttrSetWindowAttrset_window_attr, set_part_styleset_part_styleSetPartStyleSetPartStyleSetPartStyleset_part_style

Module

Foundation