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
Next revision Both sides next revision
start:plugins:marineweightschedule:mws-usermanual [2021/01/05 10:39]
adminmar [Overview] - Added toolbar screenshot 		start:plugins:marineweightschedule:mws-usermanual [2021/02/18 10:59]
adminmar [HydrostaticReport]
Line 34: Line 34:
   - 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%> +{{ :start:plugins:marineweightschedule:mws_walkthrough.gif?nolink |}}
-Add images +
-</WRAP>+
 === Model preparation === === Model preparation ===
 The fondamental idea of this plugin is to match data from the model's objects and their layer. For this reason, each layer should contain only one specific material.// The fondamental idea of this plugin is to match data from the model's objects and their layer. For this reason, each layer should contain only one specific material.//
Line 49: Line 47:
   * **''%%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
-{{ :start:plugins:marineweightschedule:pwr_layers.jpg?nolink |}} +{{ :start:plugins:marineweightschedule:pwr_layers2.jpg?nolink |}}
-<WRAP center round todo 60%> +
-Add images +
-</WRAP>+
  
 == Particular case for Stiffeners == == Particular case for Stiffeners ==
Line 68: Line 63:
 </WRAP> </WRAP>
 For example: For example:
-<WRAP center round todo 60%> +{{ :start:plugins:marineweightschedule:pwr_layersimplicitstiffeners.jpg?nolink |}}
-Add screen capture +
-</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 102: Line 95:
 '80x8 profile Length' = (area / 80) + (area / 80) * 3.4/100 '80x8 profile Length' = (area / 80) + (area / 80) * 3.4/100
 </WRAP> </WRAP>
 +
 == 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 ponctual masses. 
-todo+ 
 +See [[start:plugins:marineweightschedule:mws-usermanual#gblock_setdata|gblock_setdata]] 
 + 
 +<WRAP center round important 90%> 
 +When the command will process GBlocks, their layer properties will be ignored, and the Gblock's internal definition will be used instead (Name, gravity center, mass).
 </WRAP> </WRAP>
 +
 +
 === Output === === Output ===
-An excel report is generated: +When the whole model has been processed, an excel((.xlsx)) report is generated, and the user is invited to pick a name and location for the resulting file. 
-{{ :start:plugins:marineweightschedule:pwr_excel.jpg?nolink |}} +Bill of masses main sheet: 
-<WRAP center round todo 60%> + 
-Add images +{{:start:plugins:marineweightschedule:pwr_excel_results.jpg?nolink|}} 
-</WRAP>+ 
 +Bill of masses detailed sheets for Volumes, surfaces, curves and points: 
 + 
 +{{:start:plugins:marineweightschedule:pwr_excel_volumes.jpg?nolink|}} 
 + 
 +{{:start:plugins:marineweightschedule:pwr_excel_points.jpg?nolink|}} 
 + 
 +Bill of materials: 
 + 
 +{{:start:plugins:marineweightschedule:pwr_excel_bom.jpg?nolink|}} 
 A custom ViewPort is created with the gravity center displayed: A custom ViewPort is created with the gravity center displayed:
-{{ :start:plugins:marineweightschedule:pwr_viewport.jpg?nolink |}} + 
-<WRAP center round todo 60%> +{{:start:plugins:marineweightschedule:pwr_viewport2.jpg?nolink|}}
-Add images +
-</WRAP>+
 ===  Options ===  ===  Options === 
 No option available. No option available.
 === Customization === === Customization ===
-The excel file template can be modified in the plugin's install directory. +The excel report template "PWE_Model.xlsx" can be modified in the plugin's install directory, usually: 
-<WRAP center round todo 60%> + 
-add details +<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>+ 
 +It is recommended to edit only the texts values and the logos, while keeping the document general layout.
 ---- ----
 ==== HydrostaticReport ==== ==== HydrostaticReport ====
Line 129: Line 138:
 === 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's hydrostatic culculation is runned at various heights as defined in options, and an excel report is generated.+Once validated, Rhino's hydrostatic calculation is runned at various heights as defined in options, and an excel report is generated.
  {{ :start:plugins:marineweightschedule:ext_hydro.jpg?nolink |}}  {{ :start:plugins:marineweightschedule:ext_hydro.jpg?nolink |}}
 ===  Options ===  ===  Options === 
Line 138: Line 147:
 ^ 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 in the plugin install directory.+The excel report template "Hydro_Model.xlsx" can be modified in the plugin's install directory, usually: 
 + 
 +<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 texts values and the logos, while keeping the document general layout. 
 +---- 
 +==== GBlock_SetData ==== 
 +Adds gravity center and mass informations to a block. GBlocks  are considered by the command //ProjectWeightReport //, which makes them extremely useful for your equipements. 
 +<WRAP center round info 90%> 
 +When using this command on an existing GBlock, its gravity center, mass information and name will be overriden. 
 + 
 +This is the only way to edit a GBlock name or data. 
 +</WRAP> 
 +=== Walkthrough === 
 +  - Start the command 
 +  - Pick a rhino block((Instance reference)) in the model 
 +  - Pick the GBlock's gravity center 
 +  - Enter the GBlock's mass 
 +  - Enter the GBlock's name (By default, Rhino's block name is used) 
 +  - Click OK or press Enter 
 +{{ :start:plugins:marineweightschedule:gblock_setdata_walkthrough.gif?nolink |}}
  
 ==== GBlock_GetList ==== ==== GBlock_GetList ====
 Lists every existing GBlock names and masses to the command line. Lists every existing GBlock names and masses to the command line.
 === Walkthrough === === Walkthrough ===
-<WRAP center round todo 60%> +  - Start the command 
-Todo +  - A windows is shown with details about every blocks instances in the model 
-</WRAP>+{{ :start:plugins:marineweightschedule:gblock_getlist_walkthrough.gif?nolink |}}
  
 ==== 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: 
-</WRAP>+{{:start:plugins:marineweightschedule:gblock_readdata_walkthrough.jpg?nolink|}}
  
 ==== 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 
-</WRAP>+  - Every instances of this GBlock will be selected in the model 
 +{{ :start:plugins:marineweightschedule:gblock_select_walkthrough.gif?nolink |}}
  
 ==== GBlock_SelectNextMissingData ==== ==== GBlock_SelectNextMissingData ====
-Select the next block in the document where gravity center and mass are undefined+Selects the next block in the document wich is not a GBlock (gravity center and mass are undefined)
 === Walkthrough === === Walkthrough ===
-<WRAP center round todo 60%> +  - Launch the command 
-Todo +  - The commands loops between the non-GBlocks instances in the model. (Press escap to leave)  
-</WRAP>+{{ :start:plugins:marineweightschedule:gblock_selectnextmissingdata_walkthrough.gif?nolink |}}
  
-==== GBlock_SetData ==== +==== GBlock_Rename ==== 
-Add gravity center and mass informations to a block. GBlocks  are considered by the command //ProjectWeightReport //, which makes them extremely useful for your equipements.+Renames a GBlock definition (Every instances will be renamed)
 === Walkthrough === === Walkthrough ===
-<WRAP center round todo 60%> +  - Launch the command 
-Todo +  - Pick a Gblock from the list 
-</WRAP>+  - Enter a new name for the GBlock 
start/plugins/marineweightschedule/mws-usermanual.txt · Last modified: 2021/12/14 15:10 by adminmar
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International


  • Show page
  • Old revisions
  • Export to PDF
  • Backlinks
  • Recent Changes
  • Media Manager
  • Sitemap