Skip to content

Commit

Permalink
GUITool 1.0.1 Build 21.03.085
Browse files Browse the repository at this point in the history
  • Loading branch information
precise-simulation committed Mar 26, 2021
0 parents commit 955cb9b
Show file tree
Hide file tree
Showing 161 changed files with 10,381 additions and 0 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. You may not use the material for commercial purposes. License for
personal non-commercial uses only, please contact Precise Simulation
Limited for commercial and custom licensing options.

2. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

3. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

4. All advertising materials mentioning features or use of this
software must display the following acknowledgement: This product
includes software developed by Precise Simulation Limited
(www.precisesimulation.com).

5. Neither the name of the Precise Simulation Limited nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY PRECISE SIMULATION LIMITED ''AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL PRECISE SIMULATION LIMITED BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
120 changes: 120 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
GUITool - Easy to Use GUI Toolkit & Framework for MATLAB
========================================================

![GUITool - Easy to Use MATLAB GUI Toolkit and Framework](https://raw.githubusercontent.com/precisesimulation/featool-multiphysics/master/featool-multiphysics-screenshot.png)


_GUITool_ is a cross compatible Graphical User Interface (GUI)
Toolkit, UI design, and layout framework for MATLAB. It has been
specifically designed to be very easy to use and allow rapid
prototyping of custom MATLAB UI interfaces. At the same time it has
been developed to be faster and have better performance for complex
and larger scale GUIs than the _Mathworks GUI Layout Toolbox_.

GUITool is for example used for designing and building the simulation
interfaces for the [FEATool Multiphysics](https://www.featool.com) and
[CFDTool](https://www.cfdtool.com) simulation toolboxes.


Performance Evaluation
----------------------

The GUITool framework has been compared to the Mathworks GUI Layout
Toolbox (GLT) by running the included test suite, as for example

runTestSuite( 'nruns', 100, 'pause', 0, 'closef', 1, 'uilib', 'uitk' )

substituting the _uilib_ parameter with `uitk`, `uiextras`, and `uix`
correspondingly. The resulting timings can be seen in the table
below. First, we can see that GUITool is 1.8-2.5 times faster than the
GUI Layout Toolbox (GLT), moreover, comparing the runs for MATLAB
2011a with 2019a it also clear that the MATLAB GUI functionality is
currently 2-3 times slower with is also consistent with a previous
[MATLAB GUI benchmark comparison](https://www.precisesimulation.com/blog/2019-08-20-benchmarking-and-performance-comparison-of-matlab-versions).
To really get good GUI performance we can therefore only recommend
using the GUITool framework with older MATLAB versions.

<table>
<caption id="matlab-gui-performance-comparison-table">MATLAB GUI Performance Comparison</caption>
<tr> <th> MATLAB <th colspan="2"> R2011a <th colspan="2"> R2019a
<tr> <th> Test case <th> GUITool <th> GLT (v1.17) <th> GUITool <th> GLT (v2.3.4)
<tr> <td> hbox 1 <td> 0.5 <td> 1.3 <td> 1.4 <td> 1.9
<tr> <td> hbox 2 <td> 0.7 <td> 1.7 <td> 2.0 <td> 2.8
<tr> <td> vbox 1 <td> 0.4 <td> 1.3 <td> 1.3 <td> 1.9
<tr> <td> vbox 2 <td> 0.6 <td> 1.7 <td> 2.0 <td> 2.5
<tr> <td> grid 1 <td> 0.6 <td> 2.4 <td> 2.0 <td> 3.6
<tr> <td> boxpanel 1 <td> 0.5 <td> 2.7 <td> 2.2 <td> 12.5
<tr> <td> tabpanel 1 <td> 1.6 <td> 3.1 <td> 6.1 <td> 3.9
<tr> <th> Total Time <th> 5.8 <th> 14.2 <th> 16.9 <th> 28.9
</table>


Installation
------------

Copy and add the GUI toolkit source files (.m and .p files from
the _src_ directory) to your own project directory, or add a path to
to the directory with the `addpath` command.


Examples
--------

Look at the examples in the source files _uitkHBox_, _uitkVBox_,
_uitkGrid_, _uitkBoxPanel_, and _uitkTabPanel_ as well as the examples
in the _src/tests_ directory.


Testing
-------

Run the `runTestSuite` function from the root directory.


Documentation
-------------

Open the included **index.html** file in a web browser to access the
function documentation.


License
-------

Copyright (C) 2013-2019 Precise Simulation Ltd.

Keywords: MATLAB GUI Layout Toolkit Framework

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. You may not use the material for commercial purposes. License for
personal non-commercial uses only, please contact Precise Simulation
Limited for commercial and custom licensing options.

2. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

3. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

4. All advertising materials mentioning features or use of this
software must display the following acknowledgement: This product
includes software developed by Precise Simulation Limited
(www.precisesimulation.com).

5. Neither the name of the Precise Simulation Limited nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY PRECISE SIMULATION LIMITED ''AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL PRECISE SIMULATION LIMITED BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/bc_s.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/bdwn.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/closed.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
145 changes: 145 additions & 0 deletions doc/dir_68267d1309a1af8e8297ef4c3efbcdba.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GUITool Documentation: src Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a href="https://www.precisesimulation.com" target="_blank"><img alt="Logo" src="logo.jpg"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<a href="https://www.featool.com" target="_blank"><div id="projectname">GUITool
&#160;<span id="projectnumber">v1.0.1</span>
</div></a>
<div id="projectbrief">MATLAB GUI Tookit &amp; Layout Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('dir_68267d1309a1af8e8297ef4c3efbcdba.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">src Directory Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="subdirs"></a>
Directories</h2></td></tr>
<tr class="memitem:dir_d49b597d86ed44de6eb8a459f0ed40df"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_d49b597d86ed44de6eb8a459f0ed40df.html">private</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:dir_d93a1d4020dea85bb71b237545b5e722"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_d93a1d4020dea85bb71b237545b5e722.html">tests</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:uitkBoxPanel_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkBoxPanel_8m.html">uitkBoxPanel.m</a></td></tr>
<tr class="memdesc:uitkBoxPanel_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKBOXPANEL Show one element inside a box panel. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkGrid_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkGrid_8m.html">uitkGrid.m</a></td></tr>
<tr class="memdesc:uitkGrid_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKGRID Arrange GUI elements in a grid layout. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkHBox_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkHBox_8m.html">uitkHBox.m</a></td></tr>
<tr class="memdesc:uitkHBox_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKHBOX Create/update uitk GUI container for a horizontal single row layout. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkRedraw_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkRedraw_8m.html">uitkRedraw.m</a></td></tr>
<tr class="memdesc:uitkRedraw_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKREDRAW Call figures nested uitk redrawing callbacks. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkRedrawGrid_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkRedrawGrid_8m.html">uitkRedrawGrid.m</a></td></tr>
<tr class="memdesc:uitkRedrawGrid_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKREDRAWGRID Redraw container contents for a uitkGrid object. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkTabPanel_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkTabPanel_8m.html">uitkTabPanel.m</a></td></tr>
<tr class="memdesc:uitkTabPanel_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKTABPANEL Create an uitk panel with tabs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:uitkVBox_8m"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uitkVBox_8m.html">uitkVBox.m</a></td></tr>
<tr class="memdesc:uitkVBox_8m"><td class="mdescLeft">&#160;</td><td class="mdescRight">UITKVBOX Create/update uitk GUI container for a vertical single row layout. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>
<li class="footer">
© Copyright 2013-2019 Precise Simulation Ltd.
</ul>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-51347039-2', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>
12 changes: 12 additions & 0 deletions doc/dir_68267d1309a1af8e8297ef4c3efbcdba.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
var dir_68267d1309a1af8e8297ef4c3efbcdba =
[
[ "private", "dir_d49b597d86ed44de6eb8a459f0ed40df.html", "dir_d49b597d86ed44de6eb8a459f0ed40df" ],
[ "tests", "dir_d93a1d4020dea85bb71b237545b5e722.html", "dir_d93a1d4020dea85bb71b237545b5e722" ],
[ "uitkBoxPanel.m", "uitkBoxPanel_8m.html", null ],
[ "uitkGrid.m", "uitkGrid_8m.html", null ],
[ "uitkHBox.m", "uitkHBox_8m.html", null ],
[ "uitkRedraw.m", "uitkRedraw_8m.html", null ],
[ "uitkRedrawGrid.m", "uitkRedrawGrid_8m.html", null ],
[ "uitkTabPanel.m", "uitkTabPanel_8m.html", null ],
[ "uitkVBox.m", "uitkVBox_8m.html", null ]
];

0 comments on commit 955cb9b

Please sign in to comment.