Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
start:plugins:lightweightsurvey:lws-usermanual [2020/08/14 16:28] adminmar |
start:plugins:lightweightsurvey:lws-usermanual [2021/03/15 11:47] adminmar Grammatical and spelling check |
||
---|---|---|---|
Line 3: | Line 3: | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | Lightweight Survey is a plugin for Rhino 6, designed to be used on a windows | + | //Lightweight Survey// is a plugin for Rhino, designed to be used on a Windows |
+ | |||
+ | ===== Installation ===== | ||
+ | ==== Overview ==== | ||
+ | The plugin installer can be downloaded at: [[https:// | ||
+ | A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\ | ||
+ | // | ||
+ | |||
+ | {{page> | ||
+ | |||
+ | {{page> | ||
+ | |||
+ | {{page> | ||
+ | |||
+ | ==== Skin ==== | ||
+ | <WRAP center round todo 60%> | ||
+ | TODO | ||
+ | </ | ||
===== Definitions ===== | ===== Definitions ===== | ||
Line 9: | Line 26: | ||
* __MassPoint: | * __MassPoint: | ||
* __Lightweight Survey____ (LWS): | * __Lightweight Survey____ (LWS): | ||
- | * __Deck: | + | * __Deck: |
- | ===== 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' | |
- | 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. | + | |
{{: | {{: | ||
==== 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). | ||
{{: | {{: | ||
- | |||
=== Result Panel === | === Result Panel === | ||
- | + | The "result" | |
- | The result panel displays real time computed information concerning the model and the current deck, such as the Mass Points global centroid. | + | |
{{: | {{: | ||
- | |||
=== Magic Toolbar === | === Magic Toolbar === | ||
- | + | The "magic toolbar" | |
- | The "magic toolbar" | + | |
{{: | {{: | ||
Line 43: | 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), size, and content of the annotations. |
{{: | {{: | ||
Line 49: | Line 56: | ||
They can be shown/ | They can be shown/ | ||
- | ===== Installation | + | ===== Features and commands |
+ | ==== LWS_License ==== | ||
+ | This command can be used only from the command line prompt. It displays the plugin' | ||
- | ==== Plugin | + | See [[lws-usermanual# |
+ | ---- | ||
+ | ==== LWS_About | ||
+ | This command can be used only from the command line prompt. It displays the plugin' | ||
<WRAP center round todo 60%> | <WRAP center round todo 60%> | ||
TODO | TODO | ||
</ | </ | ||
- | {{page> | + | ---- |
- | {{page> | + | |
- | ==== Skin ==== | + | |
- | <WRAP center round todo 60%> | + | |
- | TODO | + | |
- | </ | + | |
- | ===== Features and commands ===== | + | |
==== Change deck ==== | ==== Change deck ==== | ||
<WRAP center round todo 60%> | <WRAP center round todo 60%> | ||
TODO | TODO | ||
</ | </ | ||
+ | ---- | ||
==== Unselect all ==== | ==== Unselect all ==== | ||
<WRAP center round todo 60%> | <WRAP center round todo 60%> | ||
TODO | TODO | ||
</ | </ | ||
- | |||
- | ==== Autosave ==== | ||
- | <WRAP center round todo 60%> | ||
- | TODO | ||
- | </ | ||
- | |||
- | ==== LWS_About ==== | ||
- | |||
- | This command can be used only from the command line prompt. It displays Lightweight Survey' | ||
- | |||
---- | ---- | ||
- | |||
==== LWS_AddMassPoint ==== | ==== LWS_AddMassPoint ==== | ||
Line 92: | Line 86: | ||
=== Rhino Toolbar shortcut === | === Rhino Toolbar shortcut === | ||
- | The command is cancelled | + | The command is canceled |
=== Magic Toolbar button === | === Magic Toolbar button === | ||
Line 101: | Line 95: | ||
- Start the command | - Start the command | ||
- | - (Optionnal) | + | - (Optional) |
- | - Pick the selection method with the 3 buttons on the right corner: \\ {{: | + | - Pick the selection method with the 3 buttons on the right corner: \\ {{: |
- Pick the MassPoint' | - Pick the MassPoint' | ||
- Select the appropriate data for your MassPoint on the edition window: | - Select the appropriate data for your MassPoint on the edition window: | ||
Line 108: | Line 102: | ||
{{: | {{: | ||
- | The light-red buttons are shortcuts to reuse the values existing in the model. The light-blue buttons are presets | + | The light-red buttons are shortcuts to reuse the values existing in the model. The light-blue buttons are preset |
- | The camera button on the bottom-right corner is a shortcut to windows | + | <del>The camera button on the bottom-right corner is a shortcut to Windows' |
+ | FIXME | ||
---- | ---- | ||
Line 138: | Line 133: | ||
=== Magic Toolbar button === | === Magic Toolbar button === | ||
- | No button on the MagicToolBar. To create a csv report, you have to use the visual | + | No button on the MagicToolBar. To create a CSV report, you have to use the visual report' |
---- | ---- | ||
Line 158: | 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 a touchscreen. |
---- | ---- | ||
Line 166: | Line 161: | ||
__Icon____: | __Icon____: | ||
- | This commands | + | This command |
=== Rhino Toolbar shortcut === | === Rhino Toolbar shortcut === | ||
Line 182: | Line 177: | ||
__Icon____: | __Icon____: | ||
- | 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. | + | 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 192: | 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 204: | Line 199: | ||
__Icon____: | __Icon____: | ||
- | This command | + | This command |
=== Rhino Toolbar shortcut === | === Rhino Toolbar shortcut === | ||
Line 232: | Line 227: | ||
__Icon____: | __Icon____: | ||
- | This commands | + | This command |
=== Rhino Toolbar shortcut === | === Rhino Toolbar shortcut === | ||
Line 252: | Line 247: | ||
{{: | {{: | ||
- | 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. |
{{: | {{: | ||
Line 263: | Line 258: | ||
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 | ||
+ | </ | ||
+ | |||
+ | ==== LWS_Wizard ==== | ||
+ | <WRAP center round todo 60%> | ||
+ | TODO | ||
+ | </ |