Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
start:plugins:marineweightschedule:mws-usermanual [2021/01/05 10:34] adminmar [MWS_About] |
start:plugins:marineweightschedule:mws-usermanual [2021/12/14 15:00] adminmar [ProjectWeightReport] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Marine Weight Schedule - User Manual ====== | ====== Marine Weight Schedule - User Manual ====== | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | //Marine Weight Schedule// is a plugin for Rhino 3D designed to generate - from a vessel’s 3D model - a bill of masses/ | + | //Marine Weight Schedule// is a plugin for Rhino 3D designed to generate - from a vessel’s 3D model - a bill of masses/ |
- | A command is also provided to generate | + | A command is also provided to generate |
- | Both reports will be generated as excel files (.xlsx) based on a customizable template, but microsoft | + | Both reports will be generated as excel files (.xlsx) based on a customizable template, but Microsoft |
===== Plugin installation ===== | ===== Plugin installation ===== | ||
==== Overview ==== | ==== Overview ==== | ||
The plugin installer can be downloaded at: [[https:// | The plugin installer can be downloaded at: [[https:// | ||
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.\\ | ||
- | //Marine Weight Schedule // works for Rhino 6((Rhino6.15 or later)) and Rhino7((Tested up to Rhino 7.1)). | + | //Marine Weight Schedule // works with Rhino 6((Rhino 6.15 or higher)) and Rhino7((Rhino 7.5 or higher)). |
{{page> | {{page> | ||
Line 17: | Line 17: | ||
{{page> | {{page> | ||
+ | {{ : | ||
===== Features and commands ===== | ===== Features and commands ===== | ||
==== MWS_About ==== | ==== MWS_About ==== | ||
Line 31: | Line 31: | ||
=== Walkthrough === | === Walkthrough === | ||
For each layer((The whole model or worksession will be used)), the command will retrieve the //Mass//, //Margin// and //Vertical offset// values from the layer name((Read "Model preparation" | For each layer((The whole model or worksession will be used)), the command will retrieve the //Mass//, //Margin// and //Vertical offset// values from the layer name((Read "Model preparation" | ||
- | - For each rhino object, the actual mass and gravity center will be computed, using the layer values. The layer' | + | - For each rhino object, the actual mass and gravity center will be computed, using the layer values. The layer' |
- At the same time, the Bill-of-Materials will be created internally. | - At the same time, the Bill-of-Materials will be created internally. | ||
- An excel report will be created. | - An excel report will be created. | ||
- | <WRAP center round todo 60%> | + | {{ : |
- | Add images | + | |
- | </ | + | |
=== Model preparation === | === Model preparation === | ||
- | The fondamental | + | The fundamental |
For example: // | For example: // | ||
- | * The layer **'' | + | * The layer **'' |
- | * The layer **'' | + | * The layer **'' |
== Layers naming convention == | == Layers naming convention == | ||
The document' | The document' | ||
- | < | + | < |
where: | where: | ||
* **'' | * **'' | ||
* **'' | * **'' | ||
* **'' | * **'' | ||
- | {{ : | + | * **'' |
- | <WRAP center round todo 60%> | + | Two layers with the same name but different materials will not be grouped together. |
- | Add images | + | {{ : |
- | </ | + | |
== Particular case for Stiffeners == | == Particular case for Stiffeners == | ||
Line 68: | Line 65: | ||
</ | </ | ||
For example: | For example: | ||
- | <WRAP center round todo 60%> | + | {{ : |
- | Add screen capture | + | <WRAP center round tip 90%> |
+ | Since v1.1.3, the implicit stiffeners can also have their material names defined with a specific syntax: | ||
+ | < | ||
</ | </ | ||
* **Stiffeners defined as curves in the model** | * **Stiffeners defined as curves in the model** | ||
Line 83: | Line 82: | ||
This will count as one surface, Thickness 6, width=120, plus one profile 80x8 | This will count as one surface, Thickness 6, width=120, plus one profile 80x8 | ||
<WRAP center round info 80%> | <WRAP center round info 80%> | ||
- | In this case, the command will output an area for the plate, and a length for the profile: | + | In this case, the command will output an area for the plate and a length for the profile: |
'Th.6 plate Area' = length x 120 | 'Th.6 plate Area' = length x 120 | ||
Line 102: | Line 101: | ||
'80x8 profile Length' | '80x8 profile Length' | ||
</ | </ | ||
+ | |||
== Particular case for Blocks == | == Particular case for Blocks == | ||
- | <WRAP center round todo 60%> | + | By default, rhino(r) blocks((instances references)) are ignored by the command. However, we provide several commands to transform blocks into GBlocks, which are considered in the reports as punctual masses. |
- | todo | + | |
+ | See [[start: | ||
+ | |||
+ | <WRAP center round important 90%> | ||
+ | When the command will process GBlocks, their layer properties will be ignored, and their internal definition will be used instead (Name, gravity center, mass). | ||
</ | </ | ||
+ | |||
+ | |||
=== Output === | === Output === | ||
- | An excel report is generated: | + | When the whole model has been processed, an excel((.xlsx)) |
- | {{ : | + | Bill of masses main sheet: |
- | <WRAP center round todo 60%> | + | |
- | Add images | + | {{: |
- | </ | + | |
+ | Bill of masses detailed sheets for Volumes, surfaces, curves, and points: | ||
+ | |||
+ | {{: | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Bill of materials: | ||
+ | |||
+ | {{: | ||
A custom ViewPort is created with the gravity center displayed: | A custom ViewPort is created with the gravity center displayed: | ||
- | {{ : | + | |
- | <WRAP center round todo 60%> | + | {{: |
- | Add images | + | |
- | </ | + | |
=== Options === | === Options === | ||
No option available. | No option available. | ||
+ | === Scripted mode === | ||
+ | Using the command' | ||
+ | * **AxisLengthInMeters**: | ||
=== Customization === | === Customization === | ||
- | The excel file template can be modified in the plugin' | + | This command behavior can be customized, by editing some files in the install directory((If you installed from Rhino' |
- | <WRAP center round todo 60%> | + | == Excel templates == |
- | add details | + | The excel report |
+ | == Naming conventions for the layers == | ||
+ | The naming convention for information specified | ||
+ | <WRAP center round tip 90%> | ||
+ | We recommend using the free text editor NotePad++ will make the YAML format more readable: | ||
+ | {{ : | ||
</ | </ | ||
+ | You can test in real-time your customized regular expressions at [[https:// | ||
+ | |||
+ | **Example1**: | ||
+ | |||
+ | **Example2**: | ||
+ | ---- | ||
+ | ==== ProjectWeightReportByHullSection ==== | ||
+ | This command((From v1.2.0)) splits the model into sections, then runs // | ||
+ | The resulting Excel file will contain the usual model-wide report, plus independent reports for every section. (Named from S001 to Sxxx) | ||
+ | {{ : | ||
+ | |||
+ | === Walkthrough === | ||
+ | - Run the command // | ||
+ | - Pick the x-axis coordinates delimiting the sections((The coordinates can be registered either by clicking on the model or by entering numbers in the command line.)). | ||
+ | - The script will split internally the curves and surfaces, and sort points and volumes by each section' | ||
+ | === Scripted mode === | ||
+ | Using the command' | ||
+ | * **AxisLengthInMeters**: | ||
+ | * **DrawSplittedGeometries**: | ||
---- | ---- | ||
==== HydrostaticReport ==== | ==== HydrostaticReport ==== | ||
- | Computes | + | Computes |
=== Walkthrough === | === Walkthrough === | ||
The hull's surface or polysurface is selected as input. | The hull's surface or polysurface is selected as input. | ||
- | Once validated, Rhino' | + | Once validated, Rhino' |
{{ : | {{ : | ||
=== Options === | === Options === | ||
Line 138: | Line 179: | ||
^ AutoMinMax | Detect TEMin and TEmax values from geometry (Only available when a geometry is selected)| | ^ AutoMinMax | Detect TEMin and TEmax values from geometry (Only available when a geometry is selected)| | ||
=== Customization === | === Customization === | ||
- | The excel file template can be edited | + | The excel report |
+ | |||
+ | <wrap hi> | ||
+ | It is recommended to edit only the text values and the logos while keeping the document' | ||
+ | ---- | ||
+ | ==== GBlock_SetData ==== | ||
+ | Adds gravity center and mass information to a block. GBlocks are considered by the command // | ||
+ | <WRAP center round info 90%> | ||
+ | When using this command on an existing GBlock, its gravity center, mass information, | ||
+ | |||
+ | This is the only way to edit a GBlock name or data. | ||
+ | </ | ||
+ | === Walkthrough === | ||
+ | - Start the command | ||
+ | - Pick a rhino block((Instance reference)) in the model | ||
+ | - Pick the GBlock' | ||
+ | - Enter the GBlock' | ||
+ | - Enter the GBlock' | ||
+ | - Click OK or press Enter | ||
+ | {{ : | ||
==== GBlock_GetList ==== | ==== GBlock_GetList ==== | ||
- | Lists every existing GBlock | + | Lists every existing GBlock |
=== Walkthrough === | === Walkthrough === | ||
- | <WRAP center round todo 60%> | + | - Start the command |
- | Todo | + | - A window is shown with details about every block instances in the model |
- | </ | + | {{ : |
==== GBlock_ReadData ==== | ==== GBlock_ReadData ==== | ||
- | Read a GBlock data. | + | Reads a GBlock data. |
=== Walkthrough === | === Walkthrough === | ||
- | <WRAP center round todo 60%> | + | - Select a GBlock |
- | Todo | + | - The data is shown in the command line: |
- | </ | + | {{: |
==== Gblock_Select ==== | ==== Gblock_Select ==== | ||
Select a block by their GBlock Name. (From a list of available GBlock names) | Select a block by their GBlock Name. (From a list of available GBlock names) | ||
=== Walkthrough === | === Walkthrough === | ||
- | <WRAP center round todo 60%> | + | - Launch the command |
- | Todo | + | - Pick a GBlock name from the list |
- | </ | + | - Every instance of this GBlock will be selected in the model |
+ | {{ : | ||
==== GBlock_SelectNextMissingData ==== | ==== GBlock_SelectNextMissingData ==== | ||
- | Select | + | Selects |
=== Walkthrough === | === Walkthrough === | ||
- | <WRAP center round todo 60%> | + | - Launch the command |
- | Todo | + | - The commands loops between the non-GBlocks instances in the model. (Press ESC to leave) |
- | </ | + | {{ : |
- | ==== GBlock_SetData | + | ==== GBlock_Rename |
- | Add gravity center and mass informations to a block. GBlocks | + | Renames |
=== Walkthrough === | === Walkthrough === | ||
- | <WRAP center round todo 60%> | + | - Launch the command |
- | Todo | + | - Pick a Gblock from the list |
- | </ | + | - Enter a new name for the GBlock |