| Customize Help
| Save Settings

M3ddispSelect



Function Map
Synopsis
Add or remove a 3D-displayable container or fully-corrected depth map image buffer to/from the 3D display, and/or open or close the window associated with the 3D display.
Syntax
MIL_INT64 M3ddispSelect(
MIL_ID Disp3dId, //in
MIL_ID ContainerOrImageBufId, //in
MIL_INT64 Option, //in
MIL_INT64 ControlFlag //in
)
Description

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

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.

function map For specifying the container or image buffer identifier
Click to summarizeValue Description
Click to summarize M_NULL

Specifies no container or image buffer.

Click to summarize 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)
Click to summarize 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)
Click to summarize 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)
Option

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

function map For specifying the operation to perform
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_SELECT.

Click to summarize 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)
Click to summarize M_CLOSE

Specifies to close the window. An error will be generated if ContainerOrImageBufId is not set to M_NULL.

(summarize)
Click to summarize M_OPEN

Specifies to show the window. An error is generated if ContainerOrImageBufId is not set to M_NULL.

(summarize)
Click to summarize 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)
Click to summarize 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)
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

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.
NULL FALSE UNSIGNED TRUE DISP NONE DEFAULT ADD CLOSE OPEN REMOVE SELECT NULL