All Frameworks  Class Hierarchy  This Framework  Indexes

SPAds Global Function DM_set_tan_display_gain

void DM_set_tan_display_gain(	int&	`rtn_err`,
	DS_dmod*	`dmod`,
	double	`tan_display_gain`	`=1.0`,
	int	`walk_flag`	`=0`,
	SDM_options*	`sdmo`	`=NULL`)

Sets display gain for the deformable model's tangent vectors and returns 0 for success or an error.

Role: Modifies the deformable model dmo_tan_display_gain and sets the active deformable model.

Sets the displacement gain for the target deformable model. tan_display_gain may not be equal to 0.0.

Errors:

DM_NULL_INPUT_PTR: The deformable model cannot be NULL on entry.
DM_BAD_WALK_FLAG_VALUE: The walk_flag must be 0, 1 or 2.
DM_BAD_DISP_GAIN_VALUE: tan_display_gain cannot be 0.

Effect: Changes model

Parameters:

rtn_err: out: 0=success or negative err code.
dmod: in: dmod to modify.
tan_display_gain: display scaling for tang_vec constraints.
walk_flag: in: specify how deep to go 0=dmod only, 1=dmod and offspring 2=dmod, siblings, and offspring.
sdmo: in:SDM_options pointer note: sets active dmod.

This object is included in the file: dmapi.hxx