clear_shape_modelT_clear_shape_modelClearShapeModelClearShapeModelclear_shape_model (Operator)

Name

clear_shape_modelT_clear_shape_modelClearShapeModelClearShapeModelclear_shape_model — Free the memory of a shape model.

Signature

clear_shape_model( : : ModelID : )

Description

The operator clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelclear_shape_model frees the memory of a shape model that was created by create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelcreate_shape_model, create_scaled_shape_modelcreate_scaled_shape_modelCreateScaledShapeModelCreateScaledShapeModelcreate_scaled_shape_model, or create_aniso_shape_modelcreate_aniso_shape_modelCreateAnisoShapeModelCreateAnisoShapeModelcreate_aniso_shape_model. After calling clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelclear_shape_model, the model can no longer be used. The handle ModelIDModelIDModelIDmodelIDmodel_id 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:

ModelIDModelIDModelIDmodelIDmodel_id

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

Parameters

ModelIDModelIDModelIDmodelIDmodel_id (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_modelClearShapeModelClearShapeModelclear_shape_model returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

create_generic_shape_modelcreate_generic_shape_modelCreateGenericShapeModelCreateGenericShapeModelcreate_generic_shape_model, write_shape_modelwrite_shape_modelWriteShapeModelWriteShapeModelwrite_shape_model

Module

Matching

Operators