ClassesClassesClassesClasses | | | | Operators

get_window_paramT_get_window_paramGetWindowParamget_window_paramGetWindowParamGetWindowParam (Operator)

Name

get_window_paramT_get_window_paramGetWindowParamget_window_paramGetWindowParamGetWindowParam — Get window parameters.

Signature

get_window_param( : : WindowHandle, Param : Value)

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

Herror get_window_param(const HTuple& WindowHandle, const HTuple& Param, HTuple* Value)

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

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

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

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

void HOperatorSetX.GetWindowParam(
[in] VARIANT WindowHandle, [in] VARIANT Param, [out] VARIANT* Value)

VARIANT HWindowX.GetWindowParam([in] BSTR Param)

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

HTuple HWindow.GetWindowParam(string param)

Description

The operator get_window_paramget_window_paramGetWindowParamget_window_paramGetWindowParamGetWindowParam allows to query different parameters of an open window. For detailed descriptions of the individual parameters see set_window_paramset_window_paramSetWindowParamset_window_paramSetWindowParamSetWindowParam.

General window parameters:

'background_color'

The background color of the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle.

'window_title'

The text in the title bar of the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle.

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

'angle_of_view'

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

'axis_captions'

The captions for row, column, and height axis.

'interactive_plot'

'true'"true""true""true""true""true" if the interactive plot mode is activated, 'false'"false""false""false""false""false" otherwise.

'plot_quality'

The quality of the 3D plot.

'save_depth_buffer'

'true'"true""true""true""true""true" if the depth information generated by the 3D plot is saved after each call to disp_objdisp_objDispObjdisp_objDispObjDispObj, 'false'"false""false""false""false""false" otherwise.

'scale_plot'

'true'"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""false" otherwise.

'display_grid'

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

'display_axes'

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

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window identifier.

ParamParamParamParamParamparam (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the parameter.

Default value: 'save_depth_buffer' "save_depth_buffer" "save_depth_buffer" "save_depth_buffer" "save_depth_buffer" "save_depth_buffer"

List of values: 'angle_of_view'"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""axis_captions", 'background_color'"background_color""background_color""background_color""background_color""background_color", 'display_axes'"display_axes""display_axes""display_axes""display_axes""display_axes", 'display_grid'"display_grid""display_grid""display_grid""display_grid""display_grid", 'interactive_plot'"interactive_plot""interactive_plot""interactive_plot""interactive_plot""interactive_plot", 'plot_quality'"plot_quality""plot_quality""plot_quality""plot_quality""plot_quality", 'save_depth_buffer'"save_depth_buffer""save_depth_buffer""save_depth_buffer""save_depth_buffer""save_depth_buffer", 'scale_plot'"scale_plot""scale_plot""scale_plot""scale_plot""scale_plot", 'window_title'"window_title""window_title""window_title""window_title""window_title"

ValueValueValueValueValuevalue (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Value of the parameter.

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

Possible Successors

set_window_paramset_window_paramSetWindowParamset_window_paramSetWindowParamSetWindowParam

See also

get_window_attrget_window_attrGetWindowAttrget_window_attrGetWindowAttrGetWindowAttr

Module

Foundation


ClassesClassesClassesClasses | | | | Operators