clear_object_model_3dT_clear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d (Operator)

Name

clear_object_model_3dT_clear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d — Free the memory of a 3D object model.

Signature

clear_object_model_3d( : : ObjectModel3D : )

Description

The operator clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d frees the memory of a 3D object model that was previously created. After calling clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d, the model can no longer be used. The handle ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d becomes invalid.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (input_control, state is modified) object_model_3d(-array) → (handle)

Handle of the 3D object model.

Result

If the handle of the model is valid, the operator clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

read_object_model_3dread_object_model_3dReadObjectModel3dReadObjectModel3dread_object_model_3d, xyz_to_object_model_3dxyz_to_object_model_3dXyzToObjectModel3dXyzToObjectModel3dxyz_to_object_model_3d

Module

3D Metrology

Operators