| MIL 10 Reference
| Customize Help
| Save Settings

M3dmapRestore


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux with restrictions

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
M3dmapPut
M3dmapSave
Synopsis
Restore a 3D reconstruction context or geometry object from disk.
Syntax
MIL_ID M3dmapRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ContextOrGeometry3dmapIdPtr //out
)
Description

This function restores a 3D reconstruction context or geometry object that was previously saved to a file, using M3dmapSave() or M3dmapStream(). This function restores all of the context or 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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
FileName

Specifies the name and directory of the file from which to restore the 3D reconstruction context or geometry 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
CollapseValue Description
Collapse 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.
Collapse MIL_TEXT("FileName") 1

Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile").

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 reconstruction context or geometry object.

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

function map For specifying the system identifier
CollapseValue Description
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse MIL system identifier

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

Reserved for future expansion and must be set to M_DEFAULT.

ContextOrGeometry3dmapIdPtr

Specifies the address of the variable in which to write the 3D reconstruction context or geometry object identifier. Since this function also returns the 3D reconstruction context or geometry 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 reconstruction context or geometry 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