UI_SimulationControl Class Reference

IToolbar class for simulation control. Provides controls for pausing, stopping or skipping the current test Provides a toggle for exhibition mode. Provides a slider for simulation timescale. More...

Inheritance diagram for UI_SimulationControl:

Collaboration diagram for UI_SimulationControl:

Public Member Functions
	UI_SimulationControl ()

Properties
bool	contextual [get]
bool	hidden [get, set]
string	windowTitle [get]
Rect	windowRect [get, set]
GUI.WindowFunction	windowFunction [get]
Properties inherited from IToolbar
bool	contextual [get]
	Gets a value indicating whether this IToolbar is contextual. More...
bool	hidden [get, set]
	Gets or sets a value indicating whether this IToolbar is hidden. More...
Properties inherited from IWindowFunction
string	windowTitle [get]
	Gets the window title. More...
Rect	windowRect [get, set]
	Gets or sets the window rect (window size and position). More...
GUI.WindowFunction	windowFunction [get]
	Gets the window function definition for GUILayout.Window() More...

Private Member Functions
void	MainWindow (int windowID)
	Simulation settings window function called by UI_Toolbar. More...

Private Attributes
bool	_liveEditSettings
UI_SimulationSettings	_editSettings

Detailed Description

IToolbar class for simulation control. Provides controls for pausing, stopping or skipping the current test Provides a toggle for exhibition mode. Provides a slider for simulation timescale.

Definition at line 11 of file UI_SimulationControl.cs.

Constructor & Destructor Documentation

UI_SimulationControl.UI_SimulationControl

(

)

Definition at line 13 of file UI_SimulationControl.cs.

                                  {
        _editSettings = new UI_SimulationSettings(Simulation.settings);
        hidden = true;
    }

Member Function Documentation

void UI_SimulationControl.MainWindow ( int  windowID )

private

Simulation settings window function called by UI_Toolbar.

Definition at line 52 of file UI_SimulationControl.cs.

                                   {
        float lw = 200f;
                
        // simulation information
        GUILayout.BeginHorizontal(GUILayout.Width(UI_Toolbar.I.innerWidth));
        GUILayout.Label(Simulation.settings.title + "(" + Simulation.simulationNumber + "/" +
                        Simulation.batch.Count + ") ", GUILayout.Width(lw));
        GUILayout.Label("Test " + Simulation.testNumber + "/" + Simulation.settings.numberOfTests);
        GUILayout.EndHorizontal();
        
        GUILayout.BeginHorizontal(GUILayout.Width(UI_Toolbar.I.innerWidth));
        GUILayout.Label("Time (s): " + Simulation.time.ToString("G3") + "/" + 
            Simulation.settings.maximumTestTime, GUILayout.Width(lw));
        GUILayout.EndHorizontal();

        
        // exhbition mode tickbox
        GUILayout.BeginHorizontal(GUILayout.Width(UI_Toolbar.I.innerWidth));
        GUILayout.Label("Exhibition Mode: ", GUILayout.Width(lw));
        Simulation.exhibitionMode = GUILayout.Toggle(Simulation.exhibitionMode, "");
        GUILayout.EndHorizontal();
        
        // timescale slider 
        GUILayout.BeginHorizontal(GUILayout.Width(UI_Toolbar.I.innerWidth));
        GUILayout.Label("Simulation Timescale: ", GUILayout.Width(lw));
        Simulation.timeScale = GUILayout.HorizontalSlider(
            Simulation.timeScale,
            0.5f, 4f);
        GUILayout.EndHorizontal();
        
        // contextual control buttons
        if (Simulation.isRunning) {
            GUILayout.BeginHorizontal();
            if (Simulation.paused) {
                if (GUILayout.Button("Play"))
                    Simulation.paused = false;
            }
            else {
                if (GUILayout.Button("Pause"))
                    Simulation.paused = true;
            }
            if (GUILayout.Button("Stop")) {
                Simulation.exhibitionMode = false;
                Simulation.End();
            }
            GUILayout.EndHorizontal();
            if (GUILayout.Button("Next Test")) {
                Simulation.NextTest();
            }
            
        }
        if (Simulation.isFinished) {
            if  (GUILayout.Button("Start Again")) {
                Simulation.Begin();
            }
            if (GUILayout.Button("New Simulation...")) {
                Simulation.End();
            }
        }
        
        // show/hide button for edit settings window
        if (_liveEditSettings) {
            if (GUILayout.Button("Hide Settings")) {
                _liveEditSettings = false;
                UI_Toolbar.I.additionalWindows.Remove((IWindowFunction)_editSettings);
            }
        }
        else {
            if (GUILayout.Button("Show Settings")) {
                _editSettings = new UI_SimulationSettings(Simulation.settings);
                _liveEditSettings = true;
                UI_Toolbar.I.additionalWindows.Add((IWindowFunction)_editSettings);
            }
        }
        
        // update controls when _editSettings is completed
        if (_liveEditSettings) {
            if (_editSettings.windowFunction == null) {
                _liveEditSettings = false;
            }
        }

    }

Here is the call graph for this function:

Member Data Documentation

UI_SimulationSettings UI_SimulationControl._editSettings

private

Definition at line 46 of file UI_SimulationControl.cs.

bool UI_SimulationControl._liveEditSettings

private

Definition at line 45 of file UI_SimulationControl.cs.

Property Documentation

bool UI_SimulationControl.contextual

get

Definition at line 18 of file UI_SimulationControl.cs.

bool UI_SimulationControl.hidden

getset

Definition at line 24 of file UI_SimulationControl.cs.

GUI.WindowFunction UI_SimulationControl.windowFunction

get

Definition at line 38 of file UI_SimulationControl.cs.

Rect UI_SimulationControl.windowRect

getset

Definition at line 34 of file UI_SimulationControl.cs.

string UI_SimulationControl.windowTitle

get

Definition at line 28 of file UI_SimulationControl.cs.

---

The documentation for this class was generated from the following file:

• Assets/botnavsim/Scripts/UI/UI_SimulationControl.cs