GEOM.GEOM_IShapesOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_IShapesOperations:

Public Member Functions
GEOM_Object	MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
GEOM_Object	MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve, in double theLength, in GEOM_Object theStartPoint)
GEOM_Object	MakeEdgeWire (in GEOM_Object theWire, in double theLinearTolerance, in double theAngularTolerance)
GEOM_Object	MakeWire (in ListOfGO theEdgesAndWires, in double theTolerance)
GEOM_Object	MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted)
GEOM_Object	MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted)
GEOM_Object	MakeShell (in ListOfGO theFacesAndShells)
GEOM_Object	MakeSolidShell (in GEOM_Object theShell)
GEOM_Object	MakeSolidShells (in ListOfGO theShells)
GEOM_Object	MakeCompound (in ListOfGO theShapes)
GEOM_Object	MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids)
ListOfGO	GetGlueFaces (in GEOM_Object theShape, in double theTolerance)
GEOM_Object	MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance, in ListOfGO theFaces, in boolean doKeepNonSolids, in boolean doGlueAllEdges)
GEOM_Object	MakeGlueEdges (in GEOM_Object theShape, in double theTolerance)
ListOfGO	GetGlueEdges (in GEOM_Object theShape, in double theTolerance)
GEOM_Object	MakeGlueEdgesByList (in GEOM_Object theShape, in double theTolerance, in ListOfGO theEdges)
ListOfGO	GetExistingSubObjects (in GEOM_Object theShape, in boolean theGroupsOnly)
ListOfGO	MakeExplode (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
ListOfGO	MakeAllSubShapes (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
ListOfGO	ExtractSubShapes (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
ListOfLong	SubShapeAllIDs (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
ListOfLong	GetAllSubShapesIDs (in GEOM_Object theShape, in long theShapeType, in boolean isSorted)
GEOM_Object	GetSubShape (in GEOM_Object theMainShape, in long theID)
ListOfGO	MakeSubShapes (in GEOM_Object theMainShape, in ListOfLong theIndices)
long	GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape)
long	GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape)
string	GetShapeTypeString (in GEOM_Object theShape)
	Get name of type of theShape.
long	NumberOfFaces (in GEOM_Object theShape)
long	NumberOfEdges (in GEOM_Object theShape)
long	NumberOfSubShapes (in GEOM_Object theShape, in long theShapeType)
GEOM_Object	ChangeOrientation (in GEOM_Object theShape)
ListOfLong	GetFreeFacesIDs (in GEOM_Object theShape)
ListOfGO	GetSharedShapes (in GEOM_Object theShape1, in GEOM_Object theShape2, in long theShapeType)
ListOfGO	GetSharedShapesMulti (in ListOfGO theShapes, in long theShapeType)
ListOfGO	GetShapesOnPlane (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in shape_state theState)
ListOfGO	GetShapesOnPlaneWithLocation (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in GEOM_Object thePnt, in shape_state theState)
ListOfGO	GetShapesOnCylinder (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in double theRadius, in shape_state theState)
ListOfGO	GetShapesOnCylinderWithLocation (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in GEOM_Object thePnt, in double theRadius, in shape_state theState)
ListOfGO	GetShapesOnSphere (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theCenter, in double theRadius, in shape_state theState)
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)
ListOfLong	GetShapesOnPlaneIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in shape_state theState)
ListOfLong	GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAx1, in GEOM_Object thePnt, in shape_state theState)
ListOfLong	GetShapesOnCylinderIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in double theRadius, in shape_state theState)
ListOfLong	GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theAxis, in GEOM_Object thePnt, in double theRadius, in shape_state theState)
ListOfLong	GetShapesOnSphereIDs (in GEOM_Object theShape, in long theShapeType, in GEOM_Object theCenter, in double theRadius, in shape_state theState)
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)
ListOfLong	GetShapesOnBoxIDs (in GEOM_Object theBox, in GEOM_Object theShape, in long theShapeType, in shape_state theState)
	Find subshapes complying with given status.
ListOfGO	GetShapesOnBox (in GEOM_Object theBox, in GEOM_Object theShape, in long theShapeType, in shape_state theState)
	Find subshapes complying with given status.
