Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
start:plugins:marineweightschedule:mws-usermanual [2021/01/07 12:09] adminmar [GBlock_GetList] |
start:plugins:marineweightschedule:mws-usermanual [2021/12/14 15:10] (current) adminmar |
||
---|---|---|---|
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 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. | ||
{{ : | {{ : | ||
=== 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: | ||
* **'' | * **'' | ||
* **'' | * **'' | ||
* **'' | * **'' | ||
+ | * **'' | ||
+ | Two layers with the same name but different materials will not be grouped together. | ||
{{ : | {{ : | ||
Line 64: | Line 66: | ||
For example: | For example: | ||
{{ : | {{ : | ||
+ | <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** | ||
Two kind of curves-defined stiffeners can be used: | Two kind of curves-defined stiffeners can be used: | ||
Line 76: | 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 97: | Line 103: | ||
== Particular case for Blocks == | == Particular case for Blocks == | ||
- | 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 ponctual | + | 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 |
See [[start: | See [[start: | ||
<WRAP center round important 90%> | <WRAP center round important 90%> | ||
- | When the command will process GBlocks, their layer properties will be ignored, and the Gblock' | + | When the command will process GBlocks, their layer properties will be ignored, and their internal definition will be used instead (Name, gravity center, mass). |
</ | </ | ||
Line 112: | Line 118: | ||
{{: | {{: | ||
- | Bill of masses detailed sheets for Volumes, surfaces, curves and points: | + | Bill of masses detailed sheets for Volumes, surfaces, curves, and points: |
{{: | {{: | ||
Line 127: | Line 133: | ||
=== Options === | === Options === | ||
No option available. | No option available. | ||
+ | === Scripted mode === | ||
+ | Using the command' | ||
+ | * **AxisLengthInMeters**: | ||
=== Customization === | === Customization === | ||
- | The excel report template " | + | This command behavior can be customized, by editing some files in the install directory((If you installed from Rhino' |
+ | == Excel templates == | ||
+ | The excel report template " | ||
+ | == 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:// | ||
- | <wrap hi>%AppData%\McNeel\Rhinoceros\7.0\Plug-ins\Marine Weight Schedule for RH6-RH7 (dac6da37-23fc-4ad6-9b46-33a2cad9e13b)\//VersionNumber//</ | + | **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' | ||
+ | <WRAP center round important 90%> | ||
+ | Items((Volumes, surfaces, curves, points, or GBlocks)) located on the plane between two sections will be counted in both sections, leading to a difference between the global weight and the sum of every section' | ||
+ | </ | ||
+ | <WRAP center round info 90%> | ||
+ | Solids((Closed polysurfaces)) __must not__ by split, because the result would be opened polysurfaces, | ||
+ | </ | ||
- | It is recommended to edit only the texts values and the logos, while keeping | + | === 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 150: | Line 188: | ||
<wrap hi> | <wrap hi> | ||
- | + | It is recommended to edit only the text values and the logos while keeping the document' | |
- | It is recommended to edit only the texts values and the logos, while keeping the document general layout. | + | |
---- | ---- | ||
==== GBlock_SetData ==== | ==== GBlock_SetData ==== | ||
- | Add gravity center and mass informations | + | Adds gravity center and mass information |
+ | <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 === | === Walkthrough === | ||
- Start the command | - Start the command | ||
Line 165: | Line 207: | ||
==== GBlock_GetList ==== | ==== GBlock_GetList ==== | ||
- | Lists every existing GBlock | + | Lists every existing GBlock |
=== Walkthrough === | === Walkthrough === | ||
- Start the command | - Start the command | ||
- | - A windows | + | - A window |
{{ : | {{ : | ||
Line 181: | Line 223: | ||
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_Rename ==== | ||
+ | Renames a GBlock definition (Every instance will be renamed) | ||
+ | === Walkthrough === | ||
+ | - Launch the command | ||
+ | - Pick a Gblock from the list | ||
+ | - Enter a new name for the GBlock |