Differences

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

Link to this comparison view

Next revision 		Previous revision
Next revision Both sides next revision
start:plugins:lightweightsurvey:lws-usermanual [2020/08/14 10:32]
adminmar created 		start:plugins:lightweightsurvey:lws-usermanual [2021/01/11 15:56]
adminmar
Line 3: Line 3:
 ===== Introduction ===== ===== Introduction =====
  
-Lightweight Survey is a plugin for Rhino 6, designed to be used on a windows 10 tablet. It's 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. It's purpose is to write down every excess or missing masses in a ship, then process the data into various reports. 
 + 
 +===== Installation ===== 
 +==== Overview ==== 
 +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.\\  
 +//Lightweight Survey// is developped for Rhino 6((Rhino6.15 or later)), it might work with Rhino7 versions but it has not been tested yet. 
 + 
 +{{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}} 
 + 
 +{{page>start:plugins:common#[License activation]&noindent&nofooter&nodate}} 
 + 
 +{{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}} 
 + 
 +==== Skin ==== 
 +<WRAP center round todo 60%> 
 +TODO 
 +</WRAP>
  
 ===== Definitions ===== ===== Definitions =====
Line 10: Line 27:
   * __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}}
-{{:dokuship:methodes:rhino:msp:skincapture.jpg?nolink&1026x538|skincapture.jpg}}+
  
 ==== Panels ==== ==== Panels ====
- +=== Main Panel ===
-Main Panel +
 The main panel is where you will find every available information on the selected MassPoint(s). The main panel is where you will find every available information on the selected MassPoint(s).
- +{{:start:plugins:lightweightsurvey:skincapture_-_mainpanel.jpg?nolink&1026x538|skincapture_-_mainpanel.jpg}}
-{{:dokuship:methodes:rhino:msp: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 result panel 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}}
-{{:dokuship:methodes:rhino:msp: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}}
-{{:dokuship:methodes:rhino:msp:skincapture_-_magictoolbar.jpg?nolink&1026x538|skincapture_-_magictoolbar.jpg}}+
  
 ==== Rhino ToolBar ==== ==== Rhino ToolBar ====
- +The toolbar is only meant to be used when preparing the model on a desktop computer.\\  
-The toolbar is only meant to be used when preparing the model on a desktop computer. +{{:start:plugins:lightweightsurvey:toolbarcapture.jpg?nolink&388x33|toolbarcapture.jpg}}
- +
-{{:dokuship:methodes:rhino:msp:toolbarcapture.jpg?nolink&388x33|toolbarcapture.jpg}}+
  
 ==== Annotations ==== ==== Annotations ====
Line 48: Line 52:
 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), size and content of the annotations.
  
-{{:dokuship:methodes:rhino:msp:captureannotation.jpg?nolink&200x61|captureannotation.jpg}}+{{:start:plugins:lightweightsurvey:captureannotation.jpg?nolink&200x61|captureannotation.jpg}}
  
 They can be shown/hidden anytime through the magic toolbar or the command ''LWS_HideAnnotations''  and ''LWS_ShowAnnotations'' They can be shown/hidden anytime through the magic toolbar or the command ''LWS_HideAnnotations''  and ''LWS_ShowAnnotations''
  
-===== Installation =====+===== Features and commands ===== 
 +==== LWS_License ==== 
 +This command can be used only from the command line prompt. It displays the plugin's activation form.
  
-==== Plugin ====+See [[lws-usermanual#license_activation]]. 
 +---- 
 +==== LWS_About ==== 
 +This command can be used only from the command line prompt. It displays the plugin's current revision and license status.
 <WRAP center round todo 60%> <WRAP center round todo 60%>
 TODO TODO
 </WRAP> </WRAP>
-==== Toolbar ==== +----
-<WRAP center round todo 60%> +
-TODO +
-</WRAP> +
-==== Skin ==== +
-<WRAP center round todo 60%> +
-TODO +
-</WRAP> +
-===== Features and commands ===== +
 ==== Change deck ==== ==== Change deck ====
 <WRAP center round todo 60%> <WRAP center round todo 60%>
 TODO TODO
 </WRAP> </WRAP>
 +----
 ==== Unselect all ==== ==== Unselect all ====
 <WRAP center round todo 60%> <WRAP center round todo 60%>
 TODO TODO
 </WRAP> </WRAP>
- 
-==== Autosave ==== 
-<WRAP center round todo 60%> 
-TODO 
-</WRAP> 
- 
-==== LWS_About ==== 
- 
-This command can be used only from the command line prompt. It displays Lightweight Survey's current revision and license status. 
- 
 ---- ----
- 
 ==== LWS_AddMassPoint ==== ==== LWS_AddMassPoint ====
  
Line 107: Line 96:
   - Start the command   - Start the command
   - (Optionnal)   - (Optionnal)
-  - Pick the selection method with the 3 buttons on the right corner: \\ {{:dokuship:methodes:rhino:msp: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 middle or 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:
  
-{{:dokuship:methodes:rhino:msp: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 presets values defined in the LWS_Options.
Line 155: Line 144:
 Other than that, the main difference is that the "Remove" button is enabled, allowing a MassPoint's removal: Other than that, the main difference is that the "Remove" button is enabled, allowing a MassPoint's removal:
  
-{{:dokuship:methodes:rhino:msp:capturebuttondeletemp.jpg?nolink&127x33|capturebuttondeletemp.jpg}}+{{:start:plugins:lightweightsurvey:capturebuttondeletemp.jpg?nolink&127x33|capturebuttondeletemp.jpg}}
  
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
Line 255: Line 244:
 This command displays a visual HTML report on the current Lightweight Survey. This command displays a visual HTML report on the current Lightweight Survey.
  
-{{:dokuship:methodes:rhino:msp: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, XLSX or CSV.
  
-{{:dokuship:methodes:rhino:msp:capturevisualreportexport.jpg?nolink&489x124|capturevisualreportexport.jpg}}+{{:start:plugins:lightweightsurvey:capturevisualreportexport.jpg?nolink&489x124|capturevisualreportexport.jpg}}
  
 === Rhino Toolbar shortcut === === Rhino Toolbar shortcut ===
Line 268: Line 257:
  
 This button is grayed out if the document is not a valid Lightweight Survey. This button is grayed out if the document is not a valid Lightweight Survey.
 +
 +==== LWS_Enable_Disable ====
 +<WRAP center round todo 60%>
 +TODO
 +</WRAP>
 +
 +==== LWS_Wizard ====
 +<WRAP center round todo 60%>
 +TODO
 +</WRAP>
start/plugins/lightweightsurvey/lws-usermanual.txt · Last modified: 2021/11/04 14:28 by adminmar
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International


  • Show page
  • Old revisions
  • Export to PDF
  • Backlinks
  • Recent Changes
  • Media Manager
  • Sitemap