GEOM_IBooleanOperations Interface Reference

Interface for boolean operations (Cut, Fuse, Common) More...

import "GEOM_Gen.idl";

Public Member Functions
GEOM_Object	MakeBoolean (in GEOM_Object theShape1, in GEOM_Object theShape2, in long theOperation, in boolean IsCheckSelfInte)
	Perform one of boolean operations on two given shapes. More...
GEOM_Object	MakeFuse (in GEOM_Object theShape1, in GEOM_Object theShape2, in boolean IsCheckSelfInte, in boolean IsRmExtraEdges)
	Perform fusion boolean operation on two given shapes. More...
GEOM_Object	MakeFuseList (in ListOfGO theShapes, in boolean IsCheckSelfInte, in boolean IsRmExtraEdges)
	Perform fusion boolean operation on list of objects. More...
GEOM_Object	MakeCommonList (in ListOfGO theShapes, in boolean IsCheckSelfInte)
	Perform common boolean operation on list of objects. More...
GEOM_Object	MakeCutList (in GEOM_Object theMainShape, in ListOfGO theShapes, in boolean IsCheckSelfInte)
	Perform cutting of list of objects from theMainShape. More...
GEOM_Object	MakePartition (in ListOfGO theShapes, in ListOfGO theTools, in ListOfGO theKeepInside, in ListOfGO theRemoveInside, in short theLimit, in boolean theRemoveWebs, in ListOfLong theMaterials, in short theKeepNonlimitShapes)
	Perform partition operation. More...
GEOM_Object	MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes, in ListOfGO theTools, in ListOfGO theKeepInside, in ListOfGO theRemoveInside, in short theLimit, in boolean theRemoveWebs, in ListOfLong theMaterials, in short theKeepNonlimitShapes, in boolean IsCheckSelfInte)
	Perform partition operation. More...
GEOM_Object	MakeHalfPartition (in GEOM_Object theShape, in GEOM_Object thePlane)
	Perform partition of the Shape with the Plane. More...
boolean	IsDone ()
	To know, if the operation was successfully performed. More...
void	SetErrorCode (in string theErrorID)
	Set the operation error code. More...
string	GetErrorCode ()
	Get the operation error code. More...
long	GetStudyID ()
	Get ID of study, where the operation is defined. More...
void	StartOperation ()
	Opens a new transaction. More...
void	FinishOperation ()
	Closes the previously opened trasaction. More...
void	AbortOperation ()
	Aborts the previously opened transaction. More...

Detailed Description

Interface for boolean operations (Cut, Fuse, Common)

Member Function Documentation

GEOM_Object MakeBoolean	(	in GEOM_Object	theShape1,
		in GEOM_Object	theShape2,
		in long	theOperation,
		in boolean	IsCheckSelfInte
	)

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.
IsCheckSelfInte	If TRUE, perform check self intersection of arguments before an operation.

Returns

New GEOM_Object, containing the result shape.

GEOM_Object MakeFuse	(	in GEOM_Object	theShape1,
		in GEOM_Object	theShape2,
		in boolean	IsCheckSelfInte,
		in boolean	IsRmExtraEdges
	)

Perform fusion boolean operation on two given shapes.

Parameters

theShape1	First argument for fuse operation.
theShape2	Second argument for fuse operation.
IsCheckSelfInte	If TRUE, perform check self intersection of arguments before an operation.
IsRmExtraEdges	If TRUE, perform removal of extra edges during an operation.

Returns

New GEOM_Object, containing the result shape.

GEOM_Object MakeFuseList	(	in ListOfGO	theShapes,
		in boolean	IsCheckSelfInte,
		in boolean	IsRmExtraEdges
	)

Perform fusion boolean operation on list of objects.

Parameters

theShapes	Shapes to be fused.
IsCheckSelfInte	If TRUE, perform check self intersection of arguments before an operation.
IsRmExtraEdges	If TRUE, perform removal of extra edges during an operation.

Returns

New GEOM_Object, containing the result shape.

GEOM_Object MakeCommonList	(	in ListOfGO	theShapes,
		in boolean	IsCheckSelfInte
	)

Perform common boolean operation on list of objects.

