get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_infoT_get_display_scene_3d_info
Short description
get_display_scene_3d_infoget_display_scene_3d_infoGetDisplayScene3dInfoGetDisplayScene3dInfoget_display_scene_3d_infoT_get_display_scene_3d_info — Get the depth or the index of instances in a displayed 3D scene.
Signature
get_display_scene_3d_info( window WindowHandle, scene_3d Scene3D, integer Row, integer Column, string Information, out integer Value )get_display_scene_3d_info( : : WindowHandle, Scene3D, Row, Column, Information : Value )void GetDisplayScene3dInfo( const HTuple& WindowHandle, const HTuple& Scene3D, const HTuple& Row, const HTuple& Column, const HTuple& Information, HTuple* Value )static void HOperatorSet.GetDisplayScene3dInfo( HTuple windowHandle, HTuple scene3D, HTuple row, HTuple column, HTuple information, out HTuple value )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]Herror T_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 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)
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_infoGetDisplayScene3dInfo returns information on the
3D object models in the 3D scene Scene3Dscene3Dscene_3d that have been displayed
with display_scene_3dDisplayScene3d in the window WindowHandlewindowHandlewindow_handle.
The requested information at the positions (Rowrowrow, Columncolumncolumn)
is returned in Valuevaluevalue.
The following values can be queried via Informationinformationinformation:
-
'object_index'"object_index"
The indices of the 3D object models that have been displayed at the
positions (Rowrowrow, Columncolumncolumn).
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" must have been set to 'true'"true"
with set_scene_3d_paramSetScene3dParam.
-
'depth'"depth"
The depth (i.e. the Z coordinate in the camera coordinate system) at the
positions (Rowrowrow, Columncolumncolumn). 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" must have been set to 'true'"true"
with set_scene_3d_paramSetScene3dParam.
The window coordinates Rowrowrow, Columncolumncolumn 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_pixGetMpositionSubPix or get_mbutton_sub_pixGetMbuttonSubPix 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
WindowHandlewindowHandlewindow_handle (input_control) window → (handle)(handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)
Window handle.
Scene3Dscene3Dscene_3d (input_control) scene_3d → (handle)(handle)HTuple (HHandle)HScene3D, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the 3D scene.
Rowrowrow (input_control) integer(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Row coordinates.
Columncolumncolumn (input_control) integer(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Column coordinates.
Informationinformationinformation (input_control) string(-array) → (string)(string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)
Information.
Default: 'depth'"depth"
List of values: 'depth', 'object_index'"depth", "object_index"
Valuevaluevalue (output_control) integer(-array) → (integer / real)(integer / real)HTuple (Hlong / double)HTuple (int / long / double)Sequence[Union[int, float]]Htuple (Hlong / double)
Indices or the depth of the objects at (Row,Column).
Result
get_display_scene_3d_infoGetDisplayScene3dInfo returns 2 (H_MSG_TRUE) if all parameters are
correct. If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
display_scene_3dDisplayScene3d, get_mbuttonGetMbutton, get_mbutton_sub_pixGetMbuttonSubPix, get_mpositionGetMposition, get_mposition_sub_pixGetMpositionSubPix
See also
display_scene_3dDisplayScene3d
Module
3D Metrology