ListOfLong	GetShapesOnShapeIDs (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
	Find subshapes complying with given status.
ListOfGO	GetShapesOnShape (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
	Find subshapes complying with given status.
GEOM_Object	GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape, in GEOM_Object theShape, in short theShapeType, in shape_state theState)
	Find subshapes complying with given status.
GEOM_Object	GetInPlace (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
GEOM_Object	GetInPlaceByHistory (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
GEOM_Object	GetSame (in GEOM_Object theShapeWhere, in GEOM_Object theShapeWhat)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_IShapesOperations: Interface for Shapes creation: Edge from two points, Wire from edges, Face from wire, Shell from faces, Solid from shells, Compound from shapes

---

Member Function Documentation

GEOM_Object GEOM.GEOM_IShapesOperations.MakeEdge	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2
	)

Create a linear edge with specified ends.

Parameters:

thePnt1	Point for the first end of edge.
thePnt2	Point 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:

theRefCurve	The referenced edge.
theLength	Length on the referenced edge. It can be negative for extrapolation on base curve.
theStartPoint	Any 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:

theWire	source Wire.
theLinearTolerance	linear tolerance value
theAngularTolerance	angular tolerance value

Returns:

New GEOM_Object, containing the created edge.

GEOM_Object GEOM.GEOM_IShapesOperations.MakeWire	(	in ListOfGO	theEdgesAndWires,
		in double	theTolerance
	)

Create a wire from the set of edges and wires.

Parameters:

theEdgesAndWires	List of edge and/or wires.
theTolerance	Maximum 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.

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

Create a face on the given wire.

Parameters:

theWire	closed Wire or Edge to build the face on.
isPlanarWanted	If 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:

theWires	List of closed wires or edges to build the face on.
isPlanarWanted	If 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.MakeShell

(

in ListOfGO

theFacesAndShells

)

Create a shell from the set of faces and shells.

Parameters:

theFacesAndShells

List of faces and/or shells.

Returns:

New GEOM_Object, containing the created shell.

GEOM_Object GEOM.GEOM_IShapesOperations.MakeSolidShell

(

in GEOM_Object

theShell

)

Create a solid, bounded by the given shell.

Parameters:

theShell

Bounding shell.

Returns:

New GEOM_Object, containing the created solid.

GEOM_Object GEOM.GEOM_IShapesOperations.MakeSolidShells

(

in ListOfGO

theShells

)

Create a solid, bounded by the given shells.

Parameters:

theShells

Bounding shells.

Returns:

New GEOM_Object, containing the created solid.

GEOM_Object GEOM.GEOM_IShapesOperations.MakeCompound

(

in ListOfGO

theShapes

)

Create a compound of the given shapes.

Parameters:

theShapes

List of shapes to put in compound.

Returns:

New GEOM_Object, containing the created compound.

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:

theShape	Initial shape.
theTolerance	Maximum distance between faces, which can be considered as coincident.
doKeepNonSolids	If FALSE, only solids will present in the result, otherwise all initial shapes.

Returns:

New GEOM_Object, containing a copy of theShape without coincident faces.

ListOfGO GEOM.GEOM_IShapesOperations.GetGlueFaces	(	in GEOM_Object	theShape,
		in double	theTolerance
	)

Find coincident faces in theShape for possible gluing.

Parameters:

theShape	Initial shape.
theTolerance	Maximum distance between faces, which can be considered as coincident.

Returns:

ListOfGO

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:

theShape	Initial shape.
theTolerance	Maximum distance between faces, which can be considered as coincident.
theFaces	List of faces for gluing.
doKeepNonSolids	If FALSE, only solids will present in the result, otherwise all initial shapes.
doGlueAllEdges	If 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.

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

Replace coincident edges in theShape by one edge.

Parameters:

theShape	Initial shape.
theTolerance	Maximum distance between edges, which can be considered as coincident.

Returns:

New GEOM_Object, containing a copy of theShape without coincident edges.

ListOfGO GEOM.GEOM_IShapesOperations.GetGlueEdges	(	in GEOM_Object	theShape,
		in double	theTolerance
	)

Find coincident edges in theShape for possible gluing.

Parameters:

theShape	Initial shape.
theTolerance	Maximum distance between edges, which can be considered as coincident.

Returns:

ListOfGO

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:

theShape	Initial shape.
theTolerance	Maximum distance between edges, which can be considered as coincident.
theFaces	List of edges for gluing.

Returns:

New GEOM_Object, containing a copy of theShape without some edges.

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:

theShape	Any shape.
theGroupsOnly	If this parameter is TRUE, only groups will be returned, else all found sub-shapes and groups.

Returns:

List of existing sub-objects of theShape.

ListOfGO GEOM.GEOM_IShapesOperations.MakeExplode	(	in GEOM_Object	theShape,
		in long	theShapeType,
		in boolean	isSorted
	)

Deprecated method. Use MakeAllSubShapes() instead.

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

Explode a shape on subshapes of a given type. If the shape itself has the given type, it is also returned.

Parameters:

theShape	Shape to be exploded.
theShapeType	Type of sub-shapes to be retrieved.
isSorted	If 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.

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

Extract all subshapes of the given type from the given shape, excluding the shape itself.

Parameters:

theShape	Shape to be exploded.
theShapeType	Type of sub-shapes to be retrieved.
isSorted	If 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.

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

Deprecated method. Use GetAllSubShapesIDs() instead.

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

Explode a shape on subshapes of a given type. Does the same, as MakeAllSubShapes, but returns IDs of sub-shapes, not GEOM_Objects. It works faster.

Parameters:

theShape	Shape to be exploded.
theShapeType	Type of sub-shapes to be retrieved.
isSorted	If 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.

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:

theMainShape	Main shape.
theID	Unique ID of sub shape inside theMainShape.

Returns:

GEOM_Object, corresponding to found sub shape.

Note:

The sub shape GEOM_Objects can has ONLY ONE function. Don't try to apply modification operations (without copy) on them.

ListOfGO GEOM.GEOM_IShapesOperations.MakeSubShapes	(	in GEOM_Object	theMainShape,
		in ListOfLong	theIndices
	)

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

Parameters:

theMainShape	Main shape.
theIndices	List of unique IDs of sub shapes inside theMainShape.

Returns:

List of GEOM_Objects, corresponding to found sub shapes.

Note:

The sub shape GEOM_Objects can has ONLY ONE function. Don't try to apply modification operations (without copy) on them.

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

Get global index of theSubShape in theMainShape.

Parameters:

theMainShape	Main shape.
theSubShape	Sub-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:

theMainShape	Main shape.
theSubShape	Sub-shape of the main shape.

Returns:

index of theSubShape in a list of all sub-shapes of theMainShape of the same type.

string GEOM.GEOM_IShapesOperations.GetShapeTypeString

(

in GEOM_Object

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:

theShape

The shape to get a type of.

Returns:

String, containing a type name of theShape.

long GEOM.GEOM_IShapesOperations.NumberOfFaces

(

in GEOM_Object

theShape

)

Count number of faces in the given shape.

Parameters:

theShape

Shape to count faces in.

Returns:

Number of faces in the given shape.

long GEOM.GEOM_IShapesOperations.NumberOfEdges

(

in GEOM_Object

theShape

)

Count number of edges in the given shape.

Parameters:

theShape

Shape to count edges in.

Returns:

Number of edges in theShape.

long GEOM.GEOM_IShapesOperations.NumberOfSubShapes	(	in GEOM_Object	theShape,
		in long	theShapeType
	)

Count number of subshapes of type theShapeType in the given shape.

Parameters:

theShape	Shape to count subshapes in.
theShapeType	The type of subshapes to count.

Returns:

Number of subshapes of type theShapeType in theShape.

GEOM_Object GEOM.GEOM_IShapesOperations.ChangeOrientation

(

in GEOM_Object

theShape

)

Reverses an orientation the given shape.

Parameters:

theShape

Shape to be reversed.

Returns:

The reversed copy of theShape.

ListOfLong GEOM.GEOM_IShapesOperations.GetFreeFacesIDs

(

in GEOM_Object

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:

theShape

Shape to find free faces in.

Returns:

List of IDs of all free faces, contained in 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:

theShape1	Shape to find sub-shapes in.
theShape2	Shape to find shared sub-shapes with.
theShapeType	Type 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:

theShapes	Shapes to find common sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.

Returns:

List of objects, that are sub-shapes of all given 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAx1	Vector (or line, or linear edge), specifying normal direction and location of the plane to find shapes on.
theState	The state of the subshapes to find.

Returns:

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

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAx1	Vector (or line, or linear edge), specifying normal direction of the plane to find shapes on.
thePnt	Point specifying location of the plane to find shapes on.
theState	The state of the subshapes to find.

Returns:

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

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAxis	Vector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
theRadius	Radius of the cylinder to find shapes on.
theState	The state of the subshapes to find.

Returns:

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

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAxis	Vector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
thePnt	Point specifying location of the bottom of the cylinder.
theRadius	Radius of the cylinder to find shapes on.
theState	The state of the subshapes to find.

Returns:

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

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theCenter	Point, specifying center of the sphere to find shapes on.
theRadius	Radius of the sphere to find shapes on.
theState	The state of the subshapes to find.

Returns:

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

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theTopLeftPoint	Top left quadrangle corner
theTopRigthPoint	Top right quadrangle corner
theBottomLeftPoint	Bottom left quadrangle corner
theBottomRigthPoint	Bottom right quadrangle corner
theState	The state of the subshapes 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAx1	Vector (or line, or linear edge), specifying normal direction and location of the plane to find shapes on.
theState	The state of the subshapes to find.

Returns:

List of IDs 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAx1	Vector (or line, or linear edge), specifying normal direction of the plane to find shapes on.
thePnt	Point specifying location of the plane to find shapes on.
theState	The state of the subshapes to find.

Returns:

List of IDs 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAxis	Vector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
theRadius	Radius of the cylinder to find shapes on.
theState	The state of the subshapes to find.

Returns:

List of IDs 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theAxis	Vector (or line, or linear edge), specifying axis of the cylinder to find shapes on.
thePnt	Point specifying location of the bottom of the cylinder.
theRadius	Radius of the cylinder to find shapes on.
theState	The state of the subshapes to find.

Returns:

List of IDs 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theCenter	Point, specifying center of the sphere to find shapes on.
theRadius	Radius of the sphere to find shapes on.
theState	The state of the subshapes to find.

Returns:

List of IDs 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:

theShape	Shape to find sub-shapes of.
theShapeType	Type of sub-shapes to be retrieved.
theTopLeftPoint	Top left quadrangle corner
theTopRigthPoint	Top right quadrangle corner
theBottomLeftPoint	Bottom left quadrangle corner
theBottomRigthPoint	Bottom right quadrangle corner
theState	The state of the subshapes to find.

Returns:

List of IDs 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
	)

Parameters:

theBox	- the box to check state of subshapes against
theShape	- the shape to explore
theShapeType	- type of subshape of theShape
theState	- required state

Returns:

List of IDs of all found sub-shapes.

ListOfGO GEOM.GEOM_IShapesOperations.GetShapesOnBox	(	in GEOM_Object	theBox,
		in GEOM_Object	theShape,
		in long	theShapeType,
		in shape_state	theState
	)

Parameters:

theBox	- the box to check state of subshapes against
theShape	- the shape to explore
theShapeType	- type of subshape of theShape
theState	- required state

Returns:

List of all found sub-shapes.

ListOfLong GEOM.GEOM_IShapesOperations.GetShapesOnShapeIDs	(	in GEOM_Object	theCheckShape,
		in GEOM_Object	theShape,
		in short	theShapeType,
		in shape_state	theState
	)

Parameters:

theCheckShape	- the shape to check state of subshapes against. It must be a solid.
theShape	- the shape to explore
theShapeType	- type of subshape of theShape
theState	- required state

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
	)

Parameters:

theCheckShape	- the shape to check state of subshapes against. It must be a solid.
theShape	- the shape to explore
theShapeType	- type of subshape 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
	)

Parameters:

theCheckShape	- the shape to check state of subshapes against. It must be a solid.
theShape	- the shape to explore
theShapeType	- type of subshape of theShape
theState	- required state

Returns:

compound includes all found sub-shapes.

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:

theShapeWhere	Shape to find sub-shapes of.
theShapeWhat	Shape, specifying what to find.

Returns:

Group of all found sub-shapes or a single found sub-shape.

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

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:

theShapeWhere	Shape to find sub-shapes of.
theShapeWhat	Shape, specifying what to find.

Returns:

Group of all found sub-shapes or a single found sub-shape.

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:

theShapeWhere	Shape to find sub-shapes of.
theShapeWhat	Shape, specifying what to find.

Returns:

found sub-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