get_display_scene_3d_infoT_get_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info (Operator)
Name
get_display_scene_3d_infoT_get_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info — Get the depth or the index of instances in a displayed 3D scene.
Signature
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
Hlong HScene3D::GetDisplayScene3dInfo(const HWindow& WindowHandle, double Row, double Column, const wchar_t* Information) const
(Windows only)
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)
def get_display_scene_3d_info(window_handle: HHandle, scene_3d: HHandle, row: MaybeSequence[Union[float, int]], column: MaybeSequence[Union[float, int]], information: MaybeSequence[str]) -> Sequence[Union[int, float]]
def get_display_scene_3d_info_s(window_handle: HHandle, scene_3d: HHandle, row: MaybeSequence[Union[float, int]], column: MaybeSequence[Union[float, int]], information: MaybeSequence[str]) -> Union[int, float]
Description
get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info returns information on the
3D object models in the 3D scene Scene3DScene3DScene3DScene3Dscene3Dscene_3d that have been displayed
with display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3ddisplay_scene_3d in the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle.
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_paramSetScene3dParamSetScene3dParamSetScene3dParamset_scene_3d_param.
- '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_paramSetScene3dParamSetScene3dParamSetScene3dParamset_scene_3d_param.
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_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix or get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix to obtain these
coordinates directly.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Automatically parallelized on internal data level.
Parameters
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
Scene3DScene3DScene3DScene3Dscene3Dscene_3d (input_control) scene_3d → HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the 3D scene.
RowRowRowRowrowrow (input_control) integer(-array) → HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Row coordinates.
ColumnColumnColumnColumncolumncolumn (input_control) integer(-array) → HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column coordinates.
InformationInformationInformationInformationinformationinformation (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (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) → HTupleSequence[Union[int, float]]HTupleHtuple (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_infoGetDisplayScene3dInfoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_info returns TRUE if all parameters are
correct. If necessary, an exception is raised.
Possible Predecessors
display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3ddisplay_scene_3d,
get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton,
get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix,
get_mpositionget_mpositionGetMpositionGetMpositionGetMpositionget_mposition,
get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix
See also
display_scene_3ddisplay_scene_3dDisplayScene3dDisplayScene3dDisplayScene3ddisplay_scene_3d
Module
3D Metrology