Version: 9.16.0
Home
Loading...
Searching...
No Matches

Functions

 GetFreeFacesIDs (self, theShape)
 Retrieve all free faces from the given shape.
 
 GetSharedShapes (self, theShape1, theShape2, theShapeType, theName=None)
 Get all sub-shapes of theShape1 of the given type, shared with theShape2.
 
 GetSharedShapesMulti (self, theShapes, theShapeType, theMultiShare=True, theName=None)
 Get sub-shapes, shared by input shapes.
 
 GetShapesOnPlane (self, theShape, theShapeType, theAx1, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
 
 GetShapesOnPlaneIDs (self, theShape, theShapeType, theAx1, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
 
 GetShapesOnPlaneWithLocation (self, theShape, theShapeType, theAx1, thePnt, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
 
 GetShapesOnPlaneWithLocationIDs (self, theShape, theShapeType, theAx1, thePnt, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified plane by the certain way, defined through theState parameter.
 
 GetShapesOnCylinder (self, theShape, theShapeType, theAxis, theRadius, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
 
 GetShapesOnCylinderIDs (self, theShape, theShapeType, theAxis, theRadius, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
 
 GetShapesOnCylinderWithLocation (self, theShape, theShapeType, theAxis, thePnt, theRadius, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
 
 GetShapesOnCylinderWithLocationIDs (self, theShape, theShapeType, theAxis, thePnt, theRadius, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified cylinder by the certain way, defined through theState parameter.
 
 GetShapesOnSphere (self, theShape, theShapeType, theCenter, theRadius, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.
 
 GetShapesOnSphereIDs (self, theShape, theShapeType, theCenter, theRadius, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified sphere by the certain way, defined through theState parameter.
 
 GetShapesOnQuadrangle (self, theShape, theShapeType, theTopLeftPoint, theTopRightPoint, theBottomLeftPoint, theBottomRightPoint, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.
 
 GetShapesOnQuadrangleIDs (self, theShape, theShapeType, theTopLeftPoint, theTopRightPoint, theBottomLeftPoint, theBottomRightPoint, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified quadrangle by the certain way, defined through theState parameter.
 
 GetShapesOnBox (self, theBox, theShape, theShapeType, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified theBox by the certain way, defined through theState parameter.
 
 GetShapesOnBoxIDs (self, theBox, theShape, theShapeType, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified theBox by the certain way, defined through theState parameter.
 
 GetShapesOnShape (self, theCheckShape, theShape, theShapeType, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified theCheckShape by the certain way, defined through theState parameter.
 
 GetShapesOnShapeAsCompound (self, theCheckShape, theShape, theShapeType, theState, theName=None)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified theCheckShape by the certain way, defined through theState parameter.
 
 GetShapesOnShapeIDs (self, theCheckShape, theShape, theShapeType, theState)
 Find in theShape all sub-shapes of type theShapeType, situated relatively the specified theCheckShape by the certain way, defined through theState parameter.
 
 GetInPlace (self, theShapeWhere, theShapeWhat, isNewImplementation=False, theName=None)
 Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
 
 GetInPlaceByHistory (self, theShapeWhere, theShapeWhat, theName=None)
 Get sub-shape(s) of theShapeWhere, which are coincident with theShapeWhat or could be a part of it.
 
 GetInPlaceMap (self, theShapeWhere, theShapeWhat)
 A sort of GetInPlace functionality, returning IDs of sub-shapes.
 
 GetSame (self, theShapeWhere, theShapeWhat, theName=None)
 Get sub-shape of theShapeWhere, which is equal to theShapeWhat.
 
 GetSameIDs (self, theShapeWhere, theShapeWhat)
 Get sub-shape indices of theShapeWhere, which is equal to theShapeWhat.
 
 ExtendEdge (self, theEdge, theMin, theMax, theName=None)
 Resize the input edge with the new Min and Max parameters.
 
 ExtendFace (self, theFace, theUMin, theUMax, theVMin, theVMax, theName=None)
 Resize the input face with the new UMin, UMax, VMin and VMax parameters.
 
 MakeSurfaceFromFace (self, theFace, theName=None)
 This function takes some face as input parameter and creates new GEOM_Object, i.e.
 

Detailed Description

Function Documentation

◆ GetFreeFacesIDs()

GetFreeFacesIDs (   self,
  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.

Example

References geomBuilder.GetFreeFacesIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetSharedShapes()

GetSharedShapes (   self,
  theShape1,
  theShape2,
  theShapeType,
  theName = None 
)

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.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of sub-shapes of theShape1, shared with theShape2.

Example

References geomBuilder._autoPublish(), geomBuilder.GetSharedShapes(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetSharedShapesMulti()

GetSharedShapesMulti (   self,
  theShapes,
  theShapeType,
  theMultiShare = True,
  theName = None 
)

Get sub-shapes, shared by input shapes.

Parameters
theShapesEither a list or compound of shapes to find common sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType()).
theMultiShareSpecifies what type of shares should be checked:
  • True (default): search sub-shapes from 1st input shape shared with all other input shapes;
  • False: causes to search sub-shapes shared between couples of input shapes.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Note
If theShapes contains single compound, the shares between all possible couples of its top-level shapes are returned; otherwise, only shares between 1st input shape and all rest input shapes are returned.
Returns
List of all found sub-shapes.

Examples:

References geomBuilder._autoPublish(), geomBuilder.GetSharedShapesMulti(), geomBuilder.RaiseIfFailed(), geomBuilder.ShapesOp, and geomBuilder.ToList().

◆ GetShapesOnPlane()

GetShapesOnPlane (   self,
  theShape,
  theShapeType,
  theAx1,
  theState,
  theName = None 
)

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 (see ShapeType())
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 (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnPlane(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnPlaneIDs()

GetShapesOnPlaneIDs (   self,
  theShape,
  theShapeType,
  theAx1,
  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 (see ShapeType())
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 (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnPlaneIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnPlaneWithLocation()

GetShapesOnPlaneWithLocation (   self,
  theShape,
  theShapeType,
  theAx1,
  thePnt,
  theState,
  theName = None 
)

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 (see ShapeType())
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 (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnPlaneWithLocation(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnPlaneWithLocationIDs()

GetShapesOnPlaneWithLocationIDs (   self,
  theShape,
  theShapeType,
  theAx1,
  thePnt,
  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 (see ShapeType())
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 (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnPlaneWithLocationIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnCylinder()

GetShapesOnCylinder (   self,
  theShape,
  theShapeType,
  theAxis,
  theRadius,
  theState,
  theName = None 
)

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 (see ShapeType())
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 (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnCylinder(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnCylinderIDs()

GetShapesOnCylinderIDs (   self,
  theShape,
  theShapeType,
  theAxis,
  theRadius,
  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 (see ShapeType())
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 (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnCylinderIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnCylinderWithLocation()

GetShapesOnCylinderWithLocation (   self,
  theShape,
  theShapeType,
  theAxis,
  thePnt,
  theRadius,
  theState,
  theName = None 
)

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 (see ShapeType())
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 (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnCylinderWithLocation(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnCylinderWithLocationIDs()

GetShapesOnCylinderWithLocationIDs (   self,
  theShape,
  theShapeType,
  theAxis,
  thePnt,
  theRadius,
  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 (see ShapeType())
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 (see GEOM::shape_state)
Returns
List of all found sub-shapes indices

Example

References geomBuilder.GetShapesOnCylinderWithLocationIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnSphere()

GetShapesOnSphere (   self,
  theShape,
  theShapeType,
  theCenter,
  theRadius,
  theState,
  theName = None 
)

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 (see ShapeType())
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 (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnSphere(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnSphereIDs()

GetShapesOnSphereIDs (   self,
  theShape,
  theShapeType,
  theCenter,
  theRadius,
  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 (see ShapeType())
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 (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnSphereIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnQuadrangle()

GetShapesOnQuadrangle (   self,
  theShape,
  theShapeType,
  theTopLeftPoint,
  theTopRightPoint,
  theBottomLeftPoint,
  theBottomRightPoint,
  theState,
  theName = None 
)

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 (see ShapeType())
theTopLeftPointPoint, specifying top left corner of a quadrangle
theTopRightPointPoint, specifying top right corner of a quadrangle
theBottomLeftPointPoint, specifying bottom left corner of a quadrangle
theBottomRightPointPoint, specifying bottom right corner of a quadrangle
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnQuadrangle(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnQuadrangleIDs()

GetShapesOnQuadrangleIDs (   self,
  theShape,
  theShapeType,
  theTopLeftPoint,
  theTopRightPoint,
  theBottomLeftPoint,
  theBottomRightPoint,
  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 (see ShapeType())
theTopLeftPointPoint, specifying top left corner of a quadrangle
theTopRightPointPoint, specifying top right corner of a quadrangle
theBottomLeftPointPoint, specifying bottom left corner of a quadrangle
theBottomRightPointPoint, specifying bottom right corner of a quadrangle
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnQuadrangleIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnBox()

GetShapesOnBox (   self,
  theBox,
  theShape,
  theShapeType,
  theState,
  theName = None 
)

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

Parameters
theBoxShape for relative comparing.
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType())
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnBox(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnBoxIDs()

GetShapesOnBoxIDs (   self,
  theBox,
  theShape,
  theShapeType,
  theState 
)

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

Parameters
theBoxShape for relative comparing.
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType())
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnBoxIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnShape()

GetShapesOnShape (   self,
  theCheckShape,
  theShape,
  theShapeType,
  theState,
  theName = None 
)

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

Parameters
theCheckShapeShape for relative comparing. It must be a solid.
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType())
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
List of all found sub-shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnShape(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnShapeAsCompound()

GetShapesOnShapeAsCompound (   self,
  theCheckShape,
  theShape,
  theShapeType,
  theState,
  theName = None 
)

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

Parameters
theCheckShapeShape for relative comparing. It must be a solid.
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType())
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
All found sub-shapes as compound.

Example

References geomBuilder._autoPublish(), geomBuilder.GetShapesOnShapeAsCompound(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetShapesOnShapeIDs()

GetShapesOnShapeIDs (   self,
  theCheckShape,
  theShape,
  theShapeType,
  theState 
)

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

Parameters
theCheckShapeShape for relative comparing. It must be a solid.
theShapeShape to find sub-shapes of.
theShapeTypeType of sub-shapes to be retrieved (see ShapeType())
theStateThe state of the sub-shapes to find (see GEOM::shape_state)
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetShapesOnShapeIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetInPlace()

GetInPlace (   self,
  theShapeWhere,
  theShapeWhat,
  isNewImplementation = False,
  theName = None 
)

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.
isNewImplementationimplementation of GetInPlace functionality (default = False, old alghorithm based on shape properties)
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
Compound which includes all found sub-shapes if they have different types; or group of all found shapes of the equal type; or a single found sub-shape.
Note
This function has a restriction on argument shapes. If theShapeWhere has curved parts with significantly outstanding centres (i.e. the mass centre of a part is closer to theShapeWhat than to the part), such parts will not be found.

Example

References geomBuilder._autoPublish(), geomBuilder.GetInPlace(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetInPlaceByHistory()

GetInPlaceByHistory (   self,
  theShapeWhere,
  theShapeWhat,
  theName = None 
)

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 (must be in the building history of the ShapeWhere).
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
Compound which includes all found sub-shapes if they have different types; or group of all found shapes of the equal type; or a single found sub-shape.

Example

References geomBuilder._autoPublish(), geomBuilder.GetInPlaceByHistory(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetInPlaceMap()

GetInPlaceMap (   self,
  theShapeWhere,
  theShapeWhat 
)

A sort of GetInPlace functionality, returning IDs of sub-shapes.

For each sub-shape ID of theShapeWhat return a list of corresponding sub-shape IDs of theShapeWhere. For example, if theShapeWhat is a box and theShapeWhere is this box cut into two parts by a plane, then the result can be as this: len( result_list ) = 35, result_list[ 1 ] = [ 2, 36 ], which means that the box (ID 1) turned into two solids with IDs 2 and 36 within theShapeWhere

Parameters
theShapeWhereShape to find sub-shapes of.
theShapeWhatShape, specifying what to find.
Returns
List of lists of sub-shape IDS of theShapeWhere.

References geomBuilder.GetInPlaceMap(), and geomBuilder.ShapesOp.

◆ GetSame()

GetSame (   self,
  theShapeWhere,
  theShapeWhat,
  theName = None 
)

Get sub-shape of theShapeWhere, which is equal to theShapeWhat.

Parameters
theShapeWhereShape to find sub-shape of.
theShapeWhatShape, specifying what to find.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object for found sub-shape.

Example

References geomBuilder._autoPublish(), geomBuilder.GetSame(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ GetSameIDs()

GetSameIDs (   self,
  theShapeWhere,
  theShapeWhat 
)

Get sub-shape indices of theShapeWhere, which is equal to theShapeWhat.

Parameters
theShapeWhereShape to find sub-shape of.
theShapeWhatShape, specifying what to find.
Returns
List of all found sub-shapes indices.

Example

References geomBuilder.GetSameIDs(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ ExtendEdge()

ExtendEdge (   self,
  theEdge,
  theMin,
  theMax,
  theName = None 
)

Resize the input edge with the new Min and Max parameters.

The input edge parameters range is [0, 1]. If theMin parameter is negative, the input edge is extended, otherwise it is shrinked by theMin parameter. If theMax is greater than 1, the edge is extended, otherwise it is shrinked by theMax parameter.

Parameters
theEdgethe input edge to be resized.
theMinthe minimal parameter value.
theMaxthe maximal parameter value.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created edge.

Example

References geomBuilder._autoPublish(), geomBuilder.ExtendEdge(), geomBuilder.ParseParameters(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ ExtendFace()

ExtendFace (   self,
  theFace,
  theUMin,
  theUMax,
  theVMin,
  theVMax,
  theName = None 
)

Resize the input face with the new UMin, UMax, VMin and VMax parameters.

The input face U and V parameters range is [0, 1]. If theUMin parameter is negative, the input face is extended, otherwise it is shrinked along U direction by theUMin parameter. If theUMax is greater than 1, the face is extended, otherwise it is shrinked along U direction by theUMax parameter. So as for theVMin, theVMax and V direction of the input face.

Parameters
theFacethe input face to be resized.
theUMinthe minimal U parameter value.
theUMaxthe maximal U parameter value.
theVMinthe minimal V parameter value.
theVMaxthe maximal V parameter value.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created face.

Example

References geomBuilder._autoPublish(), geomBuilder.ExtendFace(), geomBuilder.ParseParameters(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.

◆ MakeSurfaceFromFace()

MakeSurfaceFromFace (   self,
  theFace,
  theName = None 
)

This function takes some face as input parameter and creates new GEOM_Object, i.e.

topological shape by extracting underlying surface of the source face and limiting it by the Umin, Umax, Vmin, Vmax parameters of the source face (in the parametrical space).

Parameters
theFacethe input face.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created face.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeSurfaceFromFace(), geomBuilder.RaiseIfFailed(), and geomBuilder.ShapesOp.