UI_Toolbar Class Reference

UI Toolbar provides controls for choosing which UI windows to display More...

Inheritance diagram for UI_Toolbar:

Collaboration diagram for UI_Toolbar:

Public Attributes
float	width
	The width of the toolbar in screen px. More...
List< IWindowFunction >	additionalWindows = new List<IWindowFunction>()
	The additional windows to be drawn outside the toolbar. used for classes like UI_SimulationSettings More...

Static Public Attributes
static UI_Toolbar	I
	Singleton pattern. More...

Properties
Rect	rect [get, private set]
float	innerWidth [get]

Private Member Functions
void	Awake ()
void	OnGUI ()
	Draw GUI elements More...
void	ToolbarWindow (int windowID)
	Toolbar window GUI.WindowFunction (a list of buttons for showing/hiding tools) More...

Private Attributes
List< IToolbar >	_tools = new List<IToolbar>()
GUISkin	_skin
Vector2	_scrollPos
int	winId
UI_Credits	_credits

Detailed Description

UI Toolbar provides controls for choosing which UI windows to display

Definition at line 11 of file UI_Toolbar.cs.

Member Function Documentation

void UI_Toolbar.Awake ( )

private

Definition at line 45 of file UI_Toolbar.cs.

                 {
        // singleton pattern
        if (I == null) {
            I = this;
        }
        else {
            Destroy(this);
        }
        
        // instantiate all classes that implement IToolbar
        Type ti = typeof(IToolbar);
        foreach(Assembly asm in AppDomain.CurrentDomain.GetAssemblies()) {
            Type[] types;
            try {
                types = asm.GetTypes();
            }
            catch(ReflectionTypeLoadException e) {
                foreach (Exception le in e.LoaderExceptions) {
                    Debug.LogException(le);
                }
                types = e.Types;
            }
            foreach(Type t in types) {
                if (t == null) continue;
                Type toolbarType = t.GetInterface(ti.FullName);
                if (toolbarType != null) {
                    _tools.Add((IToolbar)Activator.CreateInstance(t));
                }
            }
        }
        
        // get GUISkin
        _skin = Resources.Load<GUISkin>("GUI_style");
        _scrollPos = new Vector2();
        _credits = GetComponent<UI_Credits>();
    }

void UI_Toolbar.OnGUI ( )

private

Draw GUI elements

Definition at line 86 of file UI_Toolbar.cs.

                 {
        // set skin object
        GUI.skin = _skin;
        winId = 1;
        // set toolbar size and position
        rect = new Rect(Screen.width-width,0,width,Screen.height);
        // display toolbar window
        rect = GUILayout.Window(winId++, rect, ToolbarWindow, Strings.projectTitle + "-" + Strings.projectVersion);

        // display any additional windows
        for(int i = 0; i < additionalWindows.Count; i++) {
            IWindowFunction w = additionalWindows[i];
            if (w.windowFunction == null) {
                Debug.LogWarning("Null window removed.");
                additionalWindows.Remove(w);
            } else {
                w.windowRect = GUILayout.Window(winId++, w.windowRect, w.windowFunction, w.windowTitle);
            }
        }
    }

Here is the call graph for this function:

void UI_Toolbar.ToolbarWindow ( int  windowID )

private

Toolbar window GUI.WindowFunction (a list of buttons for showing/hiding tools)

Definition at line 110 of file UI_Toolbar.cs.

                                     {
        _scrollPos = GUILayout.BeginScrollView(_scrollPos, true, false);
        // about button
        if (GUILayout.Button("About", GUILayout.Width(innerWidth))) {
            _credits.close = false;
            additionalWindows.Add(_credits);
            
        }
        
        // horizontal separator
        GUILayout.Box("", GUILayout.Width(innerWidth), GUILayout.Height(5));
        if (!BotNavSim.isIdle) {
            if (GUILayout.Button("Back", GUILayout.Width(innerWidth))) {
                BotNavSim.state = BotNavSim.State.Idle;
            }
            // horizontal separator
            GUILayout.Box("", GUILayout.Width(innerWidth), GUILayout.Height(5));
        }
        foreach(IToolbar t in _tools) {
            // only handle windows that are contextual
            if (t.contextual) {
                // toggle window show/hide if button pressed
                if (GUILayout.Button(t.windowTitle, GUILayout.Width(innerWidth))) {
                    t.hidden = !t.hidden;
                }
                if (!t.hidden) t.windowFunction(0);
                // horizontal separator
                GUILayout.Box("", GUILayout.Width(innerWidth), GUILayout.Height(5));
            }
        }
        GUILayout.EndScrollView();
    }

Here is the caller graph for this function:

Member Data Documentation

UI_Credits UI_Toolbar._credits

private

Definition at line 43 of file UI_Toolbar.cs.

Vector2 UI_Toolbar._scrollPos

private

Definition at line 41 of file UI_Toolbar.cs.

GUISkin UI_Toolbar._skin

private

Definition at line 40 of file UI_Toolbar.cs.

List<IToolbar> UI_Toolbar._tools = new List<IToolbar>()

private

Definition at line 39 of file UI_Toolbar.cs.

List<IWindowFunction> UI_Toolbar.additionalWindows = new List<IWindowFunction>()

The additional windows to be drawn outside the toolbar. used for classes like UI_SimulationSettings

Definition at line 27 of file UI_Toolbar.cs.

UI_Toolbar UI_Toolbar.I

static

Singleton pattern.

Definition at line 16 of file UI_Toolbar.cs.

float UI_Toolbar.width

The width of the toolbar in screen px.

Definition at line 21 of file UI_Toolbar.cs.

int UI_Toolbar.winId

private

Definition at line 42 of file UI_Toolbar.cs.

Property Documentation

float UI_Toolbar.innerWidth

get

Definition at line 33 of file UI_Toolbar.cs.

Rect UI_Toolbar.rect

getprivate set

Definition at line 29 of file UI_Toolbar.cs.

---

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

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