ClassesClassesClassesClasses | | | | Operators

get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfo (Operator)

Name

get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoget_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)

Herror get_display_scene_3d_info(const HTuple& WindowHandle, const HTuple& Scene3D, const HTuple& Row, const HTuple& Column, const HTuple& Information, Hlong* Value)

Herror get_display_scene_3d_info(const HTuple& WindowHandle, const HTuple& Scene3D, const HTuple& Row, const HTuple& Column, const HTuple& Information, HTuple* Value)

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

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

void HOperatorSetX.GetDisplayScene3dInfo(
[in] VARIANT WindowHandle, [in] VARIANT Scene3D, [in] VARIANT Row, [in] VARIANT Column, [in] VARIANT Information, [out] VARIANT* Value)

VARIANT HScene3DX.GetDisplayScene3dInfo(
[in] IHWindowX* WindowHandle, [in] VARIANT Row, [in] VARIANT Column, [in] VARIANT Information)

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_infoGetDisplayScene3dInfoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfo returns information on the 3D object models in the 3D scene Scene3DScene3DScene3DScene3DScene3Dscene3D that have been displayed with display_scene_3ddisplay_scene_3dDisplayScene3ddisplay_scene_3dDisplayScene3dDisplayScene3d in the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The requested information at the positions (RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn) is returned in ValueValueValueValueValuevalue.

The following values can be queried via InformationInformationInformationInformationInformationinformation:

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

The indices of the 3D object models that have been displayed at the positions (RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn). 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""object_index_persistence" must have been set to 'true'"true""true""true""true""true" with set_scene_3d_paramset_scene_3d_paramSetScene3dParamset_scene_3d_paramSetScene3dParamSetScene3dParam.

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

The depth (i.e. the Z coordinate in the camera coordinate system) at the positions (RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn). 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""depth_persistence" must have been set to 'true'"true""true""true""true""true" with set_scene_3d_paramset_scene_3d_paramSetScene3dParamset_scene_3d_paramSetScene3dParamSetScene3dParam.

The window coordinates RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn 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_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix or get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix to obtain these coordinates directly.

Parallelization

Parameters

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

Window handle.

Scene3DScene3DScene3DScene3DScene3Dscene3D (input_control)  scene_3d HScene3D, HTupleHTupleHScene3D, HTupleHScene3DX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the 3D scene.

RowRowRowRowRowrow (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

Row coordinates.

ColumnColumnColumnColumnColumncolumn (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

Column coordinates.

InformationInformationInformationInformationInformationinformation (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Information.

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

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

ValueValueValueValueValuevalue (output_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double) (Hlong / double) (Hlong / double)

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

Result

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

Possible Predecessors

display_scene_3ddisplay_scene_3dDisplayScene3ddisplay_scene_3dDisplayScene3dDisplayScene3d, get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix

See also

display_scene_3ddisplay_scene_3dDisplayScene3ddisplay_scene_3dDisplayScene3dDisplayScene3d

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators