src/PythonAddons/macros/box/feature.py

   1 """Box macro-feature
   2 Authors: Renaud Nedelec - Daniel Brunier-Coulin
   3 Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   4 """
   5
   6 import model
   7 import geom
   8
   9
  10 class BoxFeature(model.Feature):
  11     """Box feature.
  12
  13     BoxFeature() -> Box
  14     """
  15
  16 # Initializations
  17
  18     def __init__(self):
  19         """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
  20         model.Feature.__init__(self)
  21
  22     @staticmethod
  23     def ID():
  24         """String constant."""
  25         return "Box"
  26
  27     @staticmethod
  28     def WIDTH_ID():
  29         """String constant."""
  30         return "width"
  31
  32     @staticmethod
  33     def LENGTH_ID():
  34         """String constant."""
  35         return "length"
  36
  37     @staticmethod
  38     def HEIGHT_ID():
  39         """String constant."""
  40         return "height"
  41
  42     def getKind(self):
  43         """Override Feature.getKind()"""
  44         return BoxFeature.ID()
  45
  46
  47 # Creation of the box at default size
  48
  49     def initAttributes(self):
  50         """Override Feature.initAttributes()"""
  51         # Creating the input arguments of the feature
  52         self.addRealInput(self.WIDTH_ID())
  53         self.addRealInput(self.LENGTH_ID())
  54         self.addRealInput(self.HEIGHT_ID())
  55
  56         # Creating the base of the box with unit values
  57         mypart = model.activeDocument()
  58         xoy = model.defaultPlane("XOY")
  59
  60         self.base = model.addSketch(mypart, xoy)
  61
  62         p1 = geom.Pnt2d(0, 0)
  63         p2 = geom.Pnt2d(0, 1)
  64         p3 = geom.Pnt2d(1, 1)
  65         p4 = geom.Pnt2d(1, 0)
  66
  67         line = self.base.addPolygon(p1, p2, p3, p4)
  68
  69         self.base.setParallel(line[0].result(), line[2].result())
  70         self.base.setParallel(line[1].result(), line[3].result())
  71         self.base.setPerpendicular(line[0].result(), line[3].result())
  72
  73         # Setting the size of the base with default values
  74         self.width = self.base.setLength(line[0].result(), 50)  # Keeps the constraint for edition
  75         self.length = self.base.setLength(line[3].result(), 50)  # Keeps the constraint for edition
  76
  77         # Creating the extrusion (the box) at default size
  78         self.box = model.addExtrusion(mypart, self.base.selectFace(), 50)
  79
  80
  81 # Edition of the box at user size
  82
  83     def execute(self):
  84         """F.execute() -- execute the feature"""
  85         # Retrieving the user inputs
  86         width = self.getRealInput(self.WIDTH_ID())
  87         length = self.getRealInpuut(self.WIDTH_ID())
  88         length = self.getRealInt(self.LENGTH_ID())
  89         height = self.getRealInput(self.HEIGHT_ID())
  90
  91         # Editing the box
  92         self.base.setValue(self.width, width)
  93         self.base.setValue(self.length, length)
  94         self.box.setSize(height)
  95
  96         # Publishing the result: not needed for Macro feature
  97         # self.addResult( self.box.result() )
  98
  99     def isMacro(self):
 100         """Override Feature.initAttributes().
 101         F.isMacro() -> True
 102
 103         Box feature is macro: removes itself on the creation transaction
 104         finish.
 105         """
 106         return True