All Frameworks  Class Hierarchy  This Framework  Indexes

SPAds Global Function DM_rm_patch

void DM_rm_patch(	int&	`rtn_err`,
	DS_dmod*	`dmod`,
	int	`tag_flag`,
	SDM_options*	`sdmo`	`=NULL`)

Removes and deletes a patch from a target deformable modeling hierarchy.

Role: Removes the deformable model identified by the tag_flag and all its children from the deformable modeling patch hierarchy. The deformable model identified by tag_flag must be a patch in the deformable modeling hierarchy. It can not be a root level deformable model.

After executing, this function sets the deformable modeling hierarchy's active patch to be the parent of the removed patch.

Errors:

DM_NULL_INPUT_PTR: The deformable model cannot be NULL on entry.

Effect: Changes model

Parameters:

rtn_err: out: 0=success or negative err code.
dmod: in: member of target dmod hierarchy.
tag_flag: in: specify the tgt_dmod to remove 1 = active dmod 2 = member dmod with tag=tag_flag.
sdmo: in:SDM_options pointer note: sets active dmod note: also always removes offspring.

This object is included in the file: dmapi.hxx