3DHOP 4.1 Pre-Release

Distribution & Documentation Update
cnr-isti-vclab · Dec 16, 2016 · 8e0f22a · 8e0f22a
1 parent 124dfc8
commit 8e0f22a
Show file tree

Hide file tree

Showing 21 changed files with 438 additions and 405 deletions.
diff --git a/CHANGELOG .md b/CHANGELOG .md
@@ -8,7 +8,7 @@
 
 Contact Us @ info@3dhop.net
 
-19 November 2016
+19 December 2016
 
 #### TEAM
 ---------
@@ -21,46 +21,38 @@ Marco Potenziani     @ marco.potenziani@isti.cnr.it
 #### CHANGELOG FILE
 -------------------
 
-*Developer*
+*Version 4.1*  
 
 **Main Changes**
 
-* Updated HANDLER "_onEndMeasurement". 
-Now the function has two more parameters, containing the first and second point picked: this._onEndMeasurement(this.measurement, this._pointA, this._pointB);
-This is helpful to also display the picked points, or if the user wants to write its own distance calculation, for example, to return only the distance along the X axis.
-The change is retro-compatible, and is perfectly safe to ignore the two new parameters, using a single parameter function as a handler (thus getting only the measured distance);
-
-* Added CAMERA MODE: ORTHOGRAPHIC.
-The camera may be set at startup (in the "space" object) or runtime (there is a toggle and two set functions).
-Trackball should implement a "get distance" function, that returns the camera distance from the scene (needed to have zoom in the orthographic mode). In the basic distribution trackballs, this is enough: get distance() { return this._distance; };
-
-*Version 4.0*  
-
-**Main Changes**
-
-* Added PLANES SECTIONING TOOL;
-* Added POINT PICKING TOOL;
-* Updated MEASUREMENT TOOL;
-* Added SCENE CENTERING features;
-* Added easier SPECIFICATION OF TRANSFORMATION functions;
-* Added POINT SIZE render control shortcut (MeshLab like);
-* Added DOUBLE CLICK TO GO camera control to pan-trackball(MeshLab like);
-* Added multiresolution SINGLE TEXTURE MESHES support;
-* Updated RENDERING and DATA STREAMING system;
-* Updated RENDERING and DATA STREAMING parallelization;
-* Updated MOUSE WHEEL ZOOM control;
-* Updated SAFARI browser patch;
-* Added new TOOLBAR button icons set;  
+* Fixed "MISSING PATCH" BUG in NEXUS models rendering;
+* Fixed "TEXTURE WAKE UP" BUG in NEXUS models rendering;
+* Fixed SAFARI browser PATCH for NEXUS models rendering;
+* Fixed MINOR issues in TRACKBALL SET;
+* Updated NEXUS RENDERING and MEMORY ALLOCATION system;
+* Updated and optimized SHADERS SET;
+* Updated TRACKBALL PAN SPEED;
+* Updated COLOR CODED ID feature;
+* Updated MEASUREMENT HANDLER;
+* Added STYLESHEET for viewer informative PANELS;
+* Added ALL TOOL viewer TEMPLATE;
+* Added NEW SHADER for clusters of points/lines;
+* Added TOOLBAR COLOR SWITCH function;
+* Added POINTSIZE setup in SCENE CONFIG;
+* Added mouse RIGHT BUTTON PAN feature;
+* Added REPAINT function;
+* Added support for TEXTURES and POINT CLOUDS for PLY models;
+* Added ORTHOGRAPHIC CAMERA mode and functions;
+* Minified spidergl.js file;
+* Cleanup code and indentation in various .js files;
 
 **Files Added/Modified**
 
