Back to index

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

Interface for Shapes creation: More...

import "GEOM_Gen.idl";

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

List of all members.

Public Member Functions

GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create a linear edge with specified ends.
GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve, in double theLength, in GEOM_Object theStartPoint)
 Create an edge on another edge, corresponding to the given length on the given edge.
GEOM_Object MakeEdgeWire (in GEOM_Object theWire, in double theLinearTolerance, in double theAngularTolerance)
 Create an edge from specified wire.
GEOM_Object MakeWire (in ListOfGO theEdgesAndWires, in double theTolerance)
 Create a wire from the set of edges and wires.
GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted)
 Create a face on the given wire.
GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted)
 Create a face on the given wires set.
GEOM_Object MakeShell (in ListOfGO theFacesAndShells)
 Create a shell from the set of faces and shells.
GEOM_Object MakeSolidShell (in GEOM_Object theShell)
 Create a solid, bounded by the given shell.
GEOM_Object MakeSolidShells (in ListOfGO theShells)
 Create a solid, bounded by the given shells.
GEOM_Object MakeCompound (in ListOfGO theShapes)
 Create a compound of the given shapes.
GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids)
 Replace coincident faces in theShape by one face.
ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance)
 Find coincident faces in theShape for possible gluing.
GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance, in ListOfGO theFaces, in boolean doKeepNonSolids, in boolean doGlueAllEdges)
 Replace coincident faces in theShape by one face in compliance with given list of faces.
GEOM_Object MakeGlueEdges (in GEOM_Object theShape, in double theTolerance)
 Replace coincident edges in theShape by one edge.
ListOfGO GetGlueEdges (in GEOM_Object theShape, in double theTolerance)
 Find coincident edges in theShape for possible gluing.
GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape, in double theTolerance, in ListOfGO theEdges)
 Replace coincident edges in theShape by one edge in compliance with given list of edges.
ListOfGO GetExistingSubObjects (in GEOM_Object theShape, in boolean theGroupsOnly)
 Get all sub-shapes and groups of theShape, that were created already by any other methods.
