Operator Reference

HALCON Operator Reference / Graphics / Parameters

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

ClassesClasses | | Operators

get_window_paramT_get_window_paramGetWindowParamGetWindowParamget_window_param (Operator)

get_window_paramT_get_window_paramGetWindowParamGetWindowParamget_window_param — Get window parameters.

Signature

get_window_param( : : WindowHandle, Param : Value)

Herror T_get_window_param(const Htuple WindowHandle, const Htuple Param, Htuple* Value)

void GetWindowParam(const HTuple& WindowHandle, const HTuple& Param, HTuple* Value)

HTuple HWindow::GetWindowParam(const HString& Param) const

HTuple HWindow::GetWindowParam(const char* Param) const

HTuple HWindow::GetWindowParam(const wchar_t* Param) const   ( Windows only)

static void HOperatorSet.GetWindowParam(HTuple windowHandle, HTuple param, out HTuple value)

HTuple HWindow.GetWindowParam(string param)

def get_window_param(window_handle: HHandle, param: str) -> Sequence[Union[str, float, int]]

def get_window_param_s(window_handle: HHandle, param: str) -> Union[str, float, int]

Description

The operator get_window_paramget_window_paramGetWindowParamGetWindowParamget_window_param allows querying different parameters of an open window. For detailed descriptions of the individual parameters see set_window_paramset_window_paramSetWindowParamSetWindowParamset_window_param.

General window parameters:

'flush'"flush""flush""flush""flush"

'true'"true""true""true""true" if automatic flushing is enabled, 'false'"false""false""false""false" otherwise.

'region_quality'"region_quality""region_quality""region_quality""region_quality"

Quality of the rendering of regions.

'background_color'"background_color""background_color""background_color""background_color"

The background color of the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle.

'window_title'"window_title""window_title""window_title""window_title"

The text in the title bar of the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle.

'anti_aliasing'"anti_aliasing""anti_aliasing""anti_aliasing""anti_aliasing"

'true'"true""true""true""true" if anti aliasing is enabled, 'false'"false""false""false""false" otherwise.

'graphics_stack'"graphics_stack""graphics_stack""graphics_stack""graphics_stack"

'true'"true""true""true""true" if the graphics stack is enabled, 'false'"false""false""false""false" otherwise.

'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"

Maximum number of elements in the graphics stack.

'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"

Maximum memory consumption of the graphics stack.

'pixel_grid_enable'"pixel_grid_enable""pixel_grid_enable""pixel_grid_enable""pixel_grid_enable"

'true'"true""true""true""true" if the pixel grid is enabled for the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle.

'pixel_grid_min_resolution'"pixel_grid_min_resolution""pixel_grid_min_resolution""pixel_grid_min_resolution""pixel_grid_min_resolution"

Minimal required resolution of one pixel in the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle such that the pixel grid becomes visible.

'pixel_grid_color'"pixel_grid_color""pixel_grid_color""pixel_grid_color""pixel_grid_color"

Color of the pixel grid lines.

'pixel_grid_line_width'"pixel_grid_line_width""pixel_grid_line_width""pixel_grid_line_width""pixel_grid_line_width"

Line width of the pixel grid lines.

Parameters concerning the '3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot":

'angle_of_view'"angle_of_view""angle_of_view""angle_of_view""angle_of_view"

The angle of view of the virtual camera used to display the 3D plot.

'axis_captions'"axis_captions""axis_captions""axis_captions""axis_captions"

The captions for row, column, and height axis.

'plot_quality'"plot_quality""plot_quality""plot_quality""plot_quality"

The quality of the 3D plot.

'scale_plot'"scale_plot""scale_plot""scale_plot""scale_plot"

'true'"true""true""true""true" if the height values of an image are transformed into the interval [0,255] before display, 'false'"false""false""false""false" otherwise.

'display_grid'"display_grid""display_grid""display_grid""display_grid"

'true'"true""true""true""true" if the grid is displayed.

'display_axes'"display_axes""display_axes""display_axes""display_axes"

'true'"true""true""true""true" if the coordinate axes are displayed.

Attention

The parameters 'anti_aliasing'"anti_aliasing""anti_aliasing""anti_aliasing""anti_aliasing", 'flush'"flush""flush""flush""flush", '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_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" 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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

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

Name of the parameter.

Default: 'flush' "flush" "flush" "flush" "flush"

List of values: 'angle_of_view'"angle_of_view""angle_of_view""angle_of_view""angle_of_view", 'axis_captions'"axis_captions""axis_captions""axis_captions""axis_captions", 'background_color'"background_color""background_color""background_color""background_color", 'display_axes'"display_axes""display_axes""display_axes""display_axes", 'display_grid'"display_grid""display_grid""display_grid""display_grid", 'flush'"flush""flush""flush""flush", '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_memory_size'"graphics_stack_max_memory_size""graphics_stack_max_memory_size""graphics_stack_max_memory_size""graphics_stack_max_memory_size", 'pixel_grid_color'"pixel_grid_color""pixel_grid_color""pixel_grid_color""pixel_grid_color", 'pixel_grid_enable'"pixel_grid_enable""pixel_grid_enable""pixel_grid_enable""pixel_grid_enable", 'pixel_grid_line_width'"pixel_grid_line_width""pixel_grid_line_width""pixel_grid_line_width""pixel_grid_line_width", 'pixel_grid_min_resolution'"pixel_grid_min_resolution""pixel_grid_min_resolution""pixel_grid_min_resolution""pixel_grid_min_resolution", 'plot_quality'"plot_quality""plot_quality""plot_quality""plot_quality", 'region_quality'"region_quality""region_quality""region_quality""region_quality", 'scale_plot'"scale_plot""scale_plot""scale_plot""scale_plot", 'window_title'"window_title""window_title""window_title""window_title"

ValueValueValuevaluevalue (output_control)  string(-array) → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

Value of the parameter.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

Possible Successors

set_window_paramset_window_paramSetWindowParamSetWindowParamset_window_param

See also

get_window_attrget_window_attrGetWindowAttrGetWindowAttrget_window_attr, get_part_styleget_part_styleGetPartStyleGetPartStyleget_part_style

Module

Foundation

---

ClassesClasses | | Operators