vizSupport

vizSupport.enableUnityVisualization(scSim, simTaskName, processName, **kwargs)[source]

This methods creates an instance of the vizInterface() modules and setups up associated Vizard configuration setting messages.

Parameters

  • scSim – variable with the simulationBaseClass copy

  • simTaskName – task to which to add the vizInterface module

  • processName – process to which to write a default zero planetary ephemeris message if this message does not exist

Keyword Arguments

  • saveFile (str) – can be a single file name, or a full path + file name. In both cases a local results are stored in a local sub-folder. Default: empty string resulting in the data not being saved to a file

  • gravBodies – gravity Factory object. Default: no gravity bodies are included

  • scName (str or list(str)) – can be a single spacecraft name string, or a list of strings. Default: assumes a single craft with a default name.

  • numRW (int or list(int)) – number of RWs on spacecraft. If scName is a list and numRW is an integer, then the same number RW is added to each spacecraft. If numRW is a list then it must be of the same dimension as scName. Default value is zero RWs for each spacecraft.

  • thrDevices – list of thruster devices states for the first spacecraft

  • cssNames – list of CSS configuration log message names lists

  • opNavMode (bool) – flag if opNaveMode should be used

  • liveStream (bool) – flag if live data streaming to Vizard should be used

Returns

copy of the vizInterface instance

Return type

Module: vizInterface object

vizSupport.setActuatorGuiSetting(viz, **kwargs)[source]

This method sets the actuator GUI properties for a particular spacecraft. If no spacecraftName is provided, then the name of the first spacecraft in the simulation is assumed.

Parameters

  • viz – copy of the vizInterface module

  • kwargs – list of keyword arguments that this method supports

Returns

void

Keyword Arguments

  • spacecraftName (str) – The name of the spacecraft for which the actuator GUI options are set. Default: If not provided, then the name of the first spacecraft in the simulation is used.

  • viewThrusterPanel (bool) – flag if the GUI panel should be shown illustrating the thruster states Default: if not provided, then the Vizard default settings are used

  • viewRWPanel (bool) – flag if the GUI panel should be shown illustrating the reaction wheel states Default: if not provided, then the Vizard default settings are used

  • viewThrusterHUD (bool) – flag if the HUD visualization of the thruster states should be shown Default: if not provided, then the Vizard default settings are used

  • viewRWHUD (bool) – flag if the HUD visualization of the reaction wheel states should be shown Default: if not provided, then the Vizard default settings are used

  • showThrusterLabels (bool) – flag if the thruster labels should be shown Default: if not provided, then the Vizard default settings are used

  • showRWLabels (bool) – flag if the reaction wheel labels should be shown Default: if not provided, then the Vizard default settings are used

vizSupport.setInstrumentGuiSetting(viz, **kwargs)[source]

This method sets the instrument GUI properties for a particular spacecraft. If no spacecraftName is provided, then the name of the first spacecraft in the simulation is assumed.

Parameters

  • viz – copy of the vizInterface module

  • kwargs – list of keyword arguments that this method supports

Returns

void

Keyword Arguments

  • spacecraftName (str) – The name of the spacecraft for which the actuator GUI options are set. Default: If not provided, then the name of the first spacecraft in the simulation is used.

  • viewCSSPanel (bool) – flag if the GUI panel should be shown illustrating the CSS states Default: if not provided, then the Vizard default settings are used

  • viewCSSCoverage (bool) – flag if the HUD spherical coverage of the CSS states should be shown Default: if not provided, then the Vizard default settings are used

  • viewCSSBoresight (bool) – flag if the HUD boresight axes of the CSS states should be shown Default: if not provided, then the Vizard default settings are used

  • showCSSLabels (bool) – flag if the CSS labels should be shown Default: if not provided, then the Vizard default settings are used

vizSupport.setSprite(shape, **kwargs)[source]

Helper function to set the sprite shape and optional sprite color. :param shape: Sprite shape, must be either “CIRCLE”, “SQUARE”, “TRIANGLE”, “STAR”, or “bskSat” :param kwargs: RGBA color, can be either color name string or a 4D list of [0,255] values :return: string of the protobuffer sprite setting