-* Added "HOWTO_9.0_planes_sections.html" file;
-* Added "HOWTO_8.1_point_picking.html" file;
-* Updated"HOWTO_8.0_measurement_tool.html" file;
-* Added "HOWTO_4.1_complex_scene" file;
-* Added "trackball_rail.js" file;
+* Added "3DHpanels.css" file;
+* Added "index_all_tools.html" file;
+* Updated "index.html" file and renamed "index_no_tools.html";
+* Updated "HOWTO_8.1_point_picking.html" file;
+* Updated "HOWTO_8.0_measurement_tool.html" file;
 * Updated all "*.js" files;
 * Updated "3dhop.css" file;
 * Updated "docs.html" file;
-* Updated "skins" directory;
-
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -8,7 +8,7 @@
 
 Contact Us @ info@3dhop.net
 
-19 November 2016
+19 December 2016
 
 #### TEAM
 ---------
@@ -21,46 +21,38 @@ Marco Potenziani     @ marco.potenziani@isti.cnr.it
 #### CHANGELOG FILE
 -------------------
 
-*Developer*
+*Version 4.1*  
 
 **Main Changes**
 
-* Updated HANDLER "_onEndMeasurement". 
-Now the function has two more parameters, containing the first and second point picked: this._onEndMeasurement(this.measurement, this._pointA, this._pointB);
-This is helpful to also display the picked points, or if the user wants to write its own distance calculation, for example, to return only the distance along the X axis.
-The change is retro-compatible, and is perfectly safe to ignore the two new parameters, using a single parameter function as a handler (thus getting only the measured distance);
-
-* Added CAMERA MODE: ORTHOGRAPHIC.
-The camera may be set at startup (in the "space" object) or runtime (there is a toggle and two set functions).
-Trackball should implement a "get distance" function, that returns the camera distance from the scene (needed to have zoom in the orthographic mode). In the basic distribution trackballs, this is enough: get distance() { return this._distance; };
-
-*Version 4.0*  
-
-**Main Changes**
-
-* Added PLANES SECTIONING TOOL;
-* Added POINT PICKING TOOL;
-* Updated MEASUREMENT TOOL;
-* Added SCENE CENTERING features;
-* Added easier SPECIFICATION OF TRANSFORMATION functions;
-* Added POINT SIZE render control shortcut (MeshLab like);
-* Added DOUBLE CLICK TO GO camera control to pan-trackball(MeshLab like);
-* Added multiresolution SINGLE TEXTURE MESHES support;
-* Updated RENDERING and DATA STREAMING system;
-* Updated RENDERING and DATA STREAMING parallelization;
-* Updated MOUSE WHEEL ZOOM control;
-* Updated SAFARI browser patch;
-* Added new TOOLBAR button icons set;  
+* Fixed "MISSING PATCH" BUG in NEXUS models rendering;
+* Fixed "TEXTURE WAKE UP" BUG in NEXUS models rendering;
+* Fixed SAFARI browser PATCH for NEXUS models rendering;
+* Fixed MINOR issues in TRACKBALL SET;
+* Updated NEXUS RENDERING and MEMORY ALLOCATION system;
+* Updated and optimized SHADERS SET;
+* Updated TRACKBALL PAN SPEED;
+* Updated COLOR CODED ID feature;
+* Updated MEASUREMENT HANDLER;
+* Added STYLESHEET for viewer informative PANELS;
+* Added ALL TOOL viewer TEMPLATE;
+* Added NEW SHADER for clusters of points/lines;
+* Added TOOLBAR COLOR SWITCH function;
+* Added POINTSIZE setup in SCENE CONFIG;
+* Added mouse RIGHT BUTTON PAN feature;
+* Added REPAINT function;
+* Added support for TEXTURES and POINT CLOUDS for PLY models;
+* Added ORTHOGRAPHIC CAMERA mode and functions;
+* Minified spidergl.js file;
+* Cleanup code and indentation in various .js files;
 
 **Files Added/Modified**
 
-* Added "HOWTO_9.0_planes_sections.html" file;
-* Added "HOWTO_8.1_point_picking.html" file;
-* Updated"HOWTO_8.0_measurement_tool.html" file;
-* Added "HOWTO_4.1_complex_scene" file;
-* Added "trackball_rail.js" file;
+* Added "3DHpanels.css" file;
+* Added "index_all_tools.html" file;
+* Updated "index.html" file and renamed "index_no_tools.html";
+* Updated "HOWTO_8.1_point_picking.html" file;
+* Updated "HOWTO_8.0_measurement_tool.html" file;
 * Updated all "*.js" files;
 * Updated "3dhop.css" file;
 * Updated "docs.html" file;
-* Updated "skins" directory;
-
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 Contact Us @ info@3dhop.net
 
-20 July 2016
+19 December 2016
 
 #### TEAM
 ---------
@@ -22,29 +22,29 @@ Marco Potenziani     @ marco.potenziani@isti.cnr.it
 -------------
 
 - **documentation folder** -> the 3DHOP basic documentation
-  - *img*           -> folder with the 3DHOP basic documentation graphic elements files  
-  - *docs.html*     -> 3DHOP basic documentation HTML file  
+  - *img*                  -> folder with the 3DHOP basic documentation graphic elements files  
+  - *docs.html*            -> 3DHOP basic documentation HTML file  
 
 
-- **minimal folder** -> the 3DHOP minimal version, a ready-to-use viewer in a self-contained folder
-  - *js*            -> folder with the 3DHOP source JavaScript files
-  - *models*        -> folder with the 3D model
-  - *skins*         ->  folder with the toolbar and background graphic elements files
-  - *stylesheet*    ->  folder with the 3DHOP CSS file
-  - *index.html*    ->  3DHOP viewer HTML file  
+- **minimal folder**   -> the 3DHOP minimal version, a ready-to-use viewer in a self-contained folder
+  - *js*               -> folder with the 3DHOP source JavaScript files
+  - *models*           -> folder with the 3D model
+  - *skins*            -> folder with the toolbar and background graphic elements files
+  - *stylesheet*       -> folder with the 3DHOP CSS file
+  - *index_ ... .html* -> 3DHOP templates HTML files  
 
 
-- **examples folder** -> all the 3DHOP examples/howto shown in the 3DHOP website
-  - *js*            -> folder with the 3DHOP source JavaScript files
-  - *models*        -> folder with the single- and multi-resolution 3D models
-  - *skins*         -> folder with the toolbar and background graphic elements files
-  - *stylesheet*    -> folder with the 3DHOP CSS file
+- **examples folder**  -> all the 3DHOP examples/howto shown in the 3DHOP website
+  - *js*               -> folder with the 3DHOP source JavaScript files
+  - *models*           -> folder with the single- and multi-resolution 3D models
+  - *skins*            -> folder with the toolbar and background graphic elements files
+  - *stylesheet*       -> folder with the 3DHOP CSS file
   - *HOWTO_ ... .html* -> 3DHOP HOW-TOs HTML files
 
 
-- **text files** -> basic info texts
+- **text files**       -> basic info texts
   - *CHANGELOG.txt/md* -> the list of the changes in this 3DHOP release
-  - *LICENSE.txt*   -> the GPL license file
+  - *LICENSE.txt*      -> the GPL license file
   - *README.txt/md*    -> this file
 
 #### HOW TO INSTALL
@@ -68,30 +68,30 @@ Once installed the Web server there are just a few step to run 3DHOP:
 
 2. **Browser Tweaking**   
 The simplest way to test the 3DHOP features on your PC _without_ installing any other software, is to allow your browser to access local files on your file system (this practice is disabled by default due to security risk).
-The trick to solve this issue is simple, but is restricted only to the Google CHROME or OPERA browsers.
-On a Windows PC, here are the instructions:
+The trick to solve this issue is simple, but is restricted only to the Google CHROME or OPERA browsers. Here are the instructions (more detailed info about the deployment of 3DHOP can be found in this [pdf](http://3dhop.net/download/3DHOPsite_deployment.pdf)).
+
+   For Windows: 
    + browse to google CHROME (or OPERA) folder in your local file system; 
    + right click on the CHROME (or OPERA) executable file, and select "send to" Desktop as link in the contextual menu;
    + browse to your desktop;
    + right click on the just created CHROME (or OPERA) executable link, and select "properties" in the contextual menu;
    + in the just opened properties window select the "shortcut" tab and edit the "target" field adding to the end of the line "--allow-file-access-from-files", then click on "apply";
    + open your browser from the just edited link on the desktop (now the browser should be enabled to open local files);
    + download and unpack 3DHOP on your PC;
-   + browse the 3DHOP folder and simply drag and drop the desired HTML files inside the opened browser and you are done!  
-For Linux:
-   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter
+   + browse the 3DHOP folder and simply drag and drop the desired HTML files inside the opened browser and you are done!
+
+   For Linux:
+   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter;
    OR
-   + it is possible to create an alias or a desktop shortcut with the parameter, similarly to the Windows PC
-For MacOS:
-   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter. For example, to use Chrome, the command is: "open /Applications/Google\ Chrome.app --args --allow-file-access-from-files"
+   + it is possible to create an alias or a desktop shortcut with the parameter, similarly to the Windows PC.
+
+   For Mac:
+   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter. For example, to use Chrome, the command is: "open /Applications/Google\ Chrome.app --args --allow-file-access-from-files";
    OR
-   + create an appleScript using Automator, that launch the browser using the appropriate parameter 
+   + create an appleScript using Automator, that launch the browser using the appropriate parameter.
 
    [Tip: on FIREFOX, EDGE and SAFARI browsers, there is no simple way to enable the local files access (so, it is recommended to install a Web Server if you need to work with these browser locally). However, by default it supports the use of 3D models in Ply format, so you can use 3DHOP in a limited mode, restricted to single resolution models, but without to perform any procedure or to install nothing.]  
 
-More detailed info on the deployment of 3DHOP can be found in this [pdf](http://3dhop.net/download/3DHOPsite_deployment.pdf).  
-
-
 #### TECHNICAL INFO
 -------------------
 

diff --git a/README.txt b/README.txt
@@ -8,7 +8,7 @@
 
 Contact Us @ info@3dhop.net
 
-20 July 2016
+19 December 2016
 
 #### TEAM
 ---------
@@ -22,29 +22,29 @@ Marco Potenziani     @ marco.potenziani@isti.cnr.it
 -------------
 
 - **documentation folder** -> the 3DHOP basic documentation
-  - *img*           -> folder with the 3DHOP basic documentation graphic elements files  
-  - *docs.html*     -> 3DHOP basic documentation HTML file  
+  - *img*                  -> folder with the 3DHOP basic documentation graphic elements files  
+  - *docs.html*            -> 3DHOP basic documentation HTML file  
 
 
-- **minimal folder** -> the 3DHOP minimal version, a ready-to-use viewer in a self-contained folder
-  - *js*            -> folder with the 3DHOP source JavaScript files
-  - *models*        -> folder with the 3D model
-  - *skins*         ->  folder with the toolbar and background graphic elements files
-  - *stylesheet*    ->  folder with the 3DHOP CSS file
-  - *index.html*    ->  3DHOP viewer HTML file  
+- **minimal folder**   -> the 3DHOP minimal version, a ready-to-use viewer in a self-contained folder
+  - *js*               -> folder with the 3DHOP source JavaScript files
+  - *models*           -> folder with the 3D model
+  - *skins*            -> folder with the toolbar and background graphic elements files
+  - *stylesheet*       -> folder with the 3DHOP CSS file
+  - *index_ ... .html* -> 3DHOP templates HTML files  
 
 
-- **examples folder** -> all the 3DHOP examples/howto shown in the 3DHOP website
-  - *js*            -> folder with the 3DHOP source JavaScript files
-  - *models*        -> folder with the single- and multi-resolution 3D models
-  - *skins*         -> folder with the toolbar and background graphic elements files
-  - *stylesheet*    -> folder with the 3DHOP CSS file
+- **examples folder**  -> all the 3DHOP examples/howto shown in the 3DHOP website
+  - *js*               -> folder with the 3DHOP source JavaScript files
+  - *models*           -> folder with the single- and multi-resolution 3D models
+  - *skins*            -> folder with the toolbar and background graphic elements files
+  - *stylesheet*       -> folder with the 3DHOP CSS file
   - *HOWTO_ ... .html* -> 3DHOP HOW-TOs HTML files
 
 
-- **text files** -> basic info texts
+- **text files**       -> basic info texts
   - *CHANGELOG.txt/md* -> the list of the changes in this 3DHOP release
-  - *LICENSE.txt*   -> the GPL license file
+  - *LICENSE.txt*      -> the GPL license file
   - *README.txt/md*    -> this file
 
 #### HOW TO INSTALL
@@ -68,30 +68,30 @@ Once installed the Web server there are just a few step to run 3DHOP:
 
 2. **Browser Tweaking**   
 The simplest way to test the 3DHOP features on your PC _without_ installing any other software, is to allow your browser to access local files on your file system (this practice is disabled by default due to security risk).
-The trick to solve this issue is simple, but is restricted only to the Google CHROME or OPERA browsers.
-On a Windows PC, here are the instructions:
+The trick to solve this issue is simple, but is restricted only to the Google CHROME or OPERA browsers. Here are the instructions (more detailed info about the deployment of 3DHOP can be found in this [pdf](http://3dhop.net/download/3DHOPsite_deployment.pdf)).
+
+   For Windows: 
    + browse to google CHROME (or OPERA) folder in your local file system; 
    + right click on the CHROME (or OPERA) executable file, and select "send to" Desktop as link in the contextual menu;
    + browse to your desktop;
    + right click on the just created CHROME (or OPERA) executable link, and select "properties" in the contextual menu;
    + in the just opened properties window select the "shortcut" tab and edit the "target" field adding to the end of the line "--allow-file-access-from-files", then click on "apply";
    + open your browser from the just edited link on the desktop (now the browser should be enabled to open local files);
    + download and unpack 3DHOP on your PC;
-   + browse the 3DHOP folder and simply drag and drop the desired HTML files inside the opened browser and you are done!  
-For Linux:
-   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter
+   + browse the 3DHOP folder and simply drag and drop the desired HTML files inside the opened browser and you are done!
+
+   For Linux:
+   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter;
    OR
-   + it is possible to create an alias or a desktop shortcut with the parameter, similarly to the Windows PC
-For MacOS:
-   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter. For example, to use Chrome, the command is: "open /Applications/Google\ Chrome.app --args --allow-file-access-from-files"
+   + it is possible to create an alias or a desktop shortcut with the parameter, similarly to the Windows PC.
+
+   For Mac:
+   + from a shell, it is possible to launch the browsers with the "--allow-file-access-from-files" parameter. For example, to use Chrome, the command is: "open /Applications/Google\ Chrome.app --args --allow-file-access-from-files";
    OR
-   + create an appleScript using Automator, that launch the browser using the appropriate parameter 
+   + create an appleScript using Automator, that launch the browser using the appropriate parameter.
 
    [Tip: on FIREFOX, EDGE and SAFARI browsers, there is no simple way to enable the local files access (so, it is recommended to install a Web Server if you need to work with these browser locally). However, by default it supports the use of 3D models in Ply format, so you can use 3DHOP in a limited mode, restricted to single resolution models, but without to perform any procedure or to install nothing.]  
 
-More detailed info on the deployment of 3DHOP can be found in this [pdf](http://3dhop.net/download/3DHOPsite_deployment.pdf).  
-
-
 #### TECHNICAL INFO
 -------------------