Skip to content

clear_shape_modelClearShapeModelClearShapeModelclear_shape_modelT_clear_shape_model🔗

Short description🔗

clear_shape_modelClearShapeModelClearShapeModelclear_shape_modelT_clear_shape_model — Free the memory of a shape model.

Signature🔗

clear_shape_model( shape_model ModelID )void ClearShapeModel( const HTuple& ModelID )static void HOperatorSet.ClearShapeModel( HTuple modelID )def clear_shape_model( model_id: HHandle ) -> None

Herror T_clear_shape_model( const Htuple ModelID )

void HShapeModel::ClearShapeModel( ) const

void HShapeModel.ClearShapeModel( )

Description🔗

The operator clear_shape_modelClearShapeModel frees the memory of a shape model that was created by create_shape_modelCreateShapeModel, create_scaled_shape_modelCreateScaledShapeModel, or create_aniso_shape_modelCreateAnisoShapeModel. After calling clear_shape_modelClearShapeModel, the model can no longer be used. The handle ModelIDmodelIDmodel_id becomes invalid.

Execution information🔗

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:

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

Parameters🔗

ModelIDmodelIDmodel_id (input_control, state is modified) shape_model → (handle)HTuple (HHandle)HShapeModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_generic_shape_modelCreateGenericShapeModel, write_shape_modelWriteShapeModel

Module🔗

Matching