ClassesClasses | | Operators

get_disp_object_model_3d_infoT_get_disp_object_model_3d_infoGetDispObjectModel3dInfoGetDispObjectModel3dInfo (Operator)

Name

get_disp_object_model_3d_infoT_get_disp_object_model_3d_infoGetDispObjectModel3dInfoGetDispObjectModel3dInfo — Get the depth or the index of a displayed 3D object model.

Signature

get_disp_object_model_3d_info( : : WindowHandle, Row, Column, Information : Value)

Herror T_get_disp_object_model_3d_info(const Htuple WindowHandle, const Htuple Row, const Htuple Column, const Htuple Information, Htuple* Value)

void GetDispObjectModel3dInfo(const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Information, HTuple* Value)

static HTuple HObjectModel3D::GetDispObjectModel3dInfo(const HWindow& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Information)

static Hlong HObjectModel3D::GetDispObjectModel3dInfo(const HWindow& WindowHandle, double Row, double Column, const HString& Information)

static Hlong HObjectModel3D::GetDispObjectModel3dInfo(const HWindow& WindowHandle, double Row, double Column, const char* Information)

static void HOperatorSet.GetDispObjectModel3dInfo(HTuple windowHandle, HTuple row, HTuple column, HTuple information, out HTuple value)

static HTuple HObjectModel3D.GetDispObjectModel3dInfo(HWindow windowHandle, HTuple row, HTuple column, HTuple information)

static int HObjectModel3D.GetDispObjectModel3dInfo(HWindow windowHandle, double row, double column, string information)

Description

get_disp_object_model_3d_infoget_disp_object_model_3d_infoGetDispObjectModel3dInfoGetDispObjectModel3dInfoGetDispObjectModel3dInfo returns information on the 3D object models that have been displayed with disp_object_model_3ddisp_object_model_3dDispObjectModel3dDispObjectModel3dDispObjectModel3d in the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The requested information at the positions (RowRowRowRowrow, ColumnColumnColumnColumncolumn) is returned in ValueValueValueValuevalue.

The following values can be queried via InformationInformationInformationInformationinformation:

'object_index'"object_index""object_index""object_index""object_index"

The indices of the 3D object models that have been displayed at the positions (RowRowRowRowrow, ColumnColumnColumnColumncolumn). If no 3D object model was displayed at this position, -1 is returned. In order to retrieve this information, disp_object_model_3ddisp_object_model_3dDispObjectModel3dDispObjectModel3dDispObjectModel3d must have been called with the generic parameter 'object_index_persistence'"object_index_persistence""object_index_persistence""object_index_persistence""object_index_persistence" set to 'true'"true""true""true""true".

'depth'"depth""depth""depth""depth"

The depth (i.e. the Z coordinate in the camera coordinate system) at the positions (RowRowRowRowrow, ColumnColumnColumnColumncolumn). If no 3D object model was displayed at one of these positions, -1.0 is returned for this position. In order to retrieve this information, disp_object_model_3ddisp_object_model_3dDispObjectModel3dDispObjectModel3dDispObjectModel3d must have been called with the generic parameter 'depth_persistence'"depth_persistence""depth_persistence""depth_persistence""depth_persistence" set to 'true'"true""true""true""true".

The window coordinates RowRowRowRowrow, ColumnColumnColumnColumncolumn must be provided in respect to the current image part. As a consequence, these coordinates are subpixel coordinates. Given the current image part (row1,column1,row2, column2), the upper left corner corresponds to the coordinates (row1 - 0.5, col1 - 0.5). Accordingly, the bottom right corner corresponds to the coordinates (row2 - 0.5, col2 - 0.5). Use get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix or get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPix to obtain these coordinates directly.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RowRowRowRowrow (input_control)  integer(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinates.

ColumnColumnColumnColumncolumn (input_control)  integer(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinates.

InformationInformationInformationInformationinformation (input_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Information.

Default value: 'depth' "depth" "depth" "depth" "depth"

List of values: 'depth'"depth""depth""depth""depth", 'object_index'"object_index""object_index""object_index""object_index"

ValueValueValueValuevalue (output_control)  integer(-array) HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Indices or the depth of the objects at (Row,Column).

Result

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

Possible Predecessors

disp_object_model_3ddisp_object_model_3dDispObjectModel3dDispObjectModel3dDispObjectModel3d, get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPix, get_mpositionget_mpositionGetMpositionGetMpositionGetMposition, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix

See also

disp_object_model_3ddisp_object_model_3dDispObjectModel3dDispObjectModel3dDispObjectModel3d

Module

3D Metrology


ClassesClasses | | Operators