Parameters

theShapes	Shapes for common operation.
IsCheckSelfInte	If TRUE, perform check self intersection of arguments before an operation.

Returns

New GEOM_Object, containing the result shape.

GEOM_Object MakeCutList	(	in GEOM_Object	theMainShape,
		in ListOfGO	theShapes,
		in boolean	IsCheckSelfInte
	)

Perform cutting of list of objects from theMainShape.

Parameters

theMainShape	the object for cut operation.
theShapes	Shapes to be cut from theMainShape (tools).
IsCheckSelfInte	If TRUE, perform check self intersection of arguments before an operation.

Returns

New GEOM_Object, containing the result shape.

GEOM_Object MakePartition	(	in ListOfGO	theShapes,
		in ListOfGO	theTools,
		in ListOfGO	theKeepInside,
		in ListOfGO	theRemoveInside,
		in short	theLimit,
		in boolean	theRemoveWebs,
		in ListOfLong	theMaterials,
		in short	theKeepNonlimitShapes
	)

Perform partition operation.

Parameters

theShapes	Shapes to be intersected.
theTools	Shapes to intersect theShapes.

Note

Each compound from ListShapes and ListTools will be exploded in order to avoid possible intersection between shapes from this compound.

Parameters

theLimit	Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
theKeepNonlimitShapes,:	if this parameter == 0, then only shapes of target type (equal to Limit) are kept in the result, else standalone shapes of lower dimension are kept also (if they exist).

After implementation new version of PartitionAlgo (October 2006) other parameters are ignored by current functionality. They are kept in this function only for supporting old versions. Ignored parameters:

Parameters

theKeepInside	Shapes, outside which the results will be deleted. Each shape from theKeepInside must belong to theShapes also.
theRemoveInside	Shapes, inside which the results will be deleted. Each shape from theRemoveInside must belong to theShapes also.
theRemoveWebs	If TRUE, perform Glue 3D algorithm.
theMaterials	Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.

Returns

New GEOM_Object, containing the result shapes.

GEOM_Object MakePartitionNonSelfIntersectedShape	(	in ListOfGO	theShapes,
		in ListOfGO	theTools,
		in ListOfGO	theKeepInside,
		in ListOfGO	theRemoveInside,
		in short	theLimit,
		in boolean	theRemoveWebs,
		in ListOfLong	theMaterials,
		in short	theKeepNonlimitShapes,
		in boolean	IsCheckSelfInte
	)

Perform partition operation.

This method may be usefull if it is needed to make a partition for a compound containing nonintersected shapes. Performance will be better since intersection between shapes from compound is not performed.

Description of all parameters as in previous method MakePartition(). One additional parameter is provided:

Parameters

IsCheckSelfInte

If TRUE, perform check self intersection of arguments before an operation.

Note

Passed compounds (via ListShapes or via ListTools) have to consist of nonintersecting shapes.

Returns

New GEOM_Object, containing the result shapes.

GEOM_Object MakeHalfPartition	(	in GEOM_Object	theShape,
		in GEOM_Object	thePlane
	)

Perform partition of the Shape with the Plane.

Parameters

theShape	Shape to be intersected.
thePlane	Tool shape, to intersect theShape.

Returns

New 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:

• theLimit: GEOM::SHAPE (shape limit corresponds to the type of theShape)
• theKeepNonlimitShapes: 0
• theKeepInside, theRemoveInside, theRemoveWebs, theMaterials (obsolete parameters): empty

See Also

MakePartition, MakePartitionNonSelfIntersectedShape

boolean IsDone ( )

inherited

To know, if the operation was successfully performed.

void SetErrorCode ( in string  theErrorID )

inherited

Set the operation error code.

Parameters

theErrorID

is a string describing the error occured

Note

This method is supposed to be used only by interfaces inheriting from IOperations.

string GetErrorCode ( )

inherited

Get the operation error code.

long GetStudyID ( )

inherited

Get ID of study, where the operation is defined.

void StartOperation ( )

inherited

Opens a new transaction.

void FinishOperation ( )

inherited

Closes the previously opened trasaction.

void AbortOperation ( )

inherited

Aborts the previously opened transaction.