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

Functions

 GetPoint (self, theShape, theX, theY, theZ, theEpsilon, theName=None)
 Get a vertex, found in the given shape by its coordinates.
 
 GetVertexNearPoint (self, theShape, thePoint, theName=None)
 Find a vertex of the given shape, which has minimal distance to the given point.
 
 GetEdge (self, theShape, thePoint1, thePoint2, theName=None)
 Get an edge, found in the given shape by two given vertices.
 
 GetEdgeNearPoint (self, theShape, thePoint, theName=None)
 Find an edge of the given shape, which has minimal distance to the given point.
 
 GetFaceByPoints (self, theShape, thePoint1, thePoint2, thePoint3, thePoint4, theName=None)
 Returns a face, found in the given shape by four given corner vertices.
 
 GetFaceByEdges (self, theShape, theEdge1, theEdge2, theName=None)
 Get a face of block, found in the given shape by two given edges.
 
 GetOppositeFace (self, theBlock, theFace, theName=None)
 Find a face, opposite to the given one in the given block.
 
 GetFaceNearPoint (self, theShape, thePoint, theName=None)
 Find a face of the given shape, which has minimal distance to the given point.
 
 GetFaceByNormale (self, theBlock, theVector, theName=None)
 Find a face of block, whose outside normale has minimal angle with the given vector.
 
 GetShapesNearPoint (self, theShape, thePoint, theShapeType, theTolerance=1e-07, theName=None)
 Find all sub-shapes of type theShapeType of the given shape, which have minimal distance to the given point.
 
 MakeBlockExplode (self, theCompound, theMinNbFaces, theMaxNbFaces, theName=None)
 Get all the blocks, contained in the given compound.
 
 GetBlockNearPoint (self, theCompound, thePoint, theName=None)
 Find block, containing the given point inside its volume or on boundary.
 
 GetBlockByParts (self, theCompound, theParts, theName=None)
 Find block, containing all the elements, passed as the parts, or maximum quantity of them.
 
 GetBlocksByParts (self, theCompound, theParts, theName=None)
 Return all blocks, containing all the elements, passed as the parts.
 
 MakeMultiTransformation1D (self, Block, DirFace1, DirFace2, NbTimes, theName=None)
 Multi-transformate block and glue the result.
 
 MakeMultiTransformation2D (self, Block, DirFace1U, DirFace2U, NbTimesU, DirFace1V, DirFace2V, NbTimesV, theName=None)
 Multi-transformate block and glue the result.
 
 Propagate (self, theShape, theName=None)
 Build all possible propagation groups.
 

Detailed Description

Function Documentation

◆ GetPoint()

GetPoint (   self,
  theShape,
  theX,
  theY,
  theZ,
  theEpsilon,
  theName = None 
)

Get a vertex, found in the given shape by its coordinates.

Parameters
theShapeBlock or a compound of blocks.
theX,theY,theZCoordinates of the sought vertex.
theEpsilonMaximum allowed distance between the resulting vertex and point with the given coordinates.
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 found vertex.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetPoint(), and geomBuilder.RaiseIfFailed().

◆ GetVertexNearPoint()

GetVertexNearPoint (   self,
  theShape,
  thePoint,
  theName = None 
)

Find a vertex of the given shape, which has minimal distance to the given point.

Parameters
theShapeAny shape.
thePointPoint, close to the desired vertex.
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 found vertex.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetVertexNearPoint(), and geomBuilder.RaiseIfFailed().

◆ GetEdge()

GetEdge (   self,
  theShape,
  thePoint1,
  thePoint2,
  theName = None 
)

Get an edge, found in the given shape by two given vertices.

Parameters
theShapeBlock or a compound of blocks.
thePoint1,thePoint2Points, close to the ends of the desired edge.
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 found edge.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetEdge(), and geomBuilder.RaiseIfFailed().

◆ GetEdgeNearPoint()

GetEdgeNearPoint (   self,
  theShape,
  thePoint,
  theName = None 
)

Find an edge of the given shape, which has minimal distance to the given point.

Parameters
theShapeBlock or a compound of blocks.
thePointPoint, close to the desired edge.
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 found edge.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetEdgeNearPoint(), and geomBuilder.RaiseIfFailed().

◆ GetFaceByPoints()

GetFaceByPoints (   self,
  theShape,
  thePoint1,
  thePoint2,
  thePoint3,
  thePoint4,
  theName = None 
)

Returns a face, found in the given shape by four given corner vertices.

Parameters
theShapeBlock or a compound of blocks.
thePoint1,thePoint2,thePoint3,thePoint4Points, close to the corners of the desired 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 found face.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetFaceByPoints(), and geomBuilder.RaiseIfFailed().

◆ GetFaceByEdges()

GetFaceByEdges (   self,
  theShape,
  theEdge1,
  theEdge2,
  theName = None 
)

Get a face of block, found in the given shape by two given edges.

Parameters
theShapeBlock or a compound of blocks.
theEdge1,theEdge2Edges, close to the edges of the desired 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 found face.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetFaceByEdges(), and geomBuilder.RaiseIfFailed().

◆ GetOppositeFace()

GetOppositeFace (   self,
  theBlock,
  theFace,
  theName = None 
)

Find a face, opposite to the given one in the given block.

Parameters
theBlockMust be a hexahedral solid.
theFaceFace of theBlock, opposite to the desired 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 found face.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetOppositeFace(), and geomBuilder.RaiseIfFailed().

