Merge pull request #79 from yestinj/develop

Develop

.gitignore

@@ -8,3 +8,6 @@ src/inetvis.pro.user
 qrc_icons.cpp
 recorded/*
 src/recorded/*
+src/inetvis-recorded/*
+.idea/
+logs/

CHANGELOG

@@ -0,0 +1,59 @@
+# Changelog for Inetvis
+
+
+2.1.0 RELEASE  2017/09/21
+================================
+General
+-------
+
+Version 2.1.0 of InetVis is the first feature release since the initial port from Qt 3 to Qt5 was completed.
+Noteworthy features include support for building and running the application on Mac OS X,
+screenshots in PNG format, a settings file with UI dialog have been introduced,
+two new automatic movement modes have been added for visualisation, and new and useful keyboard
+shortcuts have been added.
+
+Various other small improvements have also been implemented.
+
+New Features
+-------------
+
+* Added a General Settings dialog and persistence for various application settings.
+* Control panel and view location and size are now persisted across restarts.
+* New hotkey 'Z' in view to quickly capture a screenshot.
+* Added play/pause function linked to spacebar being pressed in visualisation pane.
+* Added new hotkey '0' to reset the visualisation pane, clearning all events.
+* Added 'Harelemshake' mode - causes jittering when view to help with depth perception, triggered with ~
+* Added autorotation in View to rotate around x axis. 1 to trigger, 2 to increment, 3 to decrement
+	Decrementing will result in cube roatating in the opposite direction.
+* Added Ctrl-Q (^Q) to quit application from plotter window.	
+* Introduced application log file for stdout and stderr.
+
+Bugs Fixed / Improvements
+----------
+* Support for building on Mac OS!
+* Improved screenshot implementation to save to PNG with configuration quality (in General Settings).
+* Added recording directory viewing and updating under General Settings.
+* The network interface to listen on can now be specified in general settings.
+* Added default home network options to settings and a load button in Plotter settings dialog.
+* Introduced modularity to the About dialog.
+
+Known Issues
+------------
+* At present running the standalone app does not work on Mac OS, however opening with Qt Creator,
+	building, and then running does work.
+* Monitoring local network interfaces does not work under Mac OS at this time.
+* Windows support is failing to compile.
+
+2.0.4
+======================
+Additional bugfixes
+
+
+2.0.3
+======================
+Bugfixes
+
+2.0.1
+======================
+First public releae of Inetvis 'Lasarus' Edition.
+Complete port of the old 0.9.5 codebase using Qt3 to Qt5

README.md

@@ -18,8 +18,8 @@ A compiled version of InetVis is available under the releases section of https:/
 In order to install and run the software please do the following:
 
 1. Download the latest release archive from the releases page.
-2. Extract the archive which will be called something like `inetvis-2.0.2.tgz`
-3. Change into the extracted directory, something like `inetvis-2.0.2`
+2. Extract the archive which will be called something like `inetvis-2.1.0.tgz`
+3. Change into the extracted directory, something like `inetvis-2.1.0`
 4. Run the `install_inetvis.sh` shell script to install the software.
     1. This script will: install the software to `/opt/inetvis-<version>`
     2. Create a symlink directory `/opt/inetvis` for convenience
@@ -28,6 +28,8 @@ In order to install and run the software please do the following:
     5. Place a `desktop` file in `/usr/share/applications`, allowing inetvis to be found in the menu on Ubuntu systems.
     6. Create a symlink at `/usr/local/bin/inetvis` pointing to the main binary.
     7. Set the `cap_net_raw`, and `cap_net_admin=eip` capabilities on the inetvis binary allowing for monitoring packets on local host without running as root.
+	$sudo  setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' <inetvis binary>
+       This needs to generally not be /home which on Debian/ubuntu systems is mounted nosuid
 5. If the script completes successfully inetvis should now be in your path, and also be in the menu system of your distribution.
 
 You should now be able to run the `inetvis` binary from the command line, as it will be in your path, or you can run it from the Ubuntu menu system, where it will show up as an item. Running from the command line allows you to view console messages produced while the application is running.
@@ -47,6 +49,10 @@ Building InetVis is relatively straight forward. Begin by doing the following:
 2. Install the following dependencies:
     * `sudo apt-get install libpcap-dev qt5-default`
 
+It has been noted that the following dependencies were also required on Linux Mint based systems:
+
+`sudo apt-get install libqglviewer-dev libqglviewer2`
+
 Once the dependencies are installed, clone this repository if you haven't already.
 
 1. Clone the github repo into the `inetvis` directory:
@@ -62,7 +68,7 @@ Finally, build the `inetvis` binary:
 
 This will result in a new `inetvis` binary being generated within the source directory.
 
-You may now run `inetvis` by simply running the generated binary. You will need to either run using sudo, or set packet capture capabilities on the file in the
+You may now run `inetvis` by simply running the generated binary. You will need to either run using sudo, or set packet capture capabilities (see instructions above) on the file in the
 event that you would like to monitor your local host for packets.
 
 Have fun! :-)

doc/inetvisdoc.html

@@ -33,15 +33,15 @@
   </head>
 
   <body>
-    <h1><img src="images/icon.gif" alt="InetVis Icon" border="0" />InetVis 2.0.1 Manual</h1>
+    <h1><img src="images/icon.gif" alt="InetVis Icon" border="0" />InetVis 2.1.0 Manual</h1>
 
     <p class="center">documentation and help</p>
     <br />
 
     <hr />
     <!--========================================================================-->
 
-    <p class="right"><small><em>Last revision:</em> 2017-06-12</small></p>
+    <p class="right"><small><em>Last revision:</em> 2017-09-21</small></p>
 
     <h2>Contents</h2>
 
@@ -249,41 +249,36 @@ <h4><a id="2.2.2.1." name="2.2.2.1.">2.2.2.1. Navigation via Mouse Controls.</a>
     <h4><a id="2.2.2.2." name="2.2.2.2.">2.2.2.2. Navigation via Keyboard Controls.</a></h4>
 
     <ul>
-      <li><strong>&#39;Arrow Keys&#39;</strong> to rotate.</li>
-
-      <li><strong>&#39;Ctrl&#39; + &#39;Arrow Keys&#39;</strong> to translate (x and y).</li>
-
-      <li><strong>&#39;Alt&#39; + &#39;UP Arrow Key&#39; or &#39;Down Arrow Key&#39;</strong> to translate (z).</li>
-
-      <li><strong>&#39;+&#39; and &#39;-&#39;</strong> to scale (zoom).</li>
-
-      <li><strong>&#39;Home&#39;</strong> or &#39;Ctrl+f&#39; to reset view to front on (up z axis).</li>
-
-      <li><strong>&#39;End&#39;</strong> to view from back (down z axis).</li>
-
-      <li><strong>&#39;Ctrl+l&#39;</strong> to view from left side (up x axis).</li>
-
-      <li><strong>&#39;Ctrl+r&#39;</strong> to view from right (down x axis).</li>
-
-      <li><strong>&#39;Ctrl+t&#39;</strong> to view from top (down y axis).</li>
-
-      <li><strong>&#39;Ctrl+b&#39;</strong> to view from below (up y axis).</li>
+		<li><strong>&#39;Arrow Keys&#39;</strong> to rotate.</li>
+		<li><strong>&#39;Ctrl&#39; + &#39;Arrow Keys&#39;</strong> to translate (x and y).</li>
+		<li><strong>&#39;Alt&#39; + &#39;UP Arrow Key&#39; or &#39;Down Arrow Key&#39;</strong> to translate (z).</li>
+		<li><strong>&#39;+&#39; and &#39;-&#39;</strong> to scale (zoom).</li>
+   	  	<li><strong>&#39;Ctrl-L	^L&#39;</strong> Set Left View (up <em>x</em> axis)</li>
+		<li><strong>&#39;Ctrl-R	^R&#39;</strong> Set Right View (down <em>x</em> axis)</li> 
+		<li><strong>&#39;Ctrl-T	^T&#39;</strong> Set Top View (down <em>y</em> axis)</li>
+		<li><strong>&#39;Ctrl-B	^B&#39;</strong> Set Bottom View (up <em>y</em> axis)</li>
+		<li><strong>&#39;Ctrl-F	^F&#39;</strong> Set Front View (up <em>x</em> axis)</li>
+		<li><strong>&#39;Home&#39;</strong> Set Front view (down <em>y</em> axis)</li>
+		<li><strong>&#39;End&#39;</strong> Set Back View (down <em>z</em> axis)</li>
     </ul>
 
     <h4><a id="2.2.2.3." name="2.2.2.3.">2.2.2.3. Other Keyboard Controls</a></h4>
-
     <ul>
-      <li><strong>&#39;f&#39;</strong> to toggle full screen.</li>
-
-      <li><strong>&#39;Esc&#39;</strong> to escape full screen.</li>
-
-      <li><strong>&#39;p&#39;</strong> to bring up Plotter Settings Dialogue.</li>
-
-      <li><strong>&#39;r&#39;</strong> to bring up Reference Frame Settings Dialogue.</li>
-
-      <li><strong>&#39;c&#39;</strong> to bring up Control Panel Dialogue.</li>
-
-      <li><strong>&#39;Ctrl+H&#39;</strong> to hide home address range (addresses replaced with obscuring labels).</li>
+		<li><strong>&#39;f&#39;</strong> Toggle full screen.</li>
+		<li><strong>&#39;Esc&#39;</strong> Exit full screen</li>
+		<li><strong>&#39;QuoteLeft	~`&#39;</strong> Toggle Harlemshake</li>
+		<li><strong>&#39;0&#39;</strong> Clear the visualisation pane</li>
+		<li><strong>&#39;1&#39;</strong> Rotation Toggle</li>
+		<li><strong>&#39;2&#39;</strong> Decrease Rotation</li>
+		<li><strong>&#39;3&#39;</strong> Increase Rotation</li>
+		<li><strong>&#39;Ctrl-H	^H&#39;</strong> Hide Home Range (the.drk.net)</li>
+		<li><strong>&#39;Z&#39;</strong> Take single frame Screenshot</li>
+		<li><strong>&#39;Space&#39;</strong> Play/Pause the visualisation</li>
+		<li><strong>&#39;Ctrl-Q	^Q&#39;</strong> Quit the application</li>
+		<li><strong>&#39;p&#39;</strong> to bring up Plotter Settings Dialogue.</li>
+		<li><strong>&#39;r&#39;</strong> to bring up Reference Frame Settings Dialogue.</li>
+		<li><strong>&#39;c&#39;</strong> to bring up Control Panel Dialogue.</li>
+		<li><strong>&#39;Ctrl+H&#39;</strong> to hide home address range (addresses replaced with obscuring labels).</li>
     </ul>
 
     <h4><a id="2.2.3." name="2.2.3.">2.2.3. Plotter Settings Dialogue</a></h4>