Snap-To Functions

This group of API functions provide the capabilities available in the Snap-To tool. Click here to return to the main page. More...

Functions
double	vsp::ComputeMinClearanceDistance (const std::string &geom_id, int set=SET_ALL)
double	vsp::SnapParm (const std::string &parm_id, double target_min_dist, bool inc_flag, int set=SET_ALL)

Detailed Description

Function Documentation

ComputeMinClearanceDistance()

double vsp::ComputeMinClearanceDistance ( const std::string & geom_id, int set = SET_ALL )

extern

Compute the minimum clearance distance for the specified geometry

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
string pid = AddGeom( "POD", "" );                     // Add Pod
 
string x = GetParm( pid, "X_Rel_Location", "XForm" );
 
SetParmVal( x, 3.0 );
 
Update();
 
double min_dist = ComputeMinClearanceDistance( pid, SET_ALL );

Parameters

[in]	geom_id	string Geom ID
[in]	set	Collision set enum (i.e. SET_ALL)

Returns

Minimum clearance distance

SnapParm()

double vsp::SnapParm ( const std::string & parm_id, double target_min_dist, bool inc_flag, int set = SET_ALL )

extern

Snap the specified Parm to input target minimum clearance distance

//Add Geoms
string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
string pid = AddGeom( "POD", "" );                     // Add Pod
 
string x = GetParm( pid, "X_Rel_Location", "XForm" );
 
SetParmVal( x, 3.0 );
 
Update();
 
double min_dist = SnapParm( x, 0.1, true, SET_ALL );

Parameters

[in]	parm_id	string Parm ID
[in]	target_min_dist	Target minimum clearance distance
[in]	inc_flag	Direction indication flag. If true, upper parm limit is used and direction is set to positive
[in]	set	Collision set enum (i.e. SET_ALL)

Returns

Minimum clearance distance