Version: 8.3.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages

Functions

def MakeBoolean
 Perform one of boolean operations on two given shapes. More...
 
def MakeCommon
 Perform Common boolean operation on two given shapes. More...
 
def MakeCut
 Perform Cut boolean operation on two given shapes. More...
 
def MakeFuse
 Perform Fuse boolean operation on two given shapes. More...
 
def MakeSection
 Perform Section boolean operation on two given shapes. More...
 
def MakeFuseList
 Perform Fuse boolean operation on the list of shapes. More...
 
def MakeCommonList
 Perform Common boolean operation on the list of shapes. More...
 
def MakeCutList
 Perform Cut boolean operation on one object and the list of tools. More...
 

Detailed Description

Function Documentation

def MakeBoolean (   self,
  theShape1,
  theShape2,
  theOperation,
  checkSelfInte = False,
  theName = None 
)

Perform one of boolean operations on two given shapes.

Parameters
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
theOperationIndicates the operation to be done:
1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example

References geomBuilder._autoPublish(), geomBuilder.BoolOp, and geomBuilder.RaiseIfFailed().

def MakeCommon (   self,
  theShape1,
  theShape2,
  checkSelfInte = False,
  theName = None 
)

Perform Common boolean operation on two given shapes.

Parameters
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder.MakeBoolean().

def MakeCut (   self,
  theShape1,
  theShape2,
  checkSelfInte = False,
  theName = None 
)

Perform Cut boolean operation on two given shapes.

Parameters
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder.MakeBoolean(), geomBuilder.MakeFuse(), and geomBuilder.ManageTransactions().

def MakeFuse (   self,
  theShape1,
  theShape2,
  checkSelfInte = False,
  rmExtraEdges = False,
  theName = None 
)

Perform Fuse boolean operation on two given shapes.

Parameters
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
rmExtraEdgesThe flag that tells if Remove Extra Edges operation should be performed during the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder._autoPublish(), geomBuilder.BoolOp, and geomBuilder.RaiseIfFailed().

def MakeSection (   self,
  theShape1,
  theShape2,
  checkSelfInte = False,
  theName = None 
)

Perform Section boolean operation on two given shapes.

Parameters
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation. If a self-intersection detected the operation fails.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder.MakeBoolean(), geomBuilder.MakeFuseList(), and geomBuilder.ManageTransactions().

def MakeFuseList (   self,
  theShapesList,
  checkSelfInte = False,
  rmExtraEdges = False,
  theName = None 
)

Perform Fuse boolean operation on the list of shapes.

Parameters
theShapesListShapes to be fused.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
rmExtraEdgesThe flag that tells if Remove Extra Edges operation should be performed during the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder._autoPublish(), geomBuilder.BoolOp, geomBuilder.ManageTransactions(), and geomBuilder.RaiseIfFailed().

def MakeCommonList (   self,
  theShapesList,
  checkSelfInte = False,
  theName = None 
)

Perform Common boolean operation on the list of shapes.

Parameters
theShapesListShapes for Common operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder._autoPublish(), geomBuilder.BoolOp, geomBuilder.ManageTransactions(), and geomBuilder.RaiseIfFailed().

def MakeCutList (   self,
  theMainShape,
  theShapesList,
  checkSelfInte = False,
  theName = None 
)

Perform Cut boolean operation on one object and the list of tools.

Parameters
theMainShapeThe object of the operation.
theShapesListThe list of tools of the operation.
checkSelfInteThe flag that tells if the arguments should be checked for self-intersection prior to the operation.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
This algorithm doesn't find all types of self-intersections. It is tuned to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face intersections. Face/face intersections detection is switched off as it is a time-consuming operation that gives an impact on performance. To find all self-intersections please use CheckSelfIntersections() method.
Returns
New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References geomBuilder._autoPublish(), geomBuilder.BoolOp, geomBuilder.MakePartition(), geomBuilder.ManageTransactions(), and geomBuilder.RaiseIfFailed().