docs: document hull thickness properties and multihull creation

This commit is contained in:
Antoine Anceau committed 2026-02-26 22:02:23 +01:00
1 parent 813d71fe2c
commit 36bd2ffb92
4 files changed
+59

No files matched your search

+23
View File
@@ -33,6 +33,11 @@ Hull
:returns: (xmin, xmax, ymin, ymax, zmin, zmax)
:rtype: tuple[float, float, float, float, float, float]
.. py:attribute:: thickness
:type: float or None
The hull plate thickness in meters. If set, it adds volume to the hydrostatic calculations based on the wetted surface area.
.. py:method:: num_triangles()
Returns the number of triangles in the mesh.
@@ -133,6 +138,24 @@ Vessel
Returns the combined bounding box of all hulls.
.. py:method:: get_hull_thickness(index)
Returns the hull plate thickness for a specific hull by index.
:param index: Hull index
:type index: int
:returns: Hull thickness in meters, or None
:rtype: float or None
.. py:method:: set_hull_thickness(index, thickness)
Sets the hull plate thickness for a specific hull by index.
:param index: Hull index
:type index: int
:param thickness: Hull thickness in meters, or None to remove
:type thickness: float or None
.. py:method:: num_hulls()
Returns the number of hulls.
+10
View File
@@ -229,6 +229,16 @@ HydrostaticState
Wetted Surface Area (m²).
.. py:attribute:: thickness_volume
:type: float
Volume added by the hull plate thickness (m³).
.. py:attribute:: contact_surface_area
:type: float
Shared area between hulls excluded from wetted surface (m²).
.. py:attribute:: midship_area
:type: float