====== Lightweight Survey -User Manual ====== ===== Introduction ===== //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 ===== ==== 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 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#[License activation]&noindent&nofooter&nodate}} {{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}} ==== Skin ==== TODO ===== Definitions ===== * __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 * __Deck:__ Special Layer with LWS-related data (Height, Room names, etc…) ===== Interface ===== ==== 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's main interface. {{:start:plugins:lightweightsurvey:skincapture.jpg?nolink&1026x538|skincapture.jpg}} ==== Panels ==== === Main Panel === 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}} === Result Panel === 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}} === Magic Toolbar === The "magic toolbar" is a panel that mimics classic Rhino ToolBar but with a 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}} ==== Rhino ToolBar ==== 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}} ==== 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. {{: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'' ===== Features and commands ===== ==== LWS_License ==== This command can be used only from the command line prompt. It displays the plugin's activation form. 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. TODO ---- ==== Change deck ==== TODO ---- ==== Unselect all ==== TODO ---- ==== LWS_AddMassPoint ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_addmasspoint_32.png?nolink&32x32}} This command creates a new MassPoint in the current deck. === Rhino Toolbar shortcut === The command is canceled if the document is not a valid Lightweight Survey. === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. === Usage === - Start the command - (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 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: {{: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 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 to the MassPoint. FIXME ---- ==== LWS_Copy ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_copy_32.png?nolink&32x32}} This command relocates a MassPoint to a new location. === Magic Toolbar button only === This button is grayed out if the document is not a valid Lightweight Survey. The command asks for a MassPoint then a new location, and the touchscreen helpers are displayed. ---- ==== LWS_CsvReport ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_csvreport_32.png?nolink&32x32}} This command generates a CSV (Semicolon Separated Value) report. === Rhino Toolbar shortcut === The command is exited if the document is not a valid Lightweight Survey. In scripted mode, the command saves the report as "MyRhinoDocName.csv" === Magic Toolbar button === No button on the MagicToolBar. To create a CSV report, you have to use the visual report's window menu instead. ---- ==== LWS_EditMassPoint ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_editmasspoint_32.png?nolink&32x32}} This command is similar to LWS_AddMassPoint, except that the values are applied to a previously selected MassPoint. Other than that, the main difference is that the "Remove" button is enabled, allowing a MassPoint's removal: {{:start:plugins:lightweightsurvey:capturebuttondeletemp.jpg?nolink&127x33|capturebuttondeletemp.jpg}} === Rhino Toolbar shortcut === The command is exited if the document is not a valid Lightweight Survey. === 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 a touchscreen. ---- ==== LWS_HideAnnotations ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_hideannotations_32.png?nolink&32x32}} This command hides every MassPoints annotation. === Rhino Toolbar shortcut === The command is exited if the document is not a valid Lightweight Survey. === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. Else it works as a switch (Grayed when disabled, Green colored when enabled) ---- ==== LWS_ImportPictureDoc ==== ​​​​​__Icon____:__ {{:dokuship:methodes:rhino:msw:msp_importpicturedoc_32.png?nolink&32x32}} 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. ---- ==== LWS_Move ==== ​​​​​__Icon____:__ {{:dokuship:methodes:rhino:msw:msp_move_32.png?nolink&32x32}} === 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 the touchscreen. ---- ==== LWS_Options ==== ---- ==== LWS_Refresh ==== ​​​​__Icon____:__ {{:dokuship:methodes:rhino:msw:msp_refresh_32.png?nolink&32x32}} This command refreshes most LWS-related display and data. You normally don't need it. === Rhino Toolbar shortcut === The command is exited if the document is not a valid Lightweight Survey. === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. ---- ==== LWS_RelocateDecksToOrigin ==== ---- ==== LWS_Select ==== === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. ---- ==== LWS_ShowAnnotations ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_showannotations_32.png?nolink&32x32}} This command shows every MassPoints annotation. === Rhino Toolbar shortcut === The command is exited if the document is not a valid Lightweight Survey. === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. Else it works as a switch (Grayed when disabled, Green colored when enabled) ---- ==== LWS_VisualReport ==== __Icon____:__ {{:dokuship:methodes:rhino:msw:msp_visualreport_32.png?nolink&32x32}} This command displays a visual HTML report on the current Lightweight Survey. {{:start:plugins:lightweightsurvey:capturevisualreport.jpg?nolink&1211x557|capturevisualreport.jpg}} From the menu, the report can be printed, or exported as HTML, XLSX, or CSV. {{:start:plugins:lightweightsurvey:capturevisualreportexport.jpg?nolink&489x124|capturevisualreportexport.jpg}} === Rhino Toolbar shortcut === The command creates an empty report if the document is not a valid Lightweight Survey. === Magic Toolbar button === This button is grayed out if the document is not a valid Lightweight Survey. ==== LWS_Enable_Disable ==== TODO ==== LWS_Wizard ==== TODO