====== Naval Structure Toolkit - User Manual ======

===== Introduction =====

<WRAP center round todo 60%>
TODO
</WRAP>

===== Plugin installation =====
==== Overview ====
The plugin installer can be downloaded at FIXME \\ 
A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\ 
//Naval Structure Toolkit// 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#[License activation]&noindent&nofooter&nodate}}

{{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}}

----
===== Commands =====

====NST_About====
This command can be used only from the command line prompt. It displays the plugin's current revision and license status.
<WRAP center round todo 60%>
add image
</WRAP>
----

====NST_License====
This command can be used only from the command line prompt. It displays the plugin's activation form.

See [[nst-usermanual#license_activation]].
----

====CheckPlatCut====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====IDsToUserText====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====SolidMass====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - Select an extrusion or a closed polysurface
  - The object's mass and centroid coordinates will be displayed in command line feedback
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Options ===
| Material | Either a material from the editable material list or //"Other"//, which will ask to manually enter a volumic mass {{ :start:plugins:navalstructuretoolkit:ext_solidmass_options.jpg?nolink |}}|
| WeldingPercentage | The margin to add to the result to consider welding masses (%) |
| DrawCentroidPoints | If enabled, a point will be added to the model at the centroid's location |
=== Scripted mode ===
No scripted mode is available for this command.
----

====IntersectSolids====
Check object intersections between two or several closed polysurfaces. The clashes volumes are added to the doc, in a layer named "clashes"
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
{{ :start:plugins:navalstructuretoolkit:ext_intersectobjects.jpg?nolink |}}
=== Scripted mode ===
No scripted mode is available for this command.
----

====ExportPartsToDxf====
Exports selected curves and annotations to a DXF file.
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - The dxf file with the selected items is saved as: //%ModelDIrectory%//\Platcuts-//%DocAttributeForBlockNumber%//\//%LayernameExtract%//\//%ObjectReference%//.dxf
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Options ===
| DocAttributeForBlockNumber | value from a document usertext. The targeted usertext can be changed in the MSW option panel. | 
| LayerNameBeginWith | Filter objects by the beginning of their layer name. The targeted user text can be changed in the MSW option panel. | 
| ObjectReference | value from an object's usertext.  The targeted usertext can be changed in the MSW option panel and is common with several other commands. |
=== Scripted mode ===
No scripted mode is available for this command.
----

====Bracket====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====Cuto====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====Rails====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====GeneratePlateMarking====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
----

====DevelopPlanarPlate====
<WRAP center round todo 60%>
TO DO: Add description
</WRAP>
=== Walkthrough ===
  - Launch the command
  - First Step :?:
  - Second Step :?:
<WRAP center round todo 60%>
TODO: Add animated gif
</WRAP>
=== Scripted mode ===
No scripted mode is available for this command.
-----
==== SelectByBorderDetection ====
<WRAP center round important 60%>
Available only for Rhino7 and later
</WRAP>
Tries to detect and select a room's walls. Useful for drawings with many short curves delimiting a ship's or building's rooms.
=== Walkthrough ===
  - Start the command
  - Hover the model: the result is previewed in real-time
{{ :start:plugins:selectiontools:selectbyborderdetection.gif?nolink |}}
=== Options ===
== DetectionRange ==
Limits the detection range where the command will look for walls. Default value is 1000((Model Units))
== Mode ==
Two modes are available:
  * //SelectExistingCurves// is just a selection of existing objects
  * //TryCreateClosedPolycurve// will always returns a closed polyline. If needed line segments may be added.
== DisplayArea ==
When enabled, the area will be displayed during the preview if the polycurve creation is successful.
{{ :start:plugins:selectiontools:sbbd-area.png?nolink&400 |}}
----