M3ddispSelectWindow

See also

User Guide:

3D display and graphics overview 3D graphics lists Annotating the 3D display Color and display settings for 3D data Steps to display 3D data

Reference:

M3ddispAlloc M3ddispSelect M3dgraAdd M3dgraRemove MbufInquireContainer

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

- Disp3dId

- ContainerOrImageBufId

Table:

For specifying the container identifier

- Option

Table:

For specifying the operation to perform

- ControlFlag

- ClientWindowHandle

Return value

Compilation information

Synopsis

Select a 3D container to display in a user-defined window.

Syntax

MIL_INT64 M3ddispSelectWindow(

MIL_ID Disp3dId,	//in
MIL_ID ContainerOrImageBufId,	//in
MIL_INT64 Option,	//in
MIL_INT64 ControlFlag,	//in
MIL_WINDOW_HANDLE ClientWindowHandle	//in

)

Description

This function outputs the 3D content of the specified container or fully-corrected depth map image buffer to the specified user-defined window, using the specified MIL 3D display. This function also optionally opens or closes the MIL 3D display, or removes a specified container or image buffer previously selected to the 3D display.

If the 3D display is shown or closed, the user-defined window is left open but blank.

The container or image buffer is associated with a point cloud 3D graphic, which is added to the 3D display's internal 3D graphics list.

Any subsequent changes made to the image buffer, or components of the container, will be shown in the 3D display. The container will not be shown when it does not contain correctly formatted 3D content. You can determine whether a container is currently 3D-displayable using MbufInquireContainer() with M_3D_DISPLAYABLE.

By default, this function removes any containers or image buffers already selected to the 3D display. To show multiple containers or image buffers in the 3D display simultaneously, you can either specify the M_ADD option, or use M3dgraAdd(). To remove only a single container or image buffer from the 3D display, specify the M_REMOVE option, or use M3dgraRemove().

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

Disp3dId

Specifies the identifier of the 3D display, previously allocated using M3ddispAlloc().

ContainerOrImageBufId

Specifies the MIL identifier of the 3D-displayable container, or fully corrected depth map image buffer, to display.

Note that the container or image buffer and the 3D display should be allocated on the same system.

For specifying the container identifier
Value	Description
M_NULL	Specifies no container or image buffer.
3D-displayable MIL container identifier	Specifies the MIL identifier of the 3D-displayable container to add or remove from the specified 3D display's internal 3D graphics list. You can inquire whether a container is 3D-displayable using MbufInquireContainer() with M_3D_DISPLAYABLE. If the container is only 3D-displayable with compensation, MIL will perform an internal conversion each time the container is modified. For maximum performance, you should convert the container to a format that is natively 3D-displayable (using MbufConvert3d() with a destination container that has the attribute M_DISP). (summarize) Specifies the MIL identifier of the 3D-displayable container to add or remove from the specified 3D display's internal 3D graphics list. (more details...)
Empty MIL container identifier	Specifies the MIL identifier of an empty container with the M_DISP attribute to add or remove from the specified 3D display's internal 3D graphics list. This is useful with a container into which you will subsequently grab 3D data. (summarize) Specifies the MIL identifier of an empty container with the M_DISP attribute to add or remove from the specified 3D display's internal 3D graphics list. (more details...)
Image buffer identifier	Specifies the MIL identifier of a fully-corrected depth map image buffer, with the M_DISP attribute, to add or remove from the specified 3D display's internal 3D graphics list. This image buffer will be displayed as a point cloud. (summarize) Specifies the MIL identifier of a fully-corrected depth map image buffer, with the M_DISP attribute, to add or remove from the specified 3D display's internal 3D graphics list. (more details...)

Option

Specifies the action to perform on the specified 3D display.

For specifying the operation to perform
Value	Description
M_DEFAULT	Same as M_SELECT.
M_ADD	Specifies to add the specified container to the 3D display's internal 3D graphics list. An error will be generated if the specified container or image buffer is already associated with a 3D graphic in the 3D display's internal 3D graphics list. (summarize) Specifies to add the specified container to the 3D display's internal 3D graphics list. (more details...)
M_CLOSE	Specifies to close the window. An error will be generated if ContainerOrImageBufId is not set to M_NULL. (summarize) Specifies to close the window. (more details...)
M_OPEN	Specifies to show the window. An error is generated if ContainerOrImageBufId is not set to M_NULL. (summarize) Specifies to show the window. (more details...)
M_REMOVE	Specifies to remove the specified container or image buffer from the 3D display's internal 3D graphics list. An error is generated if the specified container or image buffer is not associated with a 3D graphic in the internal 3D graphics list. If ContainerOrImageBufId is set to M_NULL, all containers and image buffers are removed from the 3D display's internal 3D graphics list. (summarize) Specifies to remove the specified container or image buffer from the 3D display's internal 3D graphics list. (more details...)
M_SELECT	Specifies to add the specified container or image buffer to the 3D display's internal 3D graphics list, remove all other containers from the internal 3D graphics list, and show the window. If ContainerOrImageBufId is set to M_NULL, all containers are removed from the 3d display's internal 3D graphics list, and the window is closed. (summarize) Specifies to add the specified container or image buffer to the 3D display's internal 3D graphics list, remove all other containers from the internal 3D graphics list, and show the window. (more details...)

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ClientWindowHandle

Specifies the window handle of the user-defined window or child window. This window must have a window handle of type HWND or X11. For example, the Windows API functions can create a window with an HWND handle, and third-party functions (like Qt) can create an X11 window handle. If this parameter is set to zero, this function behaves like M3ddispSelect().

Set this parameter to M_NULL if ContainerOrImageBufId is set to M_NULL.

Return value

Returns the label of the point cloud container added to the 3D graphics list of the 3D display.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; mil3d.lib.
DLL	Requires mil.dll; mil3d.dll.