Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
start:plugins:marineweightschedule:mws-usermanual [2021/03/15 11:52]
adminmar Grammatical and spelling check
start:plugins:marineweightschedule:mws-usermanual [2021/12/14 15:10]
adminmar [ProjectWeightReportByHullSection]
Line 10: Line 10:
 The plugin installer can be downloaded at: [[https://www.tomkod.com/product/marine-weight-schedule/]] \\  The plugin installer can be downloaded at: [[https://www.tomkod.com/product/marine-weight-schedule/]] \\ 
 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>start:plugins:common#[Yak]&noindent&nofooter&nodate}} {{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}}
Line 42: Line 42:
 == Layers naming convention == == Layers naming convention ==
 The document's layers should follow the following naming convention: The document's layers should follow the following naming convention:
-<code>LayerName (Mass) %Margin% |VerticalOffset|</code>+<code>LayerName *MaterialName* (Mass) %Margin% |VerticalOffset|</code>
 where: where:
   * **''%%Mass%%''** will be the ponctual/lineic/surfacic/volumic mass   * **''%%Mass%%''** will be the ponctual/lineic/surfacic/volumic mass
   * **''%%Margin%%''** (optional) will be the percentage to add to the object's mass.   * **''%%Margin%%''** (optional) will be the percentage to add to the object's mass.
   * **''%%VerticalOffset%%''** (optional) will be the the vertical offset to apply to the layer's masses   * **''%%VerticalOffset%%''** (optional) will be the the vertical offset to apply to the layer's masses
 +  * **''%%MaterialName%%''**((Since v1.1.3)) (optional) will the material's name. In the Bill-of-Material, the materials are displayed in a specific column. 
 +Two layers with the same name but different materials will not be grouped together.
 {{ :start:plugins:marineweightschedule:pwr_layers2.jpg?nolink |}} {{ :start:plugins:marineweightschedule:pwr_layers2.jpg?nolink |}}
  
Line 64: Line 66:
 For example: For example:
 {{ :start:plugins:marineweightschedule:pwr_layersimplicitstiffeners.jpg?nolink |}} {{ :start:plugins:marineweightschedule:pwr_layersimplicitstiffeners.jpg?nolink |}}
 +<WRAP center round tip 90%>
 +Since v1.1.3, the implicit stiffeners can also have their material names defined with a specific syntax:
 +<code>LAYERNAME:   MyLayerName *MaterialName* (Mass) %Margin% |VerticalOffset| [StiffenerName s=value *MaterialName*]</code>
 +</WRAP>
   * **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 127: Line 133:
 ===  Options ===  ===  Options === 
 No option available. No option available.
 +=== Scripted mode ===
 +Using the command's scripted mode //-ProjectWeightReportByHullSection// will enable an hidden option:
 +  * **AxisLengthInMeters**: Enter the gravity center's preview axis length used in the result views
 === Customization === === Customization ===
-The excel report template "PWE_Model.xlsx" can be modified in the plugin'install directoryusually:+This command behavior can be customized, by editing some files in the install directory((If you installed from Rhino's package manager, the installation path is usually: ''%%%appdata%\McNeel\Rhinoceros\7.0\Plug-ins%%'')). 
 +== Excel templates == 
 +The excel report template "PWE_Model.xlsx" can be modified to fit your graphical needs, however, it is recommended to edit only the text values, the column sizes, and the logos while keeping the document's general layout. 
 +== Naming conventions for the layers == 
 +The naming convention for information specified in the layer'names is based on REGEX (Regular expression)which is the most common way to match a text string to a pattern. The default values can be edited in the file "MWS_CustomRegex.yaml" with any standard text editor. 
 +<WRAP center round tip 90%> 
 +We recommend using the free text editor NotePad++ will make the YAML format more readable: 
 +{{ :start:plugins:marineweightschedule:mws_customregex.jpg?nolink |}} 
 +</WRAP> 
 +You can test in real-time your customized regular expressions at [[https://regex101.com/|https://regex101.com/]], and see if your pattern matches your layer's names.
  
-<wrap hi>%AppData%\McNeel\Rhinoceros\7.0\Plug-ins\Marine Weight Schedule for RH6-RH7 (dac6da37-23fc-4ad6-9b46-33a2cad9e13b)\//VersionNumber//</wrap> \\ (Adapt Rhino'version if neededas well as the plugin'version)+**Example1**: [[https://regex101.com/r/0C2262/1|The default regular expression to match the implicit stiffeners between square brackets]]: ''%%[StiffenerName s=value *MaterialName*]%%'' 
 + 
 +**Example2**: [[https://regex101.com/r/qIbMNb/1|The edited regular expression to match the implicit stiffeners between either square brackets or exclamation marks]]: ''%%[StiffenerName s=value *MaterialName*]%%'' or ''%%!StiffenerName s=value *MaterialName*!%%'' 
 +---- 
 +==== ProjectWeightReportByHullSection ==== 
 +This command((From v1.2.0)) splits the model into sections, then runs //[[start:plugins:marineweightschedule:mws-usermanual#projectweightreport|ProjectWeightReport]]// on each section. 
 +The resulting Excel file will contain the usual model-wide report, plus independent reports for every section. (Named from S001 to Sxxx) 
 +{{ :start:plugins:marineweightschedule:pwr_hs.jpg?nolink |}} 
 +=== Walkthrough === 
 +  - Run the command //ProjectWeightReportByHullSection// 
 +  - 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'bounding box. GBlocks will be allocated using the location of their gravity centers. 
 +<WRAP center round important 90%> 
 +Items((Volumessurfaces, 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'weight. A solution is to offset the cutting plane by a few millimeters. 
 +</WRAP> 
 +<WRAP center round info 90%> 
 +Solids((Closed polysurfaces)) __must not__ by split, because the result would be opened polysurfaces, which is forbidden when creating a //ProjectWeightReport// 
 +</WRAP>
  
-It is recommended to edit only the text values and the logos while keeping the document's general layout.+=== Scripted mode === 
 +Using the command's scripted mode //-ProjectWeightReportByHullSection// will enable two hidden options: 
 +  * **AxisLengthInMeters**: Enter the gravity center's preview axis length used in the result views 
 +  * **DrawSplittedGeometries**: When enabled, a layer //ProjectWeightReportByHullSection// will be added to the model, with the splitted geometry. This is useful to check if no curves/surfaces were lost in the sectionssplitting operations.
 ---- ----
 ==== HydrostaticReport ==== ==== HydrostaticReport ====
Line 150: Line 188:
  
 <wrap hi>%AppData%\McNeel\Rhinoceros\7.0\Plug-ins\Marine Weight Schedule for RH6-RH7 (dac6da37-23fc-4ad6-9b46-33a2cad9e13b)\//VersionNumber//</wrap> \\ (Adapt Rhino's version if needed, as well as the plugin's version) <wrap hi>%AppData%\McNeel\Rhinoceros\7.0\Plug-ins\Marine Weight Schedule for RH6-RH7 (dac6da37-23fc-4ad6-9b46-33a2cad9e13b)\//VersionNumber//</wrap> \\ (Adapt Rhino's version if needed, as well as the plugin's version)
- 
 It is recommended to edit only the text values and the logos while keeping the document's general layout. It is recommended to edit only the text values and the logos while keeping the document's general layout.
 ---- ----