ClassesClasses | | Operators

get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfo (Operator)

Name

get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfo — Get the depth or the index of instances in a displayed 3D scene.

Signature

get_display_scene_3d_info( : : WindowHandle, Scene3D, Row, Column, Information : Value)

Herror get_display_scene_3d_info(const Hlong WindowHandle, const Hlong Scene3D, double Row, double Column, const char* Information, Hlong* Value)

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

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

HTuple HScene3D::GetDisplayScene3dInfo(const HWindow& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Information) const

Hlong HScene3D::GetDisplayScene3dInfo(const HWindow& WindowHandle, double Row, double Column, const HString& Information) const

Hlong HScene3D::GetDisplayScene3dInfo(const HWindow& WindowHandle, double Row, double Column, const char* Information) const

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

HTuple HScene3D.GetDisplayScene3dInfo(HWindow windowHandle, HTuple row, HTuple column, HTuple information)

int HScene3D.GetDisplayScene3dInfo(HWindow windowHandle, double row, double column, string information)

Description

get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoGetDisplayScene3dInfo returns information on the 3D object models in the 3D scene Scene3DScene3DScene3DScene3Dscene3D that have been displayed with display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3d 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, the parameter 'object_index_persistence'"object_index_persistence""object_index_persistence""object_index_persistence""object_index_persistence" must have been set to 'true'"true""true""true""true" with set_scene_3d_paramset_scene_3d_paramSetScene3dParamSetScene3dParamSetScene3dParam.

'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, the parameter 'depth_persistence'"depth_persistence""depth_persistence""depth_persistence""depth_persistence" must have been set to 'true'"true""true""true""true" with set_scene_3d_paramset_scene_3d_paramSetScene3dParamSetScene3dParamSetScene3dParam.

The window coordinates RowRowRowRowrow, ColumnColumnColumnColumncolumn must be provided with 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 (integer) (IntPtr) (Hlong) (Hlong)

Window handle.

Scene3DScene3DScene3DScene3Dscene3D (input_control)  scene_3d HScene3D, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the 3D scene.

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_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoGetDisplayScene3dInfo returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3d, get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPix, get_mpositionget_mpositionGetMpositionGetMpositionGetMposition, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix

See also

display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3d

Module

3D Metrology


ClassesClasses | | Operators