Copyright (C) 2014-20xx CEA/DEN, EDF R&D
"""
-import modeler
-import geom
+from salome.shaper import model
+from salome.shaper import geom
-class BoxFeature(modeler.Feature):
+class BoxFeature(model.Feature):
+ """An example of Box feature implementation.
+ BoxFeature() -> Box
+ """
# Initializations
- def __init__(self):
- modeler.Feature.__init__(self)
+ def __init__(self):
+ """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
+ model.Feature.__init__(self)
- @staticmethod
- def ID():
- return "Box"
+ @staticmethod
+ def ID():
+ """Return Id of the feature."""
+ return "Box_script"
- @staticmethod
- def WIDTH_ID():
- return "width"
+ @staticmethod
+ def WIDTH_ID():
+ """Returns ID of Width parameter."""
+ return "width"
- @staticmethod
- def LENGTH_ID():
- return "length"
+ @staticmethod
+ def LENGTH_ID():
+ """Returns ID of Length parameter."""
+ return "length"
- @staticmethod
- def HEIGHT_ID():
- return "height"
+ @staticmethod
+ def HEIGHT_ID():
+ """Returns ID of Height parameter."""
+ return "height"
- def getKind(self):
- return BoxFeature.ID()
+ def getKind(self):
+ """Override Feature.getKind()"""
+ return BoxFeature.ID()
-
-# Creation of the box at default size
-
- def initAttributes(self):
-
- # Creating the input arguments of the feature
- self.addRealInput( self.WIDTH_ID() )
- self.addRealInput( self.LENGTH_ID() )
- self.addRealInput( self.HEIGHT_ID() )
- # Creating the base of the box with unit values
- mypart = modeler.activeDocument()
- xoy = modeler.defaultPlane("XOY")
+# Creation of the box at default size
- self.base = modeler.addSketch( mypart, xoy )
+ def initAttributes(self):
+ """Override Feature.initAttributes()"""
+ # Creating the input arguments of the feature
+ self.addRealInput(self.WIDTH_ID())
+ self.addRealInput(self.LENGTH_ID())
+ self.addRealInput(self.HEIGHT_ID())
- p1 = geom.Pnt2d( 0, 0 )
- p2 = geom.Pnt2d( 0, 1 )
- p3 = geom.Pnt2d( 1, 1 )
- p4 = geom.Pnt2d( 1, 0 )
+ # Creating the base of the box with unit values
+ mypart = model.activeDocument()
+ xoy = model.defaultPlane("XOY")
- line = self.base.addPolygon(p1, p2, p3, p4)
+ # A base of the geometry
+ self.base = model.addSketch(mypart, xoy)
- self.base.setParallel( line[0].result(), line[2].result() )
- self.base.setParallel( line[1].result(), line[3].result() )
- self.base.setPerpendicular( line[0].result(), line[3].result() )
+ p1 = geom.Pnt2d(0, 0)
+ p2 = geom.Pnt2d(0, 1)
+ p3 = geom.Pnt2d(1, 1)
+ p4 = geom.Pnt2d(1, 0)
- # Setting the size of the base with default values
- self.width = self.base.setLength( line[0].result(), 50 ) # Keeps the constraint for edition
- self.length = self.base.setLength( line[3].result(), 50 ) # Keeps the constraint for edition
+ line = model.addPolygon(self.base, p1, p2, p3, p4)
- # Creating the extrusion (the box) at default size
- self.box = modeler.addExtrusion( mypart, self.base.selectFace(), 50 )
+ self.base.setFixed(line[0].startPoint())
+ self.base.setVertical(line[0])
-
-# Edition of the box at user size
+ # Setting the size of the base with default values
+ # Width
+ self.width = self.base.setLength(line[3], 50) # Keeps the constraint for edition
+ # Length
+ self.length = self.base.setLength(line[0], 50) # Keeps the constraint for edition
- def execute(self):
- # Retrieving the user inputs
- width = self.getRealInput( self.WIDTH_ID() )
- length = self.getRealInput( self.LENGTH_ID() )
- height = self.getRealInput( self.HEIGHT_ID() )
+ # Keeping the rectangle
+ self.base.setParallel(line[0], line[2])
+ self.base.setParallel(line[1], line[3])
+ self.base.setPerpendicular(line[0], line[3])
- # Editing the box
- self.base.setValue( self.width, width )
- self.base.setValue( self.length, length )
- self.box.setSize( height )
+ # execute sketch
+ model.do()
- # Publishing the result
- self.addResult( self.box.result() )
+ # Creating the extrusion (the box) at default size
+ # A box result
+ self.box = model.addExtrusion(mypart, self.base.selectFace(), 50)
-
+# Edition of the box at user size
+ def execute(self):
+ """F.execute() -- execute the feature"""
+ # Retrieving the user inputs
+ width = self.real(self.WIDTH_ID())
+ length = self.real(self.LENGTH_ID())
+ height = self.real(self.HEIGHT_ID())
+
+ # Editing the box
+ if width.text() == "":
+ self.base.setValue(self.width, width.value())
+ else:
+ self.base.setValue(self.width, width.text())
+
+ if length.text() == "":
+ self.base.setValue(self.length, length.value())
+ else:
+ self.base.setValue(self.length, length.text())
+
+ if (height.text() == ""):
+ self.box.setSize(height.value())
+ else:
+ self.box.setSize(height.text())
+
+ # Publishing the result: not needed for Macro feature
+ # self.addResult( self.box.result() )
+
+ def isMacro(self):
+ """Override Feature.initAttributes().
+ F.isMacro() -> True
+
+ Box feature is macro: removes itself on the creation transaction
+ finish.
+ """
+ return True