GEOM.GEOM_IBooleanOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_IBooleanOperations:

Public Member Functions
GEOM_Object	MakeBoolean (in GEOM_Object theShape1, in GEOM_Object theShape2, in long theOperation)
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)
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)
GEOM_Object	MakeHalfPartition (in GEOM_Object theShape, in GEOM_Object thePlane)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)

---

Member Function Documentation

GEOM_Object GEOM.GEOM_IBooleanOperations.MakeBoolean	(	in GEOM_Object	theShape1,
		in GEOM_Object	theShape2,
		in long	theOperation
	)

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.

Returns:

New GEOM_Object, containing the result shape.

GEOM_Object GEOM.GEOM_IBooleanOperations.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).
KeepNonlimitShapes,:	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 GEOM.GEOM_IBooleanOperations.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
	)

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

Note:

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

Returns:

New GEOM_Object, containing the result shapes.

GEOM_Object GEOM.GEOM_IBooleanOperations.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.

boolean GEOM.GEOM_IOperations.IsDone

(

)

[inherited]

To know, if the operation was successfully performed

void GEOM.GEOM_IOperations.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 GEOM.GEOM_IOperations.GetErrorCode

(

)

[inherited]

Get the operation error code

long GEOM.GEOM_IOperations.GetStudyID

(

)

[inherited]

Get ID of study, where the operation is defined

void GEOM.GEOM_IOperations.StartOperation

(

)

[inherited]

Opens a new transaction

void GEOM.GEOM_IOperations.FinishOperation

(

)

[inherited]

Closes the previously opened trasaction

void GEOM.GEOM_IOperations.AbortOperation

(

)

[inherited]

Aborts the previously opened transaction