ListOfGO MakeExplode (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
 Deprecated method.
ListOfGO MakeAllSubShapes (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
 Explode a shape on sub-shapes of a given type.
ListOfGO ExtractSubShapes (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
 Extract all sub-shapes of the given type from the given shape, excluding the shape itself.
ListOfLong SubShapeAllIDs (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
 Deprecated method.
ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
 Explode a shape on sub-shapes of a given type.
GEOM_Object GetSubShape (in GEOM_Object theMainShape, in long theID)
 Get a sub-shape defined by its unique ID inside theMainShape.
ListOfGO MakeSubShapes (in GEOM_Object theMainShape, in ListOfLong theIndices)
 Get a set of sub-shapes defined by their unique IDs inside theMainShape.
long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape)
 Get global index of theSubShape in theMainShape.
long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape)
 Get index of theSubShape in theMainShape, unique among sub-shapes of the same type.
string GetShapeTypeString (in GEOM_Object theShape)
 Get name of type of theShape.
long NumberOfFaces (in GEOM_Object theShape)
 Count number of faces in the given shape.
long NumberOfEdges (in GEOM_Object theShape)
 Count number of edges in the given shape.
long NumberOfSubShapes (in GEOM_Object theShape, in long theShapeType)
 Count number of sub-shapes of type theShapeType in the given shape.
GEOM_Object ChangeOrientation (in GEOM_Object theShape)
 Reverses an orientation the given shape.
ListOfLong GetFreeFacesIDs (in GEOM_Object theShape)
 Retrieve all free faces from the given shape.
ListOfGO GetSharedShapes (in GEOM_Object theShape1, in GEOM_Object theShape2, in long theShapeType)
 Get all sub-shapes of theShape1 of the given type, shared with theShape2.
ListOfGO GetSharedShapesMulti (in ListOfGO theShapes, in long theShapeType)
 Get all sub-shapes, shared by all shapes in the list theShapes.
ListOfGO GetShapesOnPlane (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in GEOM_Object thePnt, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
ListOfGO GetShapesOnCylinder (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in GEOM_Object thePnt, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
ListOfGO GetShapesOnSphere (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theCenter, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.
ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theTopLeftPoint, in GEOM_Object theTopRigthPoint, in GEOM_Object theBottomLeftPoint, in GEOM_Object theBottomRigthPoint, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.
ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in GEOM_Object thePnt, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in GEOM_Object thePnt, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theCenter, in double theRadius, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.
ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theTopLeftPoint, in GEOM_Object theTopRigthPoint, in GEOM_Object theBottomLeftPoint, in GEOM_Object theBottomRigthPoint, in shape_state theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.
ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox, in GEOM_Object theShape, in long theShapeType, in shape_state theState)
 Find sub-shapes complying with given status.
ListOfGO GetShapesOnBox (in GEOM_Object theBox, in GEOM_Object theShape, in long theShapeType, in shape_state theState)
 Find sub-shapes complying with given status.
ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
 Find sub-shapes complying with given status.
ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
 Find sub-shapes complying with given status.
GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
 Find sub-shapes complying with given status.
GEOM_Object GetInPlace (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
 Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
 Old implementation of GetInPlace functionality, based on shape properties.
GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
 Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
GEOM_Object GetSame (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
 Get sub-shape of theShapeWhere, which are coincident with theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
ListOfLong GetSameIDs (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
 Get sub-shape Ids of theShapeWhere, which are coincident with theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
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 Shapes creation:

Edge from two points, Wire from edges, Face from wire, Shell from faces, Solid from shells, Compound from shapes

Definition at line 1473 of file GEOM_Gen.idl.


Member Function Documentation

Aborts the previously opened transaction.

Reverses an orientation the given shape.

Parameters:
theShapeShape to be reversed.
Returns:
The reversed copy of theShape.

Here is the caller graph for this function:

ListOfGO GEOM::GEOM_IShapesOperations::ExtractSubShapes ( in GEOM_Object  theShape,
in long  theShapeType,
in boolean  isSorted 
)

Extract all sub-shapes of the given type from the given shape, excluding the shape itself.

Parameters:
theShapeShape to be exploded.
theShapeTypeType of sub-shapes to be retrieved.
isSortedIf this parameter is TRUE, sub-shapes will be sorted by coordinates of their gravity centers.
Returns:
List of sub-shapes of type theShapeType, contained in theShape.

Closes the previously opened trasaction.

ListOfLong GEOM::GEOM_IShapesOperations::GetAllSubShapesIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in boolean  isSorted 
)

Explode a shape on sub-shapes of a given type.

Does the same, as MakeAllSubShapes, but returns IDs of sub-shapes, not GEOM_Object. It works faster.

Parameters:
theShapeShape to be exploded.
theShapeTypeType of sub-shapes to be retrieved.
isSortedIf this parameter is TRUE, sub-shapes will be sorted by coordinates of their gravity centers.
Returns:
List of IDs of sub-shapes of type theShapeType, contained in theShape.
string GEOM::GEOM_IOperations::GetErrorCode ( ) [inherited]

Get the operation error code.

ListOfGO GEOM::GEOM_IShapesOperations::GetExistingSubObjects ( in GEOM_Object  theShape,
in boolean  theGroupsOnly 
)

Get all sub-shapes and groups of theShape, that were created already by any other methods.

Parameters:
theShapeAny shape.
theGroupsOnlyIf this parameter is TRUE, only groups will be returned, else all found sub-shapes and groups.
Returns:
List of existing sub-objects of theShape.

Retrieve all free faces from the given shape.

Free face is a face, which is not shared between two shells of the shape.

Parameters:
theShapeShape to find free faces in.
Returns:
List of IDs of all free faces, contained in theShape.
ListOfGO GEOM::GEOM_IShapesOperations::GetGlueEdges ( in GEOM_Object  theShape,
in double  theTolerance 
)

Find coincident edges in theShape for possible gluing.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between edges, which can be considered as coincident.
Returns:
ListOfGO
ListOfGO GEOM::GEOM_IShapesOperations::GetGlueFaces ( in GEOM_Object  theShape,
in double  theTolerance 
)

Find coincident faces in theShape for possible gluing.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between faces, which can be considered as coincident.
Returns:
ListOfGO
GEOM_Object GEOM::GEOM_IShapesOperations::GetInPlace ( in GEOM_Object  theShapeWhere,
in GEOM_Object  theShapeWhat 
)

Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.

Parameters:
theShapeWhereShape to find sub-shapes of.
theShapeWhatShape, specifying what to find.
Returns:
Group of all found sub-shapes or a single found sub-shape.

Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.

Implementation of this method is based on a saved history of an operation, produced theShapeWhere. The theShapeWhat must be among this operation's arguments (an argument shape or a sub-shape of an argument shape). The operation could be the Partition or one of boolean operations, performed on simple shapes (not on compounds).

Parameters:
theShapeWhereShape to find sub-shapes of.
theShapeWhatShape, specifying what to find.
Returns:
Group of all found sub-shapes or a single found sub-shape.

Old implementation of GetInPlace functionality, based on shape properties.

GEOM_Object GEOM::GEOM_IShapesOperations::GetSame ( in GEOM_Object  theShapeWhere,
in GEOM_Object  theShapeWhat 
)

Get sub-shape of theShapeWhere, which are coincident with theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.

Parameters:
theShapeWhereShape to find sub-shapes of.
theShapeWhatShape, specifying what to find.
Returns:
found sub-shape.
ListOfLong GEOM::GEOM_IShapesOperations::GetSameIDs ( in GEOM_Object  theShapeWhere,
in GEOM_Object  theShapeWhat 
)

Get sub-shape Ids of theShapeWhere, which are coincident with theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.

Parameters:
theShapeWhereShape to find sub-shapes of.
theShapeWhatShape, specifying what to find.
Returns:
found sub-shape Ids.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnBox ( in GEOM_Object  theBox,
in GEOM_Object  theShape,
in long  theShapeType,
in shape_state  theState 
)

Find sub-shapes complying with given status.

Parameters:
theBox- the box to check state of sub-shapes against
theShape- the shape to explore
theShapeType- type of sub-shape of theShape
theState- required state
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnBoxIDs ( in GEOM_Object  theBox,
in GEOM_Object  theShape,
in long  theShapeType,
in shape_state  theState 
)

Find sub-shapes complying with given status.

Parameters:
theBox- the box to check state of sub-shapes against
theShape- the shape to explore
theShapeType- type of sub-shape of theShape
theState- required state
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnCylinder ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAxis,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAxisVector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
theRadiusRadius of the cylinder to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnCylinderIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAxis,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAxisVector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
theRadiusRadius of the cylinder to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnCylinderWithLocation ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAxis,
in GEOM_Object  thePnt,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAxisVector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
thePntPoint specifying location of the bottom of the cylinder.
theRadiusRadius of the cylinder to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnCylinderWithLocationIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAxis,
in GEOM_Object  thePnt,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAxisVector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
thePntPoint specifying location of the bottom of the cylinder.
theRadiusRadius of the cylinder to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of IDs all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnPlane ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAx1,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAx1Vector (or line, or linear edge), specifying normal direction and location of the plane to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnPlaneIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAx1,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAx1Vector (or line, or linear edge), specifying normal direction and location of the plane to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnPlaneWithLocation ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAx1,
in GEOM_Object  thePnt,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAx1Vector (or line, or linear edge), specifying normal direction of the plane to find shapes on.
thePntPoint specifying location of the plane to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnPlaneWithLocationIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theAx1,
in GEOM_Object  thePnt,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theAx1Vector (or line, or linear edge), specifying normal direction of the plane to find shapes on.
thePntPoint specifying location of the plane to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnQuadrangle ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theTopLeftPoint,
in GEOM_Object  theTopRigthPoint,
in GEOM_Object  theBottomLeftPoint,
in GEOM_Object  theBottomRigthPoint,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theTopLeftPointTop left quadrangle corner
theTopRigthPointTop right quadrangle corner
theBottomLeftPointBottom left quadrangle corner
theBottomRigthPointBottom right quadrangle corner
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnQuadrangleIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theTopLeftPoint,
in GEOM_Object  theTopRigthPoint,
in GEOM_Object  theBottomLeftPoint,
in GEOM_Object  theBottomRigthPoint,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theTopLeftPointTop left quadrangle corner
theTopRigthPointTop right quadrangle corner
theBottomLeftPointBottom left quadrangle corner
theBottomRigthPointBottom right quadrangle corner
theStateThe state of the sub-shapes to find.
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnShape ( in GEOM_Object  theCheckShape,
in GEOM_Object  theShape,
in short  theShapeType,
in shape_state  theState 
)

Find sub-shapes complying with given status.

Parameters:
theCheckShape- the shape to check state of sub-shapes against. It must be a solid.
theShape- the shape to explore
theShapeType- type of sub-shape of theShape
theState- required state
Returns:
List of all found sub-shapes.
GEOM_Object GEOM::GEOM_IShapesOperations::GetShapesOnShapeAsCompound ( in GEOM_Object  theCheckShape,
in GEOM_Object  theShape,
in short  theShapeType,
in shape_state  theState 
)

Find sub-shapes complying with given status.

Parameters:
theCheckShape- the shape to check state of sub-shapes against. It must be a solid.
theShape- the shape to explore
theShapeType- type of sub-shape of theShape
theState- required state
Returns:
compound includes all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnShapeIDs ( in GEOM_Object  theCheckShape,
in GEOM_Object  theShape,
in short  theShapeType,
in shape_state  theState 
)

Find sub-shapes complying with given status.

Parameters:
theCheckShape- the shape to check state of sub-shapes against. It must be a solid.
theShape- the shape to explore
theShapeType- type of sub-shape of theShape
theState- required state
Returns:
List of IDs of all found sub-shapes.
ListOfGO GEOM::GEOM_IShapesOperations::GetShapesOnSphere ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theCenter,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theCenterPoint, specifying center of the sphere to find shapes on.
theRadiusRadius of the sphere to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of all found sub-shapes.
ListOfLong GEOM::GEOM_IShapesOperations::GetShapesOnSphereIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in GEOM_Object  theCenter,
in double  theRadius,
in shape_state  theState 
)

Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.

Parameters:
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
theCenterPoint, specifying center of the sphere to find shapes on.
theRadiusRadius of the sphere to find shapes on.
theStateThe state of the sub-shapes to find.
Returns:
List of IDs of all found sub-shapes.

Get name of type of theShape.

Use wide type notation, taking into consideration both topology and geometry of the shape. Together with method GetTopologyIndex() it can be used to generate automatic names for sub-shapes, when publishing them in a study.

Parameters:
theShapeThe shape to get a type of.
Returns:
String, containing a type name of theShape.
ListOfGO GEOM::GEOM_IShapesOperations::GetSharedShapes ( in GEOM_Object  theShape1,
in GEOM_Object  theShape2,
in long  theShapeType 
)

Get all sub-shapes of theShape1 of the given type, shared with theShape2.

Parameters:
theShape1Shape to find sub-shapes in.
theShape2Shape to find shared sub-shapes with.
theShapeTypeType of sub-shapes to be retrieved.
Returns:
List of sub-shapes of theShape1, shared with theShape2.
ListOfGO GEOM::GEOM_IShapesOperations::GetSharedShapesMulti ( in ListOfGO  theShapes,
in long  theShapeType 
)

Get all sub-shapes, shared by all shapes in the list theShapes.

Parameters:
theShapesShapes to find common sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved.
Returns:
List of objects, that are sub-shapes of all given shapes.
long GEOM::GEOM_IOperations::GetStudyID ( ) [inherited]

Get ID of study, where the operation is defined.

GEOM_Object GEOM::GEOM_IShapesOperations::GetSubShape ( in GEOM_Object  theMainShape,
in long  theID 
)

Get a sub-shape defined by its unique ID inside theMainShape.

Parameters:
theMainShapeMain shape.
theIDUnique ID of sub-shape inside theMainShape.
Returns:
GEOM_Object, corresponding to found sub-shape.
Note:
The sub-shape GEOM_Object can has ONLY ONE function. Don't try to apply modification operations (without copy) on them.

Here is the caller graph for this function:

long GEOM::GEOM_IShapesOperations::GetSubShapeIndex ( in GEOM_Object  theMainShape,
in GEOM_Object  theSubShape 
)

Get global index of theSubShape in theMainShape.

Parameters:
theMainShapeMain shape.
theSubShapeSub-shape of the main shape.
Returns:
global index of theSubShape in theMainShape.
long GEOM::GEOM_IShapesOperations::GetTopologyIndex ( in GEOM_Object  theMainShape,
in GEOM_Object  theSubShape 
)

Get index of theSubShape in theMainShape, unique among sub-shapes of the same type.

Together with method GetShapeTypeString() it can be used to generate automatic names for sub-shapes, when publishing them in a study.

Parameters:
theMainShapeMain shape.
theSubShapeSub-shape of the main shape.
Returns:
index of theSubShape in a list of all sub-shapes of theMainShape of the same type.
boolean GEOM::GEOM_IOperations::IsDone ( ) [inherited]

To know, if the operation was successfully performed.

ListOfGO GEOM::GEOM_IShapesOperations::MakeAllSubShapes ( in GEOM_Object  theShape,
in long  theShapeType,
in boolean  isSorted 
)

Explode a shape on sub-shapes of a given type.

If the shape itself has the given type, it is also returned.

Parameters:
theShapeShape to be exploded.
theShapeTypeType of sub-shapes to be retrieved.
isSortedIf this parameter is TRUE, sub-shapes will be sorted by coordinates of their gravity centers.
Returns:
List of sub-shapes of type theShapeType, contained in theShape.

Create a compound of the given shapes.

Parameters:
theShapesList of shapes to put in compound.
Returns:
New GEOM_Object, containing the created compound.

Here is the caller graph for this function:

Create a linear edge with specified ends.

Parameters:
thePnt1Point for the first end of edge.
thePnt2Point for the second end of edge.
Returns:
New GEOM_Object, containing the created edge.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeEdgeOnCurveByLength ( in GEOM_Object  theRefCurve,
in double  theLength,
in GEOM_Object  theStartPoint 
)

Create an edge on another edge, corresponding to the given length on the given edge.

Parameters:
theRefCurveThe referenced edge.
theLengthLength on the referenced edge. It can be negative for extrapolation on base curve.
theStartPointAny vertex close to one of edge's ends to select start point among them. If NULL, fist vertex is used.
Returns:
New GEOM_Object, containing the created edge.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeEdgeWire ( in GEOM_Object  theWire,
in double  theLinearTolerance,
in double  theAngularTolerance 
)

Create an edge from specified wire.

Parameters:
theWiresource Wire.
theLinearTolerancelinear tolerance value
theAngularToleranceangular tolerance value
Returns:
New GEOM_Object, containing the created edge.
ListOfGO GEOM::GEOM_IShapesOperations::MakeExplode ( in GEOM_Object  theShape,
in long  theShapeType,
in boolean  isSorted 
)

Deprecated method.

Use MakeAllSubShapes() instead.

GEOM_Object GEOM::GEOM_IShapesOperations::MakeFace ( in GEOM_Object  theWire,
in boolean  isPlanarWanted 
)

Create a face on the given wire.

Parameters:
theWireclosed Wire or Edge to build the face on.
isPlanarWantedIf TRUE, only planar face will be built. If impossible, NULL object will be returned.
Returns:
New GEOM_Object, containing the created face.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeFaceWires ( in ListOfGO  theWires,
in boolean  isPlanarWanted 
)

Create a face on the given wires set.

Parameters:
theWiresList of closed wires or edges to build the face on.
isPlanarWantedIf TRUE, only planar face will be built. If impossible, NULL object will be returned.
Returns:
New GEOM_Object, containing the created face.

Here is the caller graph for this function:

GEOM_Object GEOM::GEOM_IShapesOperations::MakeGlueEdges ( in GEOM_Object  theShape,
in double  theTolerance 
)

Replace coincident edges in theShape by one edge.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between edges, which can be considered as coincident.
Returns:
New GEOM_Object, containing a copy of theShape without coincident edges.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeGlueEdgesByList ( in GEOM_Object  theShape,
in double  theTolerance,
in ListOfGO  theEdges 
)

Replace coincident edges in theShape by one edge in compliance with given list of edges.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between edges, which can be considered as coincident.
theEdgesList of edges for gluing.
Returns:
New GEOM_Object, containing a copy of theShape without some edges.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeGlueFaces ( in GEOM_Object  theShape,
in double  theTolerance,
in boolean  doKeepNonSolids 
)

Replace coincident faces in theShape by one face.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between faces, which can be considered as coincident.
doKeepNonSolidsIf FALSE, only solids will present in the result, otherwise all initial shapes.
Returns:
New GEOM_Object, containing a copy of theShape without coincident faces.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeGlueFacesByList ( in GEOM_Object  theShape,
in double  theTolerance,
in ListOfGO  theFaces,
in boolean  doKeepNonSolids,
in boolean  doGlueAllEdges 
)

Replace coincident faces in theShape by one face in compliance with given list of faces.

Parameters:
theShapeInitial shape.
theToleranceMaximum distance between faces, which can be considered as coincident.
theFacesList of faces for gluing.
doKeepNonSolidsIf FALSE, only solids will present in the result, otherwise all initial shapes.
doGlueAllEdgesIf TRUE, all coincident edges of theShape will be glued, otherwise only the edges, belonging to theFaces.
Returns:
New GEOM_Object, containing a copy of theShape without some faces.

Create a shell from the set of faces and shells.

Parameters:
theFacesAndShellsList of faces and/or shells.
Returns:
New GEOM_Object, containing the created shell.

Create a solid, bounded by the given shell.

Parameters:
theShellBounding shell.
Returns:
New GEOM_Object, containing the created solid.

Create a solid, bounded by the given shells.

Parameters:
theShellsBounding shells.
Returns:
New GEOM_Object, containing the created solid.

Get a set of sub-shapes defined by their unique IDs inside theMainShape.

Parameters:
theMainShapeMain shape.
theIndicesList of unique IDs of sub-shapes inside theMainShape.
Returns:
List of GEOM_Object, corresponding to found sub-shapes.
Note:
The sub-shape GEOM_Object can has ONLY ONE function. Don't try to apply modification operations (without copy) on them.
GEOM_Object GEOM::GEOM_IShapesOperations::MakeWire ( in ListOfGO  theEdgesAndWires,
in double  theTolerance 
)

Create a wire from the set of edges and wires.

Parameters:
theEdgesAndWiresList of edge and/or wires.
theToleranceMaximum distance between vertices, that will be merged. Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
Returns:
New GEOM_Object, containing the created wire.

Count number of edges in the given shape.

Parameters:
theShapeShape to count edges in.
Returns:
Number of edges in theShape.

Count number of faces in the given shape.

Parameters:
theShapeShape to count faces in.
Returns:
Number of faces in the given shape.
long GEOM::GEOM_IShapesOperations::NumberOfSubShapes ( in GEOM_Object  theShape,
in long  theShapeType 
)

Count number of sub-shapes of type theShapeType in the given shape.

Parameters:
theShapeShape to count sub-shapes in.
theShapeTypeThe type of sub-shapes to count.
Returns:
Number of sub-shapes of type theShapeType in theShape.
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.

ListOfLong GEOM::GEOM_IShapesOperations::SubShapeAllIDs ( in GEOM_Object  theShape,
in long  theShapeType,
in boolean  isSorted 
)

Deprecated method.

Use GetAllSubShapesIDs() instead.

Here is the caller graph for this function:


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