| MIL 10 Reference
| Customize Help
| Save Settings

MmodPreprocess



See also
Availability
Not 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
Available on Matrox Supersight
function map Function map
Examples
Synopsis
Preprocess a Model Finder context.
Syntax
void MmodPreprocess(
MIL_ID ContextId, //in
MIL_INT64 ControlFlag //in
)
Description

This function preprocesses the specified Model Finder context. It extracts the active edges of the models contained within the Model Finder context and sets internal search settings so that future searches will be optimized for speed and robustness. The procedure is potentially quite lengthy (up to a few seconds) and increases the size of the Model Finder context significantly.

This function must be called before performing the first MmodFind() search. Call this function after all search settings have been set. When you save the Model Finder context, the model's preprocessing changes are not stored with the model. Upon restoration, the model must be preprocessed again.

Note that if some of the model's search settings are changed after a call to MmodPreprocess(), the model must be preprocessed again. To inquire if your model is in a preprocessed state, use MmodInquire() with M_PREPROCESSED (this value must be true to perform an MmodFind() search).

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
ContextId

Specifies the Model Finder context of the model to preprocess. The Model Finder context must have been previously allocated on the system using MmodAlloc().

ControlFlag

Specifies whether to perform or undo the preprocessing of the model context. Set this parameter to one of the following values:

function map For specifying whether to perform preprocessing
CollapseValue Description
Collapse M_DEFAULT

Performs the preprocessing of the model context.

Collapse M_RESET

Undoes preprocessing.

Undoing preprocessing can be useful if you want to conserve computer memory within an application and preserve Model Finder context settings.

(summarize)
Compilation information
Header Include mil.h.
Library Use mil.lib; milmod.lib.
DLL Requires mil.dll; milmod.dll.
DEFAULT RESET