Boolean Operations

Functions
def	MakeBoolean (self, theShape1, theShape2, theOperation, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform one of boolean operations on two given shapes. More...
def	MakeCommon (self, theShape1, theShape2, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform Common boolean operation on two given shapes. More...
def	MakeCut (self, theShape1, theShape2, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform Cut boolean operation on two given shapes. More...
def	MakeFuse (self, theShape1, theShape2, checkSelfInte=False, rmExtraEdges=False, theName=None, theFuzzyParam=-1)
	Perform Fuse boolean operation on two given shapes. More...
def	MakeSection (self, theShape1, theShape2, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform Section boolean operation on two given shapes. More...
def	MakeFuseList (self, theShapesList, checkSelfInte=False, rmExtraEdges=False, theName=None, theFuzzyParam=-1)
	Perform Fuse boolean operation on the list of shapes. More...
def	MakeCommonList (self, theShapesList, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform Common boolean operation on the list of shapes. More...
def	MakeCutList (self, theMainShape, theShapesList, checkSelfInte=False, theName=None, theFuzzyParam=-1)
	Perform Cut boolean operation on one object and the list of tools. More...

Detailed Description

Function Documentation

MakeBoolean()

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

Perform one of boolean operations on two given shapes.

Parameters

theShape1	First argument for boolean operation.
theShape2	Second argument for boolean operation.
theOperation	Indicates the operation to be done: 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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().

MakeCommon()

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

Perform Common boolean operation on two given shapes.

Parameters

theShape1	First argument for boolean operation.
theShape2	Second argument for boolean operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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 GEOM_IBooleanOperations.MakeBoolean(), and geomBuilder.MakeBoolean().

MakeCut()

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

Perform Cut boolean operation on two given shapes.

Parameters

theShape1	First argument for boolean operation.
theShape2	Second argument for boolean operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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 GEOM_IBooleanOperations.MakeBoolean(), and geomBuilder.MakeBoolean().

MakeFuse()

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

Perform Fuse boolean operation on two given shapes.

Parameters

theShape1	First argument for boolean operation.
theShape2	Second argument for boolean operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
rmExtraEdges	The flag that tells if Remove Extra Edges operation should be performed during the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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().

MakeSection()

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

Perform Section boolean operation on two given shapes.

Parameters

theShape1	First argument for boolean operation.
theShape2	Second argument for boolean operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation. If a self-intersection detected the operation fails.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

Returns

New GEOM.GEOM_Object, containing the result shape.

Example 1
Example 2

References GEOM_IBooleanOperations.MakeBoolean(), and geomBuilder.MakeBoolean().

MakeFuseList()

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

Perform Fuse boolean operation on the list of shapes.

Parameters

theShapesList	Shapes to be fused.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
rmExtraEdges	The flag that tells if Remove Extra Edges operation should be performed during the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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().

MakeCommonList()

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

Perform Common boolean operation on the list of shapes.

Parameters

theShapesList	Shapes for Common operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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().

MakeCutList()

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

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

Parameters

theMainShape	The object of the operation.
theShapesList	The list of tools of the operation.
checkSelfInte	The flag that tells if the arguments should be checked for self-intersection prior to the operation.
theName	Object 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.
theFuzzyParam	The fuzzy parameter to be used for the boolean operation. If the value is not positive, no fuzzy tolerance will be considered for the boolean operation.

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().