◆ GetFaceNearPoint()

GetFaceNearPoint (   self,
  theShape,
  thePoint,
  theName = None 
)

Find a face of the given shape, which has minimal distance to the given point.

Parameters
theShapeBlock or a compound of blocks.
thePointPoint, close to the desired 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 found face.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetFaceNearPoint(), and geomBuilder.RaiseIfFailed().

◆ GetFaceByNormale()

GetFaceByNormale (   self,
  theBlock,
  theVector,
  theName = None 
)

Find a face of block, whose outside normale has minimal angle with the given vector.

Parameters
theBlockBlock or a compound of blocks.
theVectorVector, close to the normale of the desired 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 found face.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetFaceByNormale(), and geomBuilder.RaiseIfFailed().

◆ GetShapesNearPoint()

GetShapesNearPoint (   self,
  theShape,
  thePoint,
  theShapeType,
  theTolerance = 1e-07,
  theName = None 
)

Find all sub-shapes of type theShapeType of the given shape, which have minimal distance to the given point.

Parameters
theShapeAny shape.
thePointPoint, close to the desired shape.
theShapeTypeDefines what kind of sub-shapes is searched GEOM::shape_type
theToleranceThe tolerance for distances comparison. All shapes with distances to the given point in interval [minimal_distance, minimal_distance + theTolerance] will be gathered.
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_Object, containing a group of all found shapes.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetShapesNearPoint(), and geomBuilder.RaiseIfFailed().

◆ MakeBlockExplode()

MakeBlockExplode (   self,
  theCompound,
  theMinNbFaces,
  theMaxNbFaces,
  theName = None 
)

Get all the blocks, contained in the given compound.

Parameters
theCompoundThe compound to explode.
theMinNbFacesIf solid has lower number of faces, it is not a block.
theMaxNbFacesIf solid has higher number of faces, it is not a block.
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 theMaxNbFaces = 0, the maximum number of faces is not restricted.
Returns
List of GEOM.GEOM_Object, containing the retrieved blocks.

Example 1
Example 2

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.ParseParameters(), and geomBuilder.RaiseIfFailed().

◆ GetBlockNearPoint()

GetBlockNearPoint (   self,
  theCompound,
  thePoint,
  theName = None 
)

Find block, containing the given point inside its volume or on boundary.

Parameters
theCompoundCompound, to find block in.
thePointPoint, close to the desired block. If the point lays on boundary between some blocks, we return block with nearest center.
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 found block.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetBlockNearPoint(), and geomBuilder.RaiseIfFailed().

◆ GetBlockByParts()

GetBlockByParts (   self,
  theCompound,
  theParts,
  theName = None 
)

Find block, containing all the elements, passed as the parts, or maximum quantity of them.

Parameters
theCompoundCompound, to find block in.
thePartsList of faces and/or edges and/or vertices to be parts of the found block.
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 found block.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetBlockByParts(), and geomBuilder.RaiseIfFailed().

◆ GetBlocksByParts()

GetBlocksByParts (   self,
  theCompound,
  theParts,
  theName = None 
)

Return all blocks, containing all the elements, passed as the parts.

Parameters
theCompoundCompound, to find blocks in.
thePartsList of faces and/or edges and/or vertices to be parts of the found blocks.
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 GEOM.GEOM_Object, containing the found blocks.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.GetBlocksByParts(), and geomBuilder.RaiseIfFailed().

◆ MakeMultiTransformation1D()

MakeMultiTransformation1D (   self,
  Block,
  DirFace1,
  DirFace2,
  NbTimes,
  theName = None 
)

Multi-transformate block and glue the result.

Transformation is defined so, as to superpose direction faces.

Parameters
BlockHexahedral solid to be multi-transformed.
DirFace1ID of First direction face.
DirFace2ID of Second direction face.
NbTimesQuantity of transformations to be done.
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
Unique ID of sub-shape can be obtained, using method GetSubShapeID().
Returns
New GEOM.GEOM_Object, containing the result shape.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.MakeMultiTransformation1D(), geomBuilder.ParseParameters(), and geomBuilder.RaiseIfFailed().

◆ MakeMultiTransformation2D()

MakeMultiTransformation2D (   self,
  Block,
  DirFace1U,
  DirFace2U,
  NbTimesU,
  DirFace1V,
  DirFace2V,
  NbTimesV,
  theName = None 
)

Multi-transformate block and glue the result.

Parameters
BlockHexahedral solid to be multi-transformed.
DirFace1U,DirFace2UIDs of Direction faces for the first transformation.
DirFace1V,DirFace2VIDs of Direction faces for the second transformation.
NbTimesU,NbTimesVQuantity of transformations to be done.
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 result shape.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.MakeMultiTransformation2D(), geomBuilder.ParseParameters(), and geomBuilder.RaiseIfFailed().

◆ Propagate()

Propagate (   self,
  theShape,
  theName = None 
)

Build all possible propagation groups.

Propagation group is a set of all edges, opposite to one (main) edge of this group directly or through other opposite edges. Notion of Opposite Edge make sense only on quadrangle face.

Parameters
theShapeShape to build propagation groups on.
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 GEOM.GEOM_Object, each of them is a propagation group.

Example

References geomBuilder._autoPublish(), geomBuilder.BlocksOp, geomBuilder.Propagate(), and geomBuilder.RaiseIfFailed().