Back to index

salome-geom  6.5.0
Public Member Functions
GEOM::GEOM_IBooleanOperations Interface Reference

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

import "GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_IBooleanOperations:
Inheritance graph
[legend]
Collaboration diagram for GEOM::GEOM_IBooleanOperations:
Collaboration graph
[legend]

List of all members.

Public Member Functions

GEOM_Object MakeBoolean (in GEOM_Object theShape1, in GEOM_Object theShape2, in long theOperation)
 Perform one of boolean operations on two given shapes.
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.
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)
 Perform partition operation.
GEOM_Object MakeHalfPartition (in GEOM_Object theShape, in GEOM_Object thePlane)
 Perform partition of the Shape with the Plane.
boolean IsDone ()
 To know, if the operation was successfully performed.
void SetErrorCode (in string theErrorID)
 Set the operation error code.
string GetErrorCode ()
 Get the operation error code.
long GetStudyID ()
 Get ID of study, where the operation is defined.
void StartOperation ()
 Opens a new transaction.
void FinishOperation ()
 Closes the previously opened trasaction.
void AbortOperation ()
 Aborts the previously opened transaction.

Detailed Description

Interface for boolean operations (Cut, Fuse, Common)

Definition at line 2512 of file GEOM_Gen.idl.


Member Function Documentation

Aborts the previously opened transaction.

Closes the previously opened trasaction.

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.

boolean GEOM::GEOM_IOperations::IsDone ( ) [inherited]

To know, if the operation was successfully performed.

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:
theShape1First argument for boolean operation.
theShape2Second argument for boolean operation.
theOperationIndicates the operation to be done: 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
Returns:
New GEOM_Object, containing the result shape.

Here is the caller graph for this function:

Perform partition of the Shape with the Plane.

Parameters:
theShapeShape to be intersected.
thePlaneTool shape, to intersect theShape.
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:
theShapesShapes to be intersected.
theToolsShapes 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:
theLimitType 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:
theKeepInsideShapes, outside which the results will be deleted. Each shape from theKeepInside must belong to theShapes also.
theRemoveInsideShapes, inside which the results will be deleted. Each shape from theRemoveInside must belong to theShapes also.
theRemoveWebsIf TRUE, perform Glue 3D algorithm.
theMaterialsMaterial indices for each shape. Make sence, only if theRemoveWebs is TRUE.
Returns:
New GEOM_Object, containing the result shapes.

Here is the caller graph for this function:

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.
void GEOM::GEOM_IOperations::SetErrorCode ( in string  theErrorID) [inherited]

Set the operation error code.

Parameters:
theErrorIDis a string describing the error occured
Note:
This method is supposed to be used only by interfaces inheriting from IOperations.

Opens a new transaction.


The documentation for this interface was generated from the following file: