X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPythonAPI%2Fmodel%2Ffeatures%2Fextrusion_boolean.py;h=199d1e1d990a691e361646e63f3cac7c3f929e54;hb=163192afd6eaa35db5c8b961e924962644e4f9dc;hp=9399e860a45e32cfdedc16d1270b12a22a2f5031;hpb=cc2a5c393262911987a4a036b60ff50178f32655;p=modules%2Fshaper.git diff --git a/src/PythonAPI/model/features/extrusion_boolean.py b/src/PythonAPI/model/features/extrusion_boolean.py index 9399e860a..199d1e1d9 100644 --- a/src/PythonAPI/model/features/extrusion_boolean.py +++ b/src/PythonAPI/model/features/extrusion_boolean.py @@ -7,9 +7,32 @@ from .roots import CompositeBoolean def addExtrusionCut(part, *args): - """Add an ExtrusionCut feature to the Part and return ExtrusionBoolean. - - Pass all args to Extrusion __init__ function. + """Add an ExtrusionCut feature to the Part. + + .. function:: addExtrusionCut(part, sketch, sketch_selection, boolean_objects, to_size, from_size) + + Args: + part (ModelAPI_Document): part document + sketch (ModelAPI_Object): sketch feature + sketch_selection (Selection): sketch objects + boolean_objects (list of Selection): boolean objects + to_size (double): upper size of the extrusion + from_size (double): lower size of the extrusion + + .. function:: addExtrusionCut(part, sketch, sketch_selection, boolean_objects, to_object, to_offset, from_object, from_offset) + + Args: + part (ModelAPI_Document): part document + sketch (ModelAPI_Object): sketch feature + sketch_selection (Selection): sketch objects + boolean_objects (list of Selection): boolean objects + to_object (Selection): upper plane + to_offset (double): offset from upper plane + from_object (Selection): lower plane + from_offset (double): offset from lower plane + + Returns: + ExtrusionBoolean: extrusion boolean object """ assert(args) feature = part.addFeature("ExtrusionCut") @@ -18,7 +41,30 @@ def addExtrusionCut(part, *args): def addExtrusionFuse(part, *args): """Add an ExtrusionFuse feature to the Part and return ExtrusionBoolean. - Pass all args to Extrusion __init__ function. + .. function:: addExtrusionFuse(part, sketch, sketch_selection, boolean_objects, to_size, from_size) + + Args: + part (ModelAPI_Document): part document + sketch (ModelAPI_Object): sketch feature + sketch_selection (Selection): sketch objects + boolean_objects (list of Selection): boolean objects + to_size (double): upper size of the extrusion + from_size (double): lower size of the extrusion + + .. function:: addExtrusionFuse(part, sketch, sketch_selection, boolean_objects, to_object, to_offset, from_object, from_offset) + + Args: + part (ModelAPI_Document): part document + sketch (ModelAPI_Object): sketch feature + sketch_selection (Selection): sketch objects + boolean_objects (list of Selection): boolean objects + to_object (Selection): upper plane + to_offset (double): offset from upper plane + from_object (Selection): lower plane + from_offset (double): offset from lower plane + + Returns: + ExtrusionBoolean: extrusion boolean object """ assert(args) feature = part.addFeature("ExtrusionFuse") @@ -29,30 +75,21 @@ class ExtrusionBoolean(CompositeBoolean): """Interface class for ExtrusionBoolean features. Supported features: - - ExtrusionCut - - ExtrusionFuse - - ExtrusionBoolean(feature) -> feature interface without initialization - ExtrusionBoolean(feature, - sketch, sketch_selection, boolean_objects, - to_size, from_size) -> - feature interface initialized from arguments: - - sketch - - sketch_selection - - boolean_objects - - to_size - - from_size - ExtrusionBoolean(feature, - sketch, sketch_selection, boolean_objects, - to_object, to_offset, from_object, from_offset) -> - feature interface initialized from arguments: - - sketch - - sketch_selection - - boolean_objects - - to_object - - to_offset - - from_object - - from_offset + + * ExtrusionCut + * ExtrusionFuse + + .. function:: ExtrusionBoolean(feature) + + Create interface for the feature without initialization. + + .. function:: ExtrusionBoolean(feature, sketch, sketch_selection, boolean_objects, to_size, from_size) + + Create interface for the feature and initialize the feature with arguments. + + .. function:: ExtrusionBoolean(feature, sketch, sketch_selection, boolean_objects, to_object, to_offset, from_object, from_offset) + + Create interface for the feature and initialize the feature with arguments. """ def __init__(self, feature, *args): @@ -85,7 +122,7 @@ class ExtrusionBoolean(CompositeBoolean): elif len(args) == 2: self.setSizes(*args) - self._execute() + self.execute() pass def __clear(self):