Differences

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

Link to this comparison view

Both sides previous revision Previous revision
start:plugins:marineweightschedule:mws-usermanual [2021/02/18 10:59]
adminmar [HydrostaticReport]
start:plugins:marineweightschedule:mws-usermanual [2021/03/15 11:52] (current)
adminmar Grammatical and spelling check
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/inertias, as well as a Bill Of Materials. It take in account points, curves, surfaces, solids and blocks, and use the parameters from the layers names to apply the unitary/lineic/surfacic/volumic masses, with a margin percentage applied.+//Marine Weight Schedule// is a plugin for Rhino 3D designed to generate - from a vessel’s 3D model - a bill of masses/inertias, as well as a Bill Of Materials. It takes into account points, curves, surfaces, solids and blocks, and uses the parameters from the layersnames to apply the unitary/lineic/surfacic/volumic masses, with a margin percentage applied.
  
-A command is also provided to generate an hydrostatic report at a given height interval (based on Rhino hydrostatics features)+A command is also provided to generate hydrostatic report at a given height interval (based on Rhino hydrostatics features)
  
-Both reports will be generated as excel files (.xlsx) based on a customizable template, but microsoft excel doesn’t need to be installed on the computer.+Both reports will be generated as excel files (.xlsx) based on a customizable template, but Microsoft excel doesn’t need to be installed on the computer.
 ===== Plugin installation ===== ===== Plugin installation =====
 ==== Overview ==== ==== Overview ====
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" below)), then: 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" below)), then:
-  - For each rhino object, the actual mass and gravity center will be computed, using the layer values. The layer's //Mass// will be used differently, depending on the object's type: ponctual mass for Points, lineic mass for curves, surfacic mass for surfaces((To avoid errors, openened polysurfaces won't be allowed)), and volumic mass for closed polysurfaces.+  - For each rhino object, the actual mass and gravity center will be computed, using the layer values. The layer's //Mass// will be used differently, depending on the object's type: punctual mass for Points, lineic mass for curves, surface mass for surfaces((To avoid errors, opened polysurfaces won't be allowed)), and volumic mass for closed polysurfaces.
   - 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.
 {{ :start:plugins:marineweightschedule:mws_walkthrough.gif?nolink |}} {{ :start:plugins:marineweightschedule:mws_walkthrough.gif?nolink |}}
 === 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 fundamental 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.//
 For example: //  For example: // 
-  * The layer **''%%Deck1:SectionB:Nuts%%''** could contain only points, and the layer's //(mass)// information would be used as a ponctual mass for each nut. +  * The layer **''%%Deck1:SectionB:Nuts%%''** could contain only points, and the layer's //(mass)// information would be used as a punctual mass for each nut. 
-  * The layer **''%%Deck1:SectionB:plates%%''** could contain only surfaces, and the layer's //(mass)// information would be used as a surfacic mass for each plate.+  * The layer **''%%Deck1:SectionB:plates%%''** could contain only surfaces, and the layer's //(mass)// information would be used as a surface mass for each plate.
 == 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:
Line 76: Line 76:
 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 plateand 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 97:
  
 == 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 masses.+By default, rhino(r) blocks((instances references)) are ignored by the command. Howeverwe provide several commands to transform blocks into GBlocks, which are considered in the reports as punctual masses.
  
 See [[start:plugins:marineweightschedule:mws-usermanual#gblock_setdata|gblock_setdata]] See [[start:plugins:marineweightschedule:mws-usermanual#gblock_setdata|gblock_setdata]]
  
 <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'internal definition will be used instead (Name, gravity center, mass).+When the command will process GBlocks, their layer properties will be ignored, and their internal definition will be used instead (Name, gravity center, mass).
 </WRAP> </WRAP>
  
Line 112: Line 112:
 {{:start:plugins:marineweightschedule:pwr_excel_results.jpg?nolink|}} {{:start:plugins:marineweightschedule:pwr_excel_results.jpg?nolink|}}
  
-Bill of masses detailed sheets for Volumes, surfaces, curves and points:+Bill of masses detailed sheets for Volumes, surfaces, curvesand points:
  
 {{:start:plugins:marineweightschedule:pwr_excel_volumes.jpg?nolink|}} {{:start:plugins:marineweightschedule:pwr_excel_volumes.jpg?nolink|}}
Line 132: Line 132:
 <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 texts values and the logoswhile keeping the document general layout.+It is recommended to edit only the text values and the logos while keeping the document'general layout.
 ---- ----
 ==== HydrostaticReport ==== ==== HydrostaticReport ====
-Computes an hydrostatic analysis at different heights and generates an excel report.+Computes hydrostatic analysis at different heights and generates an excel report.
 === 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 calculation is runned at various heights as defined in options, and an excel report is generated.+Once validated, Rhino's hydrostatic calculation is run 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 151: Line 151:
 <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 texts values and the logoswhile keeping the document general layout.+It is recommended to edit only the text values and the logos while keeping the document'general layout.
 ---- ----
 ==== GBlock_SetData ==== ==== 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.+Adds gravity center and mass information to a block. GBlocks are considered by the command //ProjectWeightReport //, which makes them extremely useful for your pieces of equipment.
 <WRAP center round info 90%> <WRAP center round info 90%>
-When using this command on an existing GBlock, its gravity center, mass information and name will be overriden.+When using this command on an existing GBlock, its gravity center, mass informationand name will be overridden.
  
 This is the only way to edit a GBlock name or data. This is the only way to edit a GBlock name or data.
Line 170: Line 170:
  
 ==== GBlock_GetList ==== ==== GBlock_GetList ====
-Lists every existing GBlock names and masses to the command line.+Lists every existing GBlock name and masses to the command line.
 === Walkthrough === === Walkthrough ===
   - Start the command   - Start the command
-  - A windows is shown with details about every blocks instances in the model+  - A window is shown with details about every block instances in the model
 {{ :start:plugins:marineweightschedule:gblock_getlist_walkthrough.gif?nolink |}} {{ :start:plugins:marineweightschedule:gblock_getlist_walkthrough.gif?nolink |}}
  
Line 188: Line 188:
   - Launch the command   - Launch the command
   - Pick a GBlock name from the list   - Pick a GBlock name from the list
-  - Every instances of this GBlock will be selected in the model+  - Every instance of this GBlock will be selected in the model
 {{ :start:plugins:marineweightschedule:gblock_select_walkthrough.gif?nolink |}} {{ :start:plugins:marineweightschedule:gblock_select_walkthrough.gif?nolink |}}
  
 ==== GBlock_SelectNextMissingData ==== ==== GBlock_SelectNextMissingData ====
-Selects the next block in the document wich is not a GBlock (gravity center and mass are undefined)+Selects the next block in the document which is not a GBlock (gravity center and mass are undefined)
 === Walkthrough === === Walkthrough ===
   - Launch the command   - Launch the command
-  - The commands loops between the non-GBlocks instances in the model. (Press escap to leave) +  - The commands loops between the non-GBlocks instances in the model. (Press ESC to leave) 
 {{ :start:plugins:marineweightschedule:gblock_selectnextmissingdata_walkthrough.gif?nolink |}} {{ :start:plugins:marineweightschedule:gblock_selectnextmissingdata_walkthrough.gif?nolink |}}
  
 ==== GBlock_Rename ==== ==== GBlock_Rename ====
-Renames a GBlock definition (Every instances will be renamed)+Renames a GBlock definition (Every instance will be renamed)
 === Walkthrough === === Walkthrough ===
   - Launch the command   - Launch the command