| Customize Help
| Save Settings

M3dmapCopy



Function Map
Synopsis
Copy one or more point clouds from one M_POINT_CLOUD_RESULT result buffer to another.
Syntax
void M3dmapCopy(
MIL_ID SrcResult3dmapId, //in
MIL_INT SrcLabelOrIndex, //in
MIL_ID DstResult3dmapId, //in
MIL_INT DstLabel, //in
MIL_INT64 Operation, //in
MIL_INT64 ControlFlag //in
)
Description

This function copies or moves one or more point clouds from a source M_POINT_CLOUD_RESULT result buffer to a destination M_POINT_CLOUD_RESULT result buffer.

When copying/moving a specific point cloud, you must specify the label to assign it in the destination result buffer (using DstLabel); the label cannot already be assigned to an existing point cloud in the destination result buffer. If copying/moving all point clouds in the source result buffer (M_ALL), the destination result buffer must be empty; the copied/moved point clouds retain their original labels.

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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
SrcResult3dmapId

Specifies the identifier of the 3D reconstruction result buffer containing the source point clouds to copy/move. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult() with M_POINT_CLOUD_RESULT.

SrcLabelOrIndex

Specifies the point cloud(s) to copy/move from the source M_POINT_CLOUD_RESULT result buffer.

function map For specifying the label or index of a specific source point cloud
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_ALL.

Click to summarize

Specifies an existing point cloud with the given index.

(summarize)
Parameters

Specifies the index of an existing point cloud.

Click to summarize

Specifies an existing point cloud with the given label.

(summarize)
Parameters

Specifies the label of an existing point cloud.

Click to summarize M_ALL

Specifies all point clouds in the source M_POINT_CLOUD_RESULT result buffer.

DstResult3dmapId

Specifies the identifier of the 3D reconstruction result buffer in which to copy/move the source point cloud(s). The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult() with M_POINT_CLOUD_RESULT. You can specify the same identifier as the SrcResult3dmapId identifier, but the label to assign the copied/moved point cloud must be different.

DstLabel

Specifies a new label in the destination M_POINT_CLOUD_RESULT result buffer in which to copy/move the source point cloud(s).

If SrcLabelOrIndex is set to M_ALL and the source result buffer contains more than one point cloud, the DstLabel parameter also must be set to M_ALL. In this case, the copied/moved point clouds retain their original source labeling.

function map For specifying the label in the destination result buffer
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_ALL.

Click to summarize

Specifies the label to assign the specific point cloud in the destination buffer. This point cloud should not already exist in the destination result buffer.

(summarize)
Parameters

Specifies the label for a point cloud.

Click to summarize M_ALL

Specifies all labels in the destination M_POINT_CLOUD_RESULT result buffer, which should not contain any point clouds.

Operation

Specifies the type of operation to perform. This parameter should be set to one of the following values:

function map For specifying the type of operation to perform
Click to summarizeValue Description
Click to summarize M_COPY +

Specifies the point cloud is copied to the destination M_POINT_CLOUD_RESULT result buffer; the point cloud is not deleted from the source M_POINT_CLOUD_RESULT result buffer.

Note that the specified point cloud retains its organizational type when copied, unless only valid points are copied (M_EXCLUDE_INVALID_POINTS).

(summarize)
Click to summarize M_MOVE

Specifies the point cloud is moved to the destination M_POINT_CLOUD_RESULT result buffer; the point cloud is deleted from the source M_POINT_CLOUD_RESULT result buffer. This operation is faster than copying.

Any point cloud moved using M3dmapCopy() retains its organizational type.

(summarize)
Combination value for M_COPY.

You can add the following value to the above-mentioned value to specify to exclude invalid points.

function map For specifying whether to exclude invalid points
Click to summarizeCombination value Description
Click to summarize M_EXCLUDE_INVALID_POINTS

Specifies to exclude all points in the specified M_POINT_CLOUD_RESULT result buffer that are set to M_INVALID_POINT. Only the valid points will be copied.

(summarize)
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information
Header Include mil.h.
Library Use mil.lib; mil3dmap.lib.
DLL Requires mil.dll; mil3dmap.dll.
DEFAULT NUMBER OF POINT CLOUDS ALL DEFAULT ALL COPY MOVE EXCLUDE INVALID POINTS