0022857: EDF GEOM 7167: MakeHalfPartition documentation

This commit is contained in:
vsr 2015-02-27 15:07:51 +03:00
parent eaee8de41c
commit d34e7eebf2
3 changed files with 42 additions and 0 deletions

View File

@ -3208,6 +3208,17 @@ module GEOM
* \param theShape Shape to be intersected. * \param theShape Shape to be intersected.
* \param thePlane Tool shape, to intersect theShape. * \param thePlane Tool shape, to intersect theShape.
* \return New GEOM_Object, containing the result shape. * \return New GEOM_Object, containing the result shape.
*
* \note This operation is a shortcut to the more general \ref MakePartition
* operation, where \a theShape specifies single "object" (shape being partitioned)
* and \a thePlane specifies single "tool" (intersector shape). Other parameters of
* \ref MakePartition operation have default values:
* - \a theLimit: GEOM::SHAPE (shape limit corresponds to the type of \a theShape)
* - \a theKeepNonlimitShapes: 0
* - \a theKeepInside, \a theRemoveInside, \a theRemoveWebs,
* \a theMaterials (obsolete parameters): empty
*
* \sa MakePartition, MakePartitionNonSelfIntersectedShape
*/ */
GEOM_Object MakeHalfPartition (in GEOM_Object theShape, GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
in GEOM_Object thePlane); in GEOM_Object thePlane);

View File

@ -7925,6 +7925,23 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
# #
# @return New GEOM.GEOM_Object, containing the result shape. # @return New GEOM.GEOM_Object, containing the result shape.
# #
# @note This operation is a shortcut to the more general @ref MakePartition
# operation, where @a theShape specifies single "object" (shape being partitioned)
# and @a thePlane specifies single "tool" (intersector shape). Other parameters of
# @ref MakePartition operation have default values:
# - @a Limit: GEOM::SHAPE (shape limit corresponds to the type of @a theShape)
# - @a KeepNonlimitShapes: 0
# - @a KeepInside, @a RemoveInside, @a RemoveWebs,
# @a Materials (obsolete parameters): empty
#
# @note I.e. the following two operations are equivalent:
# @code
# Result = geompy.MakeHalfPartition(Object, Plane)
# Result = geompy.MakePartition([Object], [Plane])
# @endcode
#
# @sa MakePartition, MakePartitionNonSelfIntersectedShape
#
# @ref tui_partition "Example" # @ref tui_partition "Example"
@ManageTransactions("BoolOp") @ManageTransactions("BoolOp")
def MakeHalfPartition(self, theShape, thePlane, theName=None): def MakeHalfPartition(self, theShape, thePlane, theName=None):
@ -7940,6 +7957,18 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
Returns: Returns:
New GEOM.GEOM_Object, containing the result shape. New GEOM.GEOM_Object, containing the result shape.
Note: This operation is a shortcut to the more general MakePartition
operation, where theShape specifies single "object" (shape being partitioned)
and thePlane specifies single "tool" (intersector shape). Other parameters of
MakePartition operation have default values:
- Limit: GEOM::SHAPE (shape limit corresponds to the type of theShape)
- KeepNonlimitShapes: 0
- KeepInside, RemoveInside, RemoveWebs, Materials (obsolete parameters): empty
I.e. the following two operations are equivalent:
Result = geompy.MakeHalfPartition(Object, Plane)
Result = geompy.MakePartition([Object], [Plane])
""" """
# Example: see GEOM_TestAll.py # Example: see GEOM_TestAll.py
anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane) anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)

View File

@ -67,6 +67,8 @@ OperationGUI_PartitionDlg::OperationGUI_PartitionDlg( GeometryGUI* theGeometryGU
mainFrame()->GroupConstructors->setTitle( tr( "GEOM_PARTITION" ) ); mainFrame()->GroupConstructors->setTitle( tr( "GEOM_PARTITION" ) );
mainFrame()->RadioButton1->setIcon( image0 ); mainFrame()->RadioButton1->setIcon( image0 );
mainFrame()->RadioButton2->setIcon( image1 ); mainFrame()->RadioButton2->setIcon( image1 );
mainFrame()->RadioButton2->setAttribute( Qt::WA_DeleteOnClose );
mainFrame()->RadioButton2->close();
mainFrame()->RadioButton3->setAttribute( Qt::WA_DeleteOnClose ); mainFrame()->RadioButton3->setAttribute( Qt::WA_DeleteOnClose );
mainFrame()->RadioButton3->close(); mainFrame()->RadioButton3->close();