Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start:plugins:lightweightsurvey:lws-usermanual [2021/01/11 15:56]
adminmar
start:plugins:lightweightsurvey:lws-usermanual [2021/11/04 14:28]
adminmar
Line 3: Line 3:
 ===== Introduction ===== ===== Introduction =====
  
-//Lightweight Survey// is a plugin for Rhino, designed to be used on a windows 10 tablet. It'purpose is to write down every excess or missing masses in a ship, then process the data into various reports.+//Lightweight Survey// is a plugin for Rhino, designed to be used on a Windows 10 tablet. Its purpose is to write down every excess or missing masses in a ship, then process the data into various reports.
  
 ===== Installation ===== ===== Installation =====
Line 9: Line 9:
 The plugin installer can be downloaded at: [[https://www.tomkod.com/product/lightweight-survey/]]\\  The plugin installer can be downloaded at: [[https://www.tomkod.com/product/lightweight-survey/]]\\ 
 A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\  A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\ 
-//Lightweight Survey// is developped for Rhino 6((Rhino6.15 or later)), it might work with Rhino7 versions but it has not been tested yet.+//Lightweight Survey// is developed for Rhino 6((Rhino 6.15 or higher)), it might work with Rhino 7 but this has not been tested yet.
  
 {{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}} {{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}}
Line 26: Line 26:
   * __MassPoint:__  Custom rhino object with mass and location   * __MassPoint:__  Custom rhino object with mass and location
   * __Lightweight Survey____ (LWS):__  A rhino doc is considered to be a Lightweight Survey if it has at least one Deck   * __Lightweight Survey____ (LWS):__  A rhino doc is considered to be a Lightweight Survey if it has at least one Deck
-  * __Deck:__  Special Layer with LWS related data (Height, Room names, etc…)+  * __Deck:__  Special Layer with LWS-related data (Height, Room names, etc…)
  
 ===== Interface ===== ===== Interface =====
 ==== Skin ==== ==== Skin ====
-The skin is a custom interface for your plugin. When you launch the skin, you'll have a rhino interface customized just for the Lightweight Survey Plugin. Any change to this interface will not be applied to rhino main interface.+The skin is a custom interface for your plugin. When you launch the skin, you'll have a rhino interface customized just for the Lightweight Survey Plugin. Any change to this interface will not be applied to Rhino'main interface.
 {{:start:plugins:lightweightsurvey:skincapture.jpg?nolink&1026x538|skincapture.jpg}} {{:start:plugins:lightweightsurvey:skincapture.jpg?nolink&1026x538|skincapture.jpg}}
  
Line 38: Line 38:
 {{:start:plugins:lightweightsurvey:skincapture_-_mainpanel.jpg?nolink&1026x538|skincapture_-_mainpanel.jpg}} {{:start:plugins:lightweightsurvey:skincapture_-_mainpanel.jpg?nolink&1026x538|skincapture_-_mainpanel.jpg}}
 === Result Panel === === Result Panel ===
-The result panel displays real time computed information concerning the model and the current deck, such as the Mass Points global centroid.+The "resultpanel displays real-time computed information concerning the model and the current deck, such as the Mass Points global centroid.
 {{:start:plugins:lightweightsurvey:skincapture_-_resultpanel.jpg?nolink&1026x538|skincapture_-_resultpanel.jpg}} {{:start:plugins:lightweightsurvey:skincapture_-_resultpanel.jpg?nolink&1026x538|skincapture_-_resultpanel.jpg}}
 === Magic Toolbar === === Magic Toolbar ===
-The "magic toolbar" is a panel that mimics classic Rhino ToolBar but with dynamic and contextual display. This toolbar will be your best friend while working on a touchscreen.+The "magic toolbar" is a panel that mimics classic Rhino ToolBar but with dynamic and contextual display. This toolbar will be your best friend while working on a touchscreen.
 {{:start:plugins:lightweightsurvey:skincapture_-_magictoolbar.jpg?nolink&1026x538|skincapture_-_magictoolbar.jpg}} {{:start:plugins:lightweightsurvey:skincapture_-_magictoolbar.jpg?nolink&1026x538|skincapture_-_magictoolbar.jpg}}
  
Line 50: Line 50:
 ==== Annotations ==== ==== Annotations ====
  
-The annotations system displays MassPoints related data in text dots. In the Options panel, you can define the colors (For excess and missing masses), size and content of the annotations.+The annotations system displays MassPoints related data in text dots. In the Options panel, you can define the colors (For excess and missing masses), sizeand content of the annotations.
  
 {{:start:plugins:lightweightsurvey:captureannotation.jpg?nolink&200x61|captureannotation.jpg}} {{:start:plugins:lightweightsurvey:captureannotation.jpg?nolink&200x61|captureannotation.jpg}}
Line 86: Line 86:
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
  
-The command is cancelled if the document is not a valid Lightweight Survey.+The command is canceled if the document is not a valid Lightweight Survey.
  
 === Magic Toolbar button === === Magic Toolbar button ===
Line 95: Line 95:
  
   - Start the command   - Start the command
-  - (Optionnal+  - (Optional
-  - Pick the selection method with the 3 buttons on the right corner: \\ {{:start:plugins:lightweightsurvey:getcustomlocationcapture.jpg?nolink&240x132|getcustomlocationcapture.jpg}} \\ The location can be picked with a point (default), a line's middle or a rectangle's center.+  - Pick the selection method with the 3 buttons on the right corner: \\ {{:start:plugins:lightweightsurvey:getcustomlocationcapture.jpg?nolink&240x132|getcustomlocationcapture.jpg}} \\ The location can be picked with a point (default), a line's middleor a rectangle's center.
   - Pick the MassPoint's location. If the command was started from the MagicToolBar, the selection helper will be displayed.   - Pick the MassPoint's location. If the command was started from the MagicToolBar, the selection helper will be displayed.
   - Select the appropriate data for your MassPoint on the edition window:   - Select the appropriate data for your MassPoint on the edition window:
Line 102: Line 102:
 {{:start:plugins:lightweightsurvey:capturemasspointeditor.jpg?nolink&1212x427|capturemasspointeditor.jpg}} {{:start:plugins:lightweightsurvey:capturemasspointeditor.jpg?nolink&1212x427|capturemasspointeditor.jpg}}
  
-The light-red buttons are shortcuts to reuse the values existing in the model. The light-blue buttons are presets values defined in the LWS_Options.+The light-red buttons are shortcuts to reuse the values existing in the model. The light-blue buttons are preset values defined in the LWS_Options.
  
-The camera button on the bottom-right corner is a shortcut to windows camera app. While this "MassPoint Editor" window is open, any picture added or created in windows picture directory will be linked the the MassPoint.+<del>The camera button on the bottom-right corner is a shortcut to Windows' camera app. While this "MassPoint Editor" window is open, any picture added or created in Windows' picture directory will be linked to the MassPoint.</del> 
 +FIXME
  
 ---- ----
Line 132: Line 133:
 === Magic Toolbar button === === Magic Toolbar button ===
  
-No button on the MagicToolBar. To create a csv report, you have to use the visual report report's window menu instead.+No button on the MagicToolBar. To create a CSV report, you have to use the visual report's window menu instead.
  
 ---- ----
Line 152: Line 153:
 === Magic Toolbar button === === Magic Toolbar button ===
  
-This button is grayed out if the document is not a valid Lightweight Survey. The helpers are displayed to select the MassPoint on touchscreen.+This button is grayed out if the document is not a valid Lightweight Survey. The helpers are displayed to select the MassPoint on touchscreen.
  
 ---- ----
Line 160: Line 161:
 __Icon____:__  {{:dokuship:methodes:rhino:msw:msp_hideannotations_32.png?nolink&32x32}} __Icon____:__  {{:dokuship:methodes:rhino:msw:msp_hideannotations_32.png?nolink&32x32}}
  
-This commands hides every MassPoints annotations.+This command hides every MassPoints annotation.
  
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
Line 176: Line 177:
 ​​​​​__Icon____:__  {{:dokuship:methodes:rhino:msw:msp_importpicturedoc_32.png?nolink&32x32}} ​​​​​__Icon____:__  {{:dokuship:methodes:rhino:msw:msp_importpicturedoc_32.png?nolink&32x32}}
  
-This commands imports a .jpg file to the docand helps you to scale it and split it into several layers. This will make it easier to create your decks from a scanned drawing.+This commands imports a .jpg file to the doc and helps you to scale it and split it into several layers. This will make it easier to create your decks from a scanned drawing.
  
 ---- ----
Line 186: Line 187:
 === Magic Toolbar button only === === Magic Toolbar button only ===
  
-This command does basically the same thing as the Rhino Move command, but it only considers MassPoints. The helpers are displayed to select the MassPoint and the new location on touchscreen.+This command does basically the same thing as the Rhino Move command, but it only considers MassPoints. The helpers are displayed to select the MassPoint and the new location on the touchscreen.
  
 ---- ----
Line 198: Line 199:
 ​​​​__Icon____:__  {{:dokuship:methodes:rhino:msw:msp_refresh_32.png?nolink&32x32}} ​​​​__Icon____:__  {{:dokuship:methodes:rhino:msw:msp_refresh_32.png?nolink&32x32}}
  
-This command refresh most LWS related display and data. You normally don't need it.+This command refreshes most LWS-related display and data. You normally don't need it.
  
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
Line 226: Line 227:
 __Icon____:__  {{:dokuship:methodes:rhino:msw:msp_showannotations_32.png?nolink&32x32}} __Icon____:__  {{:dokuship:methodes:rhino:msw:msp_showannotations_32.png?nolink&32x32}}
  
-This commands shows every MassPoints annotations.+This command shows every MassPoints annotation.
  
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
Line 246: Line 247:
 {{:start:plugins:lightweightsurvey:capturevisualreport.jpg?nolink&1211x557|capturevisualreport.jpg}} {{:start:plugins:lightweightsurvey:capturevisualreport.jpg?nolink&1211x557|capturevisualreport.jpg}}
  
-From the menu, the report can be printed, or exported as HTML, XLSX or CSV.+From the menu, the report can be printed, or exported as HTML, XLSXor CSV.
  
 {{:start:plugins:lightweightsurvey:capturevisualreportexport.jpg?nolink&489x124|capturevisualreportexport.jpg}} {{:start:plugins:lightweightsurvey:capturevisualreportexport.jpg?nolink&489x124|capturevisualreportexport.jpg}}