def clampVal(self, widget, val_min, val_max, val):
if val >= val_min and val <= val_max:
return val
input_format = USys.getLengthFormat()
val = min(val_max, max(val_min, val))
qty = Units.Quantity('{} m'.format(val))
widget.setText(Locale.toString(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
return val
def onData(self, value):
""" Method called when the tool input data is touched.
@param value Changed value.
"""
if not self.ship:
return
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.draft = self.widget(QtGui.QLineEdit, "Draft")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
# Get the values (or fix them in bad setting case)
try:
draft = Units.Quantity(Locale.fromString(
form.draft.text())).getValueAs('m').Value
except:
draft = self.ship.Draft.getValueAs(USys.getLengthUnits()).Value
input_format = USys.getLengthFormat()
qty = Units.Quantity('{} m'.format(draft))
widget.setText(Locale.toString(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
try:
trim = Units.Quantity(Locale.fromString(
form.trim.text())).getValueAs('deg').Value
except:
trim = 0.0
input_format = USys.getAngleFormat()
qty = Units.Quantity('{} deg'.format(trim))
widget.setText(Locale.toString(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
bbox = self.ship.Shape.BoundBox
draft_min = bbox.ZMin / Units.Metre.Value
draft_max = bbox.ZMax / Units.Metre.Value
draft = self.clampLength(form.draft, draft_min, draft_max, draft)
trim_min = -180.0
trim_max = 180.0
trim = self.clampAngle(form.trim, trim_min, trim_max, trim)
self.onUpdate()
self.preview.update(draft, trim, self.ship)
def initValues(self):
""" Set initial values for fields
"""
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" objects selected)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
for i in range(0, len(selObjs)):
obj = selObjs[i]
props = obj.PropertiesList
try:
props.index("IsShip")
except ValueError:
continue
if obj.IsShip:
if self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"More than one ship have been selected (the extra"
" ships will be ignored)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintWarning(msg + '\n')
break
self.ship = obj
if not self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" valid ship found at the selected objects)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
length_format = USys.getLengthFormat()
angle_format = USys.getAngleFormat()
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.draft = self.widget(QtGui.QLineEdit, "Draft")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.num = self.widget(QtGui.QSpinBox, "Num")
form.draft.setText(Locale.toString(length_format.format(
self.ship.Draft.getValueAs(USys.getLengthUnits()).Value)))
form.trim.setText(Locale.toString(angle_format.format(0.0)))
# Try to use saved values
props = self.ship.PropertiesList
try:
props.index("AreaCurveDraft")
form.draft.setText(Locale.toString(length_format.format(
self.ship.AreaCurveDraft.getValueAs(
USys.getLengthUnits()).Value)))
except:
pass
try:
props.index("AreaCurveTrim")
form.trim.setText(Locale.toString(angle_format.format(
self.ship.AreaCurveTrim.getValueAs(
USys.getAngleUnits()).Value)))
except ValueError:
pass
try:
props.index("AreaCurveNum")
form.num.setValue(self.ship.AreaCurveNum)
except ValueError:
pass
# Update GUI
draft = Units.Quantity(form.draft.text()).getValueAs('m').Value
trim = Units.Quantity(form.trim.text()).getValueAs('deg').Value
self.preview.update(draft, trim, self.ship)
self.onUpdate()
return False
def initValues(self):
"""Setup the initial values"""
self.solids = None
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"Ship objects can only be created on top of hull geometry"
" (no objects selected)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
msg = QtGui.QApplication.translate(
"ship_console",
"Please create or load a ship hull geometry before using"
" this tool",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
self.solids = []
for i in range(0, len(selObjs)):
solids = self.getSolids(selObjs[i])
for j in range(0, len(solids)):
self.solids.append(solids[j])
if not self.solids:
msg = QtGui.QApplication.translate(
"ship_console",
"Ship objects can only be created on top of hull geometry"
" (no solid found at selected objects)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
msg = QtGui.QApplication.translate(
"ship_console",
"Please create or load a ship hull geometry before using"
" this tool",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
# Get the ship bounds. The ship instance can not have dimensions
# out of these values.
self.bounds = [0.0, 0.0, 0.0]
bbox = self.solids[0].BoundBox
minX = bbox.XMin
maxX = bbox.XMax
minY = bbox.YMin
maxY = bbox.YMax
minZ = bbox.ZMin
maxZ = bbox.ZMax
for i in range(1, len(self.solids)):
bbox = self.solids[i].BoundBox
if minX > bbox.XMin:
minX = bbox.XMin
if maxX < bbox.XMax:
maxX = bbox.XMax
if minY > bbox.YMin:
minY = bbox.YMin
if maxY < bbox.YMax:
maxY = bbox.YMax
if minZ > bbox.ZMin:
minZ = bbox.ZMin
if maxZ < bbox.ZMax:
maxZ = bbox.ZMax
self.bounds[0] = maxX - minX
self.bounds[1] = max(maxY - minY, abs(maxY), abs(minY))
self.bounds[2] = maxZ - minZ
input_format = USys.getLengthFormat()
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.length = self.widget(QtGui.QLineEdit, "Length")
form.breadth = self.widget(QtGui.QLineEdit, "Breadth")
form.draft = self.widget(QtGui.QLineEdit, "Draft")
qty = Units.Quantity(self.bounds[0], Units.Length)
form.length.setText(Locale.toString(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
self.L = self.bounds[0] / Units.Metre.Value
qty = Units.Quantity(self.bounds[1], Units.Length)
form.breadth.setText(Locale.toString(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
self.B = self.bounds[1] / Units.Metre.Value
qty = Units.Quantity(self.bounds[2], Units.Length)
form.draft.setText(Locale.toString(input_format.format(
0.5 * qty.getValueAs(USys.getLengthUnits()).Value)))
self.T = 0.5 * self.bounds[2] / Units.Metre.Value
return False
def getUnderwaterSide(shape, force=True):
"""Get the underwater shape, simply cropping the provided shape by the z=0
free surface plane.
Position arguments:
shape -- Solid shape to be cropped
Keyword arguments:
force -- True if in case the common boolean operation fails, i.e. returns
no solids, the tool should retry it slightly moving the free surface. False
otherwise. (True by default)
Returned value:
Cropped shape. It is not modifying the input shape
"""
# Convert the shape into an active object
Part.show(shape)
orig = App.ActiveDocument.Objects[-1]
bbox = shape.BoundBox
xmin = bbox.XMin
xmax = bbox.XMax
ymin = bbox.YMin
ymax = bbox.YMax
zmin = bbox.ZMin
zmax = bbox.ZMax
# Create the "sea" box to intersect the ship
L = xmax - xmin
B = ymax - ymin
H = zmax - zmin
box = App.ActiveDocument.addObject("Part::Box","Box")
length_format = USys.getLengthFormat()
box.Placement = Placement(Vector(xmin - L, ymin - B, zmin - H),
Rotation(App.Vector(0,0,1),0))
box.Length = length_format.format(3.0 * L)
box.Width = length_format.format(3.0 * B)
box.Height = length_format.format(- zmin + H)
App.ActiveDocument.recompute()
common = App.activeDocument().addObject("Part::MultiCommon",
"UnderwaterSideHelper")
common.Shapes = [orig, box]
App.ActiveDocument.recompute()
if force and len(common.Shape.Solids) == 0:
# The common operation is failing, let's try moving a bit the free
# surface
msg = QtGui.QApplication.translate(
"ship_console",
"Boolean operation failed when trying to get the underwater side."
" The tool is retrying such operation slightly moving the free"
" surface position",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintWarning(msg + '\n')
random_bounds = 0.01 * H
i = 0
while len(common.Shape.Solids) == 0 and i < COMMON_BOOLEAN_ITERATIONS:
i += 1
box.Height = length_format.format(
- zmin + H + random.uniform(-random_bounds, random_bounds))
App.ActiveDocument.recompute()
out = common.Shape
App.ActiveDocument.removeObject(common.Name)
App.ActiveDocument.removeObject(orig.Name)
App.ActiveDocument.removeObject(box.Name)
App.ActiveDocument.recompute()
return out
def onData(self, value):
""" Method called when input data is changed.
@param value Changed value.
"""
if not self.ship:
return
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.minDraft = self.widget(QtGui.QLineEdit, "MinDraft")
form.maxDraft = self.widget(QtGui.QLineEdit, "MaxDraft")
# Get the values (or fix them in bad setting case)
try:
trim = Units.Quantity(form.trim.text()).getValueAs('deg').Value
except:
trim = 0.0
input_format = USys.getAngleFormat()
qty = Units.Quantity('{} deg'.format(trim))
form.trim.setText(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
try:
min_draft = Units.Quantity(
form.minDraft.text()).getValueAs('m').Value
except:
min_draft = 0.9 * self.ship.Draft.getValueAs('m').Value
input_format = USys.getLengthFormat()
qty = Units.Quantity('{} m'.format(min_draft))
form.minDraft.setText(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
try:
max_draft = Units.Quantity(
form.minDraft.text()).getValueAs('m').Value
except:
max_draft = 0.9 * self.ship.Draft.getValueAs('m').Value
input_format = USys.getLengthFormat()
qty = Units.Quantity('{} m'.format(max_draft))
form.maxDraft.setText(input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
# Clamp the values to the bounds
bbox = self.ship.Shape.BoundBox
draft_min = bbox.ZMin / Units.Metre.Value
draft_max = bbox.ZMax / Units.Metre.Value
min_draft = self.clampLength(form.minDraft,
draft_min,
draft_max,
min_draft)
max_draft = self.clampLength(form.maxDraft,
draft_min,
draft_max,
max_draft)
trim_min = -180.0
trim_max = 180.0
trim = self.clampAngle(form.trim, trim_min, trim_max, trim)
# Clamp draft values to assert that the minimum value is lower than
# the maximum one
min_draft = self.clampLength(form.minDraft,
draft_min,
max_draft,
min_draft)
max_draft = self.clampLength(form.maxDraft,
min_draft,
draft_max,
max_draft)
def initValues(self):
""" Set initial values for fields
"""
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.minDraft = self.widget(QtGui.QLineEdit, "MinDraft")
form.maxDraft = self.widget(QtGui.QLineEdit, "MaxDraft")
form.nDraft = self.widget(QtGui.QSpinBox, "NDraft")
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" objects selected)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
for i in range(len(selObjs)):
obj = selObjs[i]
props = obj.PropertiesList
try:
props.index("IsShip")
except ValueError:
continue
if obj.IsShip:
if self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"More than one ship have been selected (the extra"
" ships will be ignored)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintWarning(msg + '\n')
break
self.ship = obj
if not self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" valid ship found at the selected objects)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
props = self.ship.PropertiesList
length_format = USys.getLengthFormat()
angle_format = USys.getAngleFormat()
try:
props.index("HydrostaticsTrim")
form.trim.setText(angle_format.format(
self.ship.HydrostaticsTrim.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.trim.setText(angle_format.format(0.0))
try:
props.index("HydrostaticsMinDraft")
form.minDraft.setText(length_format.format(
self.ship.HydrostaticsMinDraft.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.minDraft.setText(length_format.format(
0.9 * self.ship.Draft.getValueAs('m').Value))
try:
props.index("HydrostaticsMaxDraft")
form.maxDraft.setText(length_format.format(
self.ship.HydrostaticsMaxDraft.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.maxDraft.setText(length_format.format(
1.1 * self.ship.Draft.getValueAs('m').Value))
try:
props.index("HydrostaticsNDraft")
form.nDraft.setValue(self.ship.HydrostaticsNDraft)
except ValueError:
pass
return False
def initValues(self):
""" Set initial values for fields
"""
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" objects selected)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
for i in range(0, len(selObjs)):
obj = selObjs[i]
props = obj.PropertiesList
try:
props.index("IsShip")
except ValueError:
continue
if obj.IsShip:
if self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"More than one ship have been selected (the extra"
" ships will be ignored)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintWarning(msg + '\n')
break
self.ship = obj
if not self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" valid ship found at the selected objects)",
None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
length_format = USys.getLengthFormat()
angle_format = USys.getAngleFormat()
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.draft = self.widget(QtGui.QLineEdit, "Draft")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.draft.setText(Locale.toString(length_format.format(
self.ship.Draft.getValueAs(USys.getLengthUnits()).Value)))
form.trim.setText(Locale.toString(angle_format.format(0.0)))
# Try to use saved values
props = self.ship.PropertiesList
try:
props.index("AreaCurveDraft")
form.draft.setText(Locale.toString(length_format.format(
self.ship.AreaCurveDraft.getValueAs(
USys.getLengthUnits()).Value)))
except:
pass
try:
props.index("AreaCurveTrim")
form.trim.setText(Locale.toString(angle_format.format(
self.ship.AreaCurveTrim.getValueAs(
USys.getAngleUnits()).Value)))
except ValueError:
pass
# Update GUI
draft = Units.Quantity(form.draft.text()).getValueAs('m').Value
trim = Units.Quantity(form.trim.text()).getValueAs('deg').Value
self.preview.update(draft, trim, self.ship)
self.onUpdate()
return False
def initValues(self):
"""Setup the initial values"""
self.solids = None
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"Ship objects can only be created on top of hull geometry"
" (no objects selected)", None)
App.Console.PrintError(msg + '\n')
msg = QtGui.QApplication.translate(
"ship_console",
"Please create or load a ship hull geometry before using"
" this tool", None)
App.Console.PrintError(msg + '\n')
return True
self.solids = []
for i in range(0, len(selObjs)):
solids = self.getSolids(selObjs[i])
for j in range(0, len(solids)):
self.solids.append(solids[j])
if not self.solids:
msg = QtGui.QApplication.translate(
"ship_console",
"Ship objects can only be created on top of hull geometry"
" (no solid found at selected objects)", None)
App.Console.PrintError(msg + '\n')
msg = QtGui.QApplication.translate(
"ship_console",
"Please create or load a ship hull geometry before using"
" this tool", None)
App.Console.PrintError(msg + '\n')
return True
# Get the ship bounds. The ship instance can not have dimensions
# out of these values.
self.bounds = [0.0, 0.0, 0.0]
bbox = self.solids[0].BoundBox
minX = bbox.XMin
maxX = bbox.XMax
minY = bbox.YMin
maxY = bbox.YMax
minZ = bbox.ZMin
maxZ = bbox.ZMax
for i in range(1, len(self.solids)):
bbox = self.solids[i].BoundBox
if minX > bbox.XMin:
minX = bbox.XMin
if maxX < bbox.XMax:
maxX = bbox.XMax
if minY > bbox.YMin:
minY = bbox.YMin
if maxY < bbox.YMax:
maxY = bbox.YMax
if minZ > bbox.ZMin:
minZ = bbox.ZMin
if maxZ < bbox.ZMax:
maxZ = bbox.ZMax
self.bounds[0] = maxX - minX
self.bounds[1] = max(maxY - minY, abs(maxY), abs(minY))
self.bounds[2] = maxZ - minZ
input_format = USys.getLengthFormat()
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.length = self.widget(QtGui.QLineEdit, "Length")
form.breadth = self.widget(QtGui.QLineEdit, "Breadth")
form.draft = self.widget(QtGui.QLineEdit, "Draft")
qty = Units.Quantity(self.bounds[0], Units.Length)
form.length.setText(
Locale.toString(
input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
self.L = self.bounds[0] / Units.Metre.Value
qty = Units.Quantity(self.bounds[1], Units.Length)
form.breadth.setText(
Locale.toString(
input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value)))
self.B = self.bounds[1] / Units.Metre.Value
qty = Units.Quantity(self.bounds[2], Units.Length)
form.draft.setText(
Locale.toString(
input_format.format(
0.5 * qty.getValueAs(USys.getLengthUnits()).Value)))
self.T = 0.5 * self.bounds[2] / Units.Metre.Value
return False
def getVolume(self, fp, level, return_shape=False):
"""Return the fluid volume inside the tank, provided the filling level.
Keyword arguments:
fp -- Part::FeaturePython object affected.
level -- Percentage of filling level (interval [0, 1]).
return_shape -- False if the tool should return the fluid volume value,
True if the tool should return the volume shape.
"""
if level <= 0.0:
if return_shape:
return Part.Vertex()
return Units.Quantity(0.0, Units.Volume)
if level >= 1.0:
if return_shape:
return fp.Shape.copy()
return Units.Quantity(fp.Shape.Volume, Units.Volume)
# Build up the cutting box
bbox = fp.Shape.BoundBox
dx = bbox.XMax - bbox.XMin
dy = bbox.YMax - bbox.YMin
dz = bbox.ZMax - bbox.ZMin
box = App.ActiveDocument.addObject("Part::Box", "Box")
length_format = USys.getLengthFormat()
box.Placement = Placement(
Vector(bbox.XMin - dx, bbox.YMin - dy, bbox.ZMin - dz),
Rotation(App.Vector(0, 0, 1), 0))
box.Length = length_format.format(3.0 * dx)
box.Width = length_format.format(3.0 * dy)
box.Height = length_format.format((1.0 + level) * dz)
# Create a new object on top of a copy of the tank shape
Part.show(fp.Shape.copy())
tank = App.ActiveDocument.Objects[-1]
# Compute the common boolean operation
App.ActiveDocument.recompute()
common = App.activeDocument().addObject("Part::MultiCommon",
"TankVolHelper")
common.Shapes = [tank, box]
App.ActiveDocument.recompute()
if len(common.Shape.Solids) == 0:
# The common operation is failing, let's try moving a bit the free
# surface
msg = QtGui.QApplication.translate(
"ship_console",
"Tank volume operation failed. The tool is retrying that"
" slightly moving the free surface position", None)
App.Console.PrintWarning(msg + '\n')
rand_bounds = 0.01 * dz
i = 0
while len(common.Shape.Solids
) == 0 and i < COMMON_BOOLEAN_ITERATIONS:
i += 1
box.Height = length_format.format(
(1.0 + level) * dz +
random.uniform(-random_bounds, random_bounds))
App.ActiveDocument.recompute()
if return_shape:
ret_value = common.Shape.copy()
else:
ret_value = Units.Quantity(common.Shape.Volume, Units.Volume)
App.ActiveDocument.removeObject(common.Name)
App.ActiveDocument.removeObject(tank.Name)
App.ActiveDocument.removeObject(box.Name)
App.ActiveDocument.recompute()
return ret_value
def getUnderwaterSide(shape, force=True):
"""Get the underwater shape, simply cropping the provided shape by the z=0
free surface plane.
Position arguments:
shape -- Solid shape to be cropped
Keyword arguments:
force -- True if in case the common boolean operation fails, i.e. returns
no solids, the tool should retry it slightly moving the free surface. False
otherwise. (True by default)
Returned value:
Cropped shape. It is not modifying the input shape
"""
# Convert the shape into an active object
Part.show(shape)
orig = App.ActiveDocument.Objects[-1]
bbox = shape.BoundBox
xmin = bbox.XMin
xmax = bbox.XMax
ymin = bbox.YMin
ymax = bbox.YMax
zmin = bbox.ZMin
zmax = bbox.ZMax
# Create the "sea" box to intersect the ship
L = xmax - xmin
B = ymax - ymin
H = zmax - zmin
box = App.ActiveDocument.addObject("Part::Box", "Box")
length_format = USys.getLengthFormat()
box.Placement = Placement(Vector(xmin - L, ymin - B, zmin - H),
Rotation(App.Vector(0, 0, 1), 0))
box.Length = length_format.format(3.0 * L)
box.Width = length_format.format(3.0 * B)
box.Height = length_format.format(-zmin + H)
App.ActiveDocument.recompute()
common = App.activeDocument().addObject("Part::MultiCommon",
"UnderwaterSideHelper")
common.Shapes = [orig, box]
App.ActiveDocument.recompute()
if force and len(common.Shape.Solids) == 0:
# The common operation is failing, let's try moving a bit the free
# surface
msg = QtGui.QApplication.translate(
"ship_console",
"Boolean operation failed when trying to get the underwater side."
" The tool is retrying such operation slightly moving the free"
" surface position", None)
App.Console.PrintWarning(msg + '\n')
random_bounds = 0.01 * H
i = 0
while len(common.Shape.Solids) == 0 and i < COMMON_BOOLEAN_ITERATIONS:
i += 1
box.Height = length_format.format(
-zmin + H + random.uniform(-random_bounds, random_bounds))
App.ActiveDocument.recompute()
out = common.Shape
App.ActiveDocument.removeObject(common.Name)
App.ActiveDocument.removeObject(orig.Name)
App.ActiveDocument.removeObject(box.Name)
App.ActiveDocument.recompute()
return out
def onData(self, value):
""" Method called when input data is changed.
@param value Changed value.
"""
if not self.ship:
return
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.minDraft = self.widget(QtGui.QLineEdit, "MinDraft")
form.maxDraft = self.widget(QtGui.QLineEdit, "MaxDraft")
# Get the values (or fix them in bad setting case)
try:
trim = Units.Quantity(form.trim.text()).getValueAs('deg').Value
except:
trim = 0.0
input_format = USys.getAngleFormat()
qty = Units.Quantity('{} deg'.format(trim))
form.trim.setText(
input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
try:
min_draft = Units.Quantity(
form.minDraft.text()).getValueAs('m').Value
except:
min_draft = 0.9 * self.ship.Draft.getValueAs('m').Value
input_format = USys.getLengthFormat()
qty = Units.Quantity('{} m'.format(min_draft))
form.minDraft.setText(
input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
try:
max_draft = Units.Quantity(
form.minDraft.text()).getValueAs('m').Value
except:
max_draft = 0.9 * self.ship.Draft.getValueAs('m').Value
input_format = USys.getLengthFormat()
qty = Units.Quantity('{} m'.format(max_draft))
form.maxDraft.setText(
input_format.format(
qty.getValueAs(USys.getLengthUnits()).Value))
# Clamp the values to the bounds
bbox = self.ship.Shape.BoundBox
draft_min = bbox.ZMin / Units.Metre.Value
draft_max = bbox.ZMax / Units.Metre.Value
min_draft = self.clampLength(form.minDraft, draft_min, draft_max,
min_draft)
max_draft = self.clampLength(form.maxDraft, draft_min, draft_max,
max_draft)
trim_min = -180.0
trim_max = 180.0
trim = self.clampAngle(form.trim, trim_min, trim_max, trim)
# Clamp draft values to assert that the minimum value is lower than
# the maximum one
min_draft = self.clampLength(form.minDraft, draft_min, max_draft,
min_draft)
max_draft = self.clampLength(form.maxDraft, min_draft, draft_max,
max_draft)
def initValues(self):
""" Set initial values for fields
"""
mw = self.getMainWindow()
form = mw.findChild(QtGui.QWidget, "TaskPanel")
form.trim = self.widget(QtGui.QLineEdit, "Trim")
form.minDraft = self.widget(QtGui.QLineEdit, "MinDraft")
form.maxDraft = self.widget(QtGui.QLineEdit, "MaxDraft")
form.nDraft = self.widget(QtGui.QSpinBox, "NDraft")
selObjs = Gui.Selection.getSelection()
if not selObjs:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" objects selected)", None, QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
for i in range(len(selObjs)):
obj = selObjs[i]
props = obj.PropertiesList
try:
props.index("IsShip")
except ValueError:
continue
if obj.IsShip:
if self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"More than one ship have been selected (the extra"
" ships will be ignored)", None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintWarning(msg + '\n')
break
self.ship = obj
if not self.ship:
msg = QtGui.QApplication.translate(
"ship_console",
"A ship instance must be selected before using this tool (no"
" valid ship found at the selected objects)", None,
QtGui.QApplication.UnicodeUTF8)
App.Console.PrintError(msg + '\n')
return True
props = self.ship.PropertiesList
length_format = USys.getLengthFormat()
angle_format = USys.getAngleFormat()
try:
props.index("HydrostaticsTrim")
form.trim.setText(
angle_format.format(
self.ship.HydrostaticsTrim.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.trim.setText(angle_format.format(0.0))
try:
props.index("HydrostaticsMinDraft")
form.minDraft.setText(
length_format.format(
self.ship.HydrostaticsMinDraft.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.minDraft.setText(
length_format.format(0.9 *
self.ship.Draft.getValueAs('m').Value))
try:
props.index("HydrostaticsMaxDraft")
form.maxDraft.setText(
length_format.format(
self.ship.HydrostaticsMaxDraft.getValueAs(
USys.getLengthUnits()).Value))
except ValueError:
form.maxDraft.setText(
length_format.format(1.1 *
self.ship.Draft.getValueAs('m').Value))
try:
props.index("HydrostaticsNDraft")
form.nDraft.setValue(self.ship.HydrostaticsNDraft)
except ValueError:
pass
return False
def getVolume(self, fp, level, return_shape=False):
"""Return the fluid volume inside the tank, provided the filling level.
Keyword arguments:
fp -- Part::FeaturePython object affected.
level -- Percentage of filling level (interval [0, 1]).
return_shape -- False if the tool should return the fluid volume value,
True if the tool should return the volume shape.
"""
if level <= 0.0:
if return_shape:
return Part.Vertex()
return Units.Quantity(0.0, Units.Volume)
if level >= 1.0:
if return_shape:
return fp.Shape.copy()
return Units.Quantity(fp.Shape.Volume, Units.Volume)
# Build up the cutting box
bbox = fp.Shape.BoundBox
dx = bbox.XMax - bbox.XMin
dy = bbox.YMax - bbox.YMin
dz = bbox.ZMax - bbox.ZMin
box = App.ActiveDocument.addObject("Part::Box","Box")
length_format = USys.getLengthFormat()
box.Placement = Placement(Vector(bbox.XMin - dx,
bbox.YMin - dy,
bbox.ZMin - dz),
Rotation(App.Vector(0,0,1),0))
box.Length = length_format.format(3.0 * dx)
box.Width = length_format.format(3.0 * dy)
box.Height = length_format.format((1.0 + level) * dz)
# Create a new object on top of a copy of the tank shape
Part.show(fp.Shape.copy())
tank = App.ActiveDocument.Objects[-1]
# Compute the common boolean operation
App.ActiveDocument.recompute()
common = App.activeDocument().addObject("Part::MultiCommon",
"TankVolHelper")
common.Shapes = [tank, box]
App.ActiveDocument.recompute()
if len(common.Shape.Solids) == 0:
# The common operation is failing, let's try moving a bit the free
# surface
msg = QtGui.QApplication.translate(
"ship_console",
"Tank volume operation failed. The tool is retrying that"
" slightly moving the free surface position",
None)
App.Console.PrintWarning(msg + '\n')
rand_bounds = 0.01 * dz
i = 0
while len(common.Shape.Solids) == 0 and i < COMMON_BOOLEAN_ITERATIONS:
i += 1
box.Height = length_format.format(
(1.0 + level) * dz + random.uniform(-random_bounds,
random_bounds))
App.ActiveDocument.recompute()
if return_shape:
ret_value = common.Shape.copy()
else:
ret_value = Units.Quantity(common.Shape.Volume, Units.Volume)
App.ActiveDocument.removeObject(common.Name)
App.ActiveDocument.removeObject(tank.Name)
App.ActiveDocument.removeObject(box.Name)
App.ActiveDocument.recompute()
return ret_value