AuxiliaryGeom Functions

This group of functions is available for interacting with an AuxiliaryGeom through the API.

SetAuxiliaryGeomContactPtID(geom_id, index, ...)

Assign the Bogie that serves as one of the contact points of an AuxiliaryGeom.

GetAuxiliaryGeomContactPtID(geom_id, index)

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

ReadAuxiliaryGeomCCEFile(geom_id, file_name)

Read a composite clearance envelope (.cce) file into an AuxiliaryGeom.

Details

openvsp.SetAuxiliaryGeomContactPtID(geom_id, index, bogie_id)[source]

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.

gear_id = AddGeom( "GEAR", "" )

nose_id = CreateAndAddBogie( gear_id )
main_id = CreateAndAddBogie( gear_id )

SetParmVal( main_id, "Symmetrical", "Bogie", 1 )    # Left and right main gear

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()

assert GetAuxiliaryGeomContactPtID( aux_id, 0 ) == nose_id, "SetAuxiliaryGeomContactPtID did not take"

See also: GetAuxiliaryGeomContactPtID, CreateAndAddBogie :param [in]: geom_id string AuxiliaryGeom Geom ID :param [in]: index int Contact point index [0, 2] :param [in]: bogie_id string Bogie ParmContainer ID

openvsp.GetAuxiliaryGeomContactPtID(geom_id, index)[source]

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

gear_id = AddGeom( "GEAR", "" )

bogie_id = CreateAndAddBogie( gear_id )

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.
assert GetAuxiliaryGeomContactPtID( aux_id, 0 ) == bogie_id, "GetAuxiliaryGeomContactPtID"

See also: SetAuxiliaryGeomContactPtID :param [in]: geom_id string AuxiliaryGeom Geom ID :param [in]: index int Contact point index [0, 2] :rtype: string :return: string Bogie ParmContainer ID, empty if no Bogie is assigned

openvsp.ReadAuxiliaryGeomCCEFile(geom_id, file_name)[source]

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.

gear_id = AddGeom( "GEAR", "" )

CreateAndAddBogie( gear_id )

aux_id = AddGeom( "AUXILIARY", gear_id )

SetParmVal( aux_id, "AuxiliaryGeomType", "Design", AUX_GEOM_THREE_PT_CCE )

ReadAuxiliaryGeomCCEFile( aux_id, "CCE/SD-24L.cce" )

Update()
Parameters:

  • [in] – geom_id string AuxiliaryGeom Geom ID

  • [in] – file_name string Name of the .cce file to read