Ship LoadExample: Difference between revisions

From FreeCAD Documentation
(+ GuiCommand)
No edit summary
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
{{GuiCommand|Name=FreeCADShip Load‏‎ |MenuLocation=FreeCADShip → Load‏‎||Workbenches=[[FreeCADShip Workbench|Ship]]|Shortcut=|SeeAlso=}}
<translate>


<!--T:10-->
{{Docnav
|
|[[Ship_CreateShip|Create a new ship]]
|[[Ship_Workbench|Ship]]
|IconL=
|IconR=Ship_CreateShip.svg
|IconC=Workbench_Ship.svg
}}


<!--T:1-->
== Loading geometry ==
{{GuiCommand
|Name=Ship LoadExample
|MenuLocation=Ship design → Load an example ship geometry
|Workbenches=[[Ship_Workbench|Ship]]
|Shortcut=
|SeeAlso=
}}


== Description == <!--T:15-->
=== Introduction ===

FreeCAD-Ship works over '''Ship entities''', that must be created on top of provided geometry. Geometry must be a solid, or set of solids, following criteria must be taken into account:
<!--T:2-->
This tool loads example geometries.

<!--T:16-->
Ship works over '''Ship entities''', that must be created on top of provided geometry. Geometry must be a solid, or set of solids. The following criteria must be taken into account:
* All hull geometry must be provided (including symmetric bodies).
* All hull geometry must be provided (including symmetric bodies).
* Starboard geometry must be included at negatives ''y'' domain.
* Starboard geometry must be included at negatives ''y'' domain.
* Origin (0,0,0) point is the '''Midship section''' (Midpoint between after and forward perpendicular) and '''base line''' intersection.
* Origin (0,0,0) point is the '''Midship section''' (Midpoint between after and forward perpendicular) and '''base line''' intersection.


</translate>
[[Image:FreeCAD-Ship-SignCriteria.jpg]]
<translate>
<!--T:3-->
{{Caption|Ship sign criteria}}

<!--T:14-->
In order to help new users, Ship includes a geometries examples loader, with the following to choose from:
* Series 60 from Iowa University
* Wigley Canonical Ship
* Series 60 Catamaran
* Wigley Catamaran


== Usage == <!--T:4-->
[[Image:FreeCAD-Ship-SignCriteria.jpg|center|Schematic view of sign criteria]]
<center><span style="font-variant:small-caps">FreeCAD-Ship sign criteria</span></center>


<!--T:6-->
=== Loading Series 60 geometry ===
# There are several ways to invoke the command:
In order to help new users FreeCAD-Ship includes a geometries examples loader, with the following to choose from:
#* Press the {{Button|[[Image:Ship_LoadExample.svg|16px]] [[Ship_LoadExample|Load an example ship geometry]]}} button.
*Series 60 from Iowa University
#* Select the {{MenuCommand|Ship design → [[Image:Ship_LoadExample.svg|16px]] Load‏‎ an example ship geometry}} option from the menu.
*Wigley Canonical Ship
# A task panel will display, prompting to choose one of the example ship geometries.
*Series 60 Catamaran
# Select the example you want to load and press {{Button|Accept}}.
*Wigley Catamaran
# Result: The tool loads a new document with the selected geometry.


<!--T:7-->
{{VeryImportantMessage|Warning, before editing anything! You are now working with the original example file. To preserve the original unedited example, you must first save it as a new file before editing anything.}}


==Tutorials== <!--T:8-->
[[Image:FreeCAD-Ship-LoadIco.png|center|Example ship geometries loader icon.]]
<center><span style="font-variant:small-caps"> Ship Geometries Examples loader icon</span></center>


<!--T:9-->
* [[FreeCAD-Ship_s60_tutorial|FreeCAD-Ship s60 tutorial]]
* [[FreeCAD-Ship_s60_tutorial_(II)|FreeCAD-Ship s60 tutorial (II)]]


Executing the tool (Ship design/Load an example ship geometry) a task dialogue will shown. Select '''Series 60 from Iowa University''' and press Accept. Tool loads new document with '''s60_IowaUniversity''' geometry.


<!--T:11-->
{{Docnav
|
|[[Ship_CreateShip|Create a new ship]]
|[[Ship_Workbench|Ship]]
|IconL=
|IconR=Ship_CreateShip.svg
|IconC=Workbench_Ship.svg
}}


</translate>
{{VeryImportantMessage|<center>'''Warning, before editing anything!'''</center>
{{Userdocnavi{{#translation:}}}}
<center>You are now working with the original example file.</center>
[[Category:Ship{{#translation:}}]]
<center>To preserve the original unedited example, '''you must first save it as a new file before editing anything.'''</center>}}

Latest revision as of 11:20, 24 April 2022

Ship LoadExample

Menu location
Ship design → Load an example ship geometry
Workbenches
Ship
Default shortcut
None
Introduced in version
-
See also
None

Description

This tool loads example geometries.

Ship works over Ship entities, that must be created on top of provided geometry. Geometry must be a solid, or set of solids. The following criteria must be taken into account:

  • All hull geometry must be provided (including symmetric bodies).
  • Starboard geometry must be included at negatives y domain.
  • Origin (0,0,0) point is the Midship section (Midpoint between after and forward perpendicular) and base line intersection.

Ship sign criteria

In order to help new users, Ship includes a geometries examples loader, with the following to choose from:

  • Series 60 from Iowa University
  • Wigley Canonical Ship
  • Series 60 Catamaran
  • Wigley Catamaran

Usage

  1. There are several ways to invoke the command:
  2. A task panel will display, prompting to choose one of the example ship geometries.
  3. Select the example you want to load and press Accept.
  4. Result: The tool loads a new document with the selected geometry.
Warning, before editing anything! You are now working with the original example file. To preserve the original unedited example, you must first save it as a new file before editing anything.

Tutorials