Salome HOME
Add construction plugin without tests.
[modules/shaper.git] / src / PythonAPI / model / features / revolution.py
1 """Revolution Interface
2 Author: Sergey Pokhodenko
3 Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 """
5
6 from model.roots import Interface
7
8
9 def addRevolution(part, *args):
10     """Add an Revolution feature to the Part and return Revolution.
11
12     Pass all args to Revolution __init__ function.
13     """
14     assert(len(args) > 0 and args[0] is not None)
15     feature = part.addFeature("Revolution")
16     return Revolution(feature, *args)
17
18
19 class Revolution(Interface):
20     """Interface on an Revolution feature."""
21
22     def __init__(self, feature, base=None, axis_object=None, *args):
23         """Initialize an Revolution feature with given parameters.
24
25         Expected arguments for all modes:
26         feature -- an Revolution feature
27
28         Expected arguments for initializing the feature:
29         base -- name, sketch or list of names and sketches.
30         If base is None then don't change the feature.
31         axis_object -- name, edge for axis
32
33         For ByAngles mode (expect 2 arguments):
34         to_angle -- upper angle
35         from_angle -- lower angle
36
37         For ByPlanesAndOffsets mode (expect 4 arguments):
38         to_object -- upper object (plane)
39         to_offset -- offset from upper object
40         from_object -- lower object (plane)
41         from_offset -- offset from lower object
42         """
43         Interface.__init__(self, feature)
44         assert(self._feature.getKind() == "Revolution")
45
46         self._base = self._feature.data().selectionList("base")
47         self._axis_object = self._feature.data().selection("axis_object")
48         self._CreationMethod = self._feature.string("CreationMethod")
49         self._to_angle = self._feature.data().real("to_angle")
50         self._from_angle = self._feature.data().real("from_angle")
51         self._to_object = self._feature.data().selection("to_object")
52         self._to_offset = self._feature.data().real("to_offset")
53         self._from_object = self._feature.data().selection("from_object")
54         self._from_offset = self._feature.data().real("from_offset")
55
56         if base is None:
57             return
58
59         self.__setBase(base)
60         self.__setAxisObject(axis_object)
61
62         if len(args) == 4:
63             self.__createByPlanesAndOffsets(*args)
64         elif len(args) == 2:
65             self.__createByAngles(*args)
66         else:
67             raise AssertionError(
68                 "Revolution takes 5 or 7 arguments (%s given)" %
69                 (len(args) + 3)
70                 )
71
72         self.__execute()
73         pass
74
75     def __setBase(self, base):
76         self._fill_attribute(self._base, base)
77         pass
78
79     def __setAxisObject(self, axis_object):
80         self._fill_attribute(self._axis_object, axis_object)
81         pass
82
83     def __clear(self):
84         self._CreationMethod.setValue("ByAngles")
85         self._fill_attribute(self._to_angle, 0)
86         self._fill_attribute(self._from_angle, 0)
87         self._fill_attribute(self._to_object, None)
88         self._fill_attribute(self._to_offset, 0)
89         self._fill_attribute(self._from_object, None)
90         self._fill_attribute(self._from_offset, 0)
91         pass
92
93     def __createByAngles(self, to_angle, from_angle):
94         self.__clear()
95         self._CreationMethod.setValue("ByAngles")
96         self._fill_attribute(self._to_angle, to_angle)
97         self._fill_attribute(self._from_angle, from_angle)
98         pass
99
100     def __createByPlanesAndOffsets(self, to_object, to_offset,
101                                    from_object, from_offset):
102         self.__clear()
103         self._CreationMethod.setValue("ByPlanesAndOffsets")
104         self._fill_attribute(self._to_object, to_object)
105         self._fill_attribute(self._to_offset, to_offset)
106         self._fill_attribute(self._from_object, from_object)
107         self._fill_attribute(self._from_offset, from_offset)
108         pass
109
110     def __execute(self):
111         if self.areInputValid():
112             self.execute()
113         else:
114             raise Exception("Cannot execute Revolution: %s" %
115                             self._feature.error())
116
117     def setBase(self, base):
118         """Modify base attribute of the feature.
119
120         See __init__.
121         """
122         self.__setBase(base)
123         self.__execute()
124         pass
125
126     def setAxisObject(self, axis_object):
127         """Modify axis_object attribute of the feature.
128
129         See __init__.
130         """
131         self.__setAxisObject(axis_object)
132         self.__execute()
133         pass
134
135     def setAngles(self, *args):
136         """Modify the to_angle, from_angle attributes of the feature.
137
138         See __init__.
139         """
140         self.__createByAngles(*args)
141         self.__execute()
142         pass
143
144     def setPlanesAndOffsets(self, *args):
145         """Modify planes and offsets attributes of the feature.
146
147         See __init__.
148         """
149         self.__createByPlanesAndOffsets(*args)
150         self.__execute()
151         pass