clear_shape_modelT_clear_shape_modelClearShapeModelClearShapeModel (Operator)

Name

clear_shape_modelT_clear_shape_modelClearShapeModelClearShapeModel — Free the memory of a shape model.

Signature

clear_shape_model( : : ModelID : )

Description

The operator clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelClearShapeModel frees the memory of a shape model that was created by create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel. After calling clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelClearShapeModel, the model can no longer be used. The handle ModelIDModelIDModelIDModelIDmodelID 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:

ModelIDModelIDModelIDModelIDmodelID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified) shape_model → (handle)

Handle of the model.

Result

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

Possible Predecessors

create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelCreateScaledShapeModel, create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelCreateAnisoShapeModel, read_shape_modelread_shape_modelReadShapeModelReadShapeModelReadShapeModel, write_shape_modelwrite_shape_modelWriteShapeModelWriteShapeModelWriteShapeModel

Module

Matching

Operators