| Customize Help
| Save Settings

M3dmapRestore


Function Map
Syntax
Description
Parameters
- FileName
Table: For specifying the file name and path
- SysId
Table: For specifying the system identifier
- ControlFlag
- M3dmapIdPtr
Return value
Compilation information
Synopsis
Restore a 3D object from disk.
Syntax
MIL_ID M3dmapRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *M3dmapIdPtr //out
)
Description

This function restores a 3D object that was previously saved to a file, using M3dmapSave() or M3dmapStream(). You can only restore a 3D reconstruction context or a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT.

This function restores all of the object's settings that were in effect when the object was saved. A restored 3D reconstruction context is ready to use, with no need to perform any calibration step.

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
FileName

Specifies the name and directory of the file from which to restore the 3D object. The function handles (internally) the opening and closing of the file.

This parameter can be set to one of the following:

function map For specifying the file name and path
Click to summarizeValue Description
Click to summarize M_INTERACTIVE
[This is only applicable to Windows]

Opens the File Open dialog box from which you can interactively specify the drive, directory, and name of the file.
Click to summarize MIL_TEXT("FileName") 1

Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Typically, 3D object files have an M3D file extension.

To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile").

(summarize)

1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().

SysId

Specifies the system on which to restore the 3D object.

This parameter should be set to one of the following values:

function map For specifying the system identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

M3dmapIdPtr

Specifies the address of the variable in which to write the 3D object identifier. Since this function also returns the 3D object identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value
The returned value is the 3D object identifier. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3dmap.lib.
DLL Requires mil.dll; mil3dmap.dll.
INTERACTIVE DEFAULT HOST