AuxiliaryGeom Functions

This group of functions is available for interacting with an AuxiliaryGeom through the API. Click here to return to the main page. More...

Functions
void	vsp::SetAuxiliaryGeomContactPtID (const std::string &geom_id, int index, const std::string &bogie_id)
std::string	vsp::GetAuxiliaryGeomContactPtID (const std::string &geom_id, int index)
void	vsp::ReadAuxiliaryGeomCCEFile (const std::string &geom_id, const std::string &file_name)

Detailed Description

Function Documentation

GetAuxiliaryGeomContactPtID()

std::string vsp::GetAuxiliaryGeomContactPtID ( const std::string & geom_id, int index )

extern

Get the ID of the Bogie serving as one of the contact points of an AuxiliaryGeom.

string gear_id = AddGeom( "GEAR", "" );
 
string bogie_id = CreateAndAddBogie( gear_id );
 
string aux_id = AddGeom( "AUXILIARY", gear_id );
 
SetParmVal( aux_id, "AuxiliaryGeomType", "Design", AUX_GEOM_ONE_PT_GROUND );
 
Update();
 
// With only one Bogie to choose from, every contact point resolves to it.
if ( GetAuxiliaryGeomContactPtID( aux_id, 0 ) != bogie_id )
{
    Print( "ERROR: GetAuxiliaryGeomContactPtID" );
    __failure++;
}

See also

SetAuxiliaryGeomContactPtID

Parameters

[in]	geom_id	string AuxiliaryGeom Geom ID
[in]	index	int Contact point index [0, 2]

Returns

string Bogie ParmContainer ID, empty if no Bogie is assigned

ReadAuxiliaryGeomCCEFile()

void vsp::ReadAuxiliaryGeomCCEFile ( const std::string & geom_id, const std::string & file_name )

extern

Read a composite clearance envelope (*.cce) file into an AuxiliaryGeom. The file holds the envelope profile as a list of X and Z coordinate pairs, one pair per line, which the AUX_GEOM_THREE_PT_CCE mode sweeps around the aircraft.

string gear_id = AddGeom( "GEAR", "" );
 
CreateAndAddBogie( gear_id );
 
string aux_id = AddGeom( "AUXILIARY", gear_id );
 
SetParmVal( aux_id, "AuxiliaryGeomType", "Design", AUX_GEOM_THREE_PT_CCE );
 
ReadAuxiliaryGeomCCEFile( aux_id, "CCE/SD-24L.cce" );
 
Update();
 
if ( GetNumTotalErrors() > 0 )
{
    Print( "ERROR: ReadAuxiliaryGeomCCEFile" );
    __failure++;
}

Parameters

[in]	geom_id	string AuxiliaryGeom Geom ID
[in]	file_name	string Name of the *.cce file to read

SetAuxiliaryGeomContactPtID()

void vsp::SetAuxiliaryGeomContactPtID ( const std::string & geom_id, int index, const std::string & bogie_id )

extern

Assign the Bogie that serves as one of the contact points of an AuxiliaryGeom. The ground plane and clearance envelope AuxiliaryGeom modes rest the aircraft on one, two or three Bogies of the parent GearGeom; this picks which Bogie plays each role. Contact points beyond the ones the current mode uses are ignored, but they are remembered.

Any Bogie assigned here must belong to the AuxiliaryGeom's parent GearGeom. An unrecognized Bogie is silently replaced by the GearGeom's first Bogie on the next update.

string gear_id = AddGeom( "GEAR", "" );
 
string nose_id = CreateAndAddBogie( gear_id );
string main_id = CreateAndAddBogie( gear_id );
 
SetParmVal( main_id, "Symmetrical", "Bogie", 1 );    // Left and right main gear
 
string aux_id = AddGeom( "AUXILIARY", gear_id );
 
SetParmVal( aux_id, "AuxiliaryGeomType", "Design", AUX_GEOM_THREE_PT_GROUND );
 
SetAuxiliaryGeomContactPtID( aux_id, 0, nose_id );
SetAuxiliaryGeomContactPtID( aux_id, 1, main_id );
SetAuxiliaryGeomContactPtID( aux_id, 2, main_id );
 
Update();
 
if ( GetAuxiliaryGeomContactPtID( aux_id, 0 ) != nose_id )
{
    Print( "ERROR: SetAuxiliaryGeomContactPtID did not take" );
    __failure++;
}

See also

GetAuxiliaryGeomContactPtID, CreateAndAddBogie

Parameters

[in]	geom_id	string AuxiliaryGeom Geom ID
[in]	index	int Contact point index [0, 2]
[in]	bogie_id	string Bogie ParmContainer ID