Version: 6.5.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
Using measurement tools
All package methods, grouped by their purpose

Functions

def geompy.NumberOfFaces
 Gives quantity of faces in the given shape.
def geompy.NumberOfEdges
 Gives quantity of edges in the given shape.
def geompy.NumberOfSubShapes
 Gives quantity of sub-shapes of type theShapeType in the given shape.
def geompy.NumberOfSolids
 Gives quantity of solids in the given shape.
def geompy.PointCoordinates
 Get point coordinates.
def geompy.BasicProperties
 Get summarized length of all wires, area of surface and volume of the given shape.
def geompy.BoundingBox
 Get parameters of bounding box of the given shape.
def geompy.Inertia
 Get inertia matrix and moments of inertia of theShape.
def geompy.AreCoordsInside
 Get if coords are included in the shape (ST_IN or ST_ON)
def geompy.MinDistance
 Get minimal distance between the given shapes.
def geompy.MinDistanceComponents
 Get minimal distance between the given shapes.
def geompy.GetAngle
 Get angle between the given shapes in degrees.
def geompy.GetAngleRadians
 Get angle between the given shapes in radians.
def geompy.Tolerance
 Get min and max tolerances of sub-shapes of theShape.
def geompy.WhatIs
 Obtain description of the given shape (number of sub-shapes of each type)
def geompy.NbShapes
 Obtain quantity of shapes of the given type in theShape.
def geompy.ShapeInfo
 Obtain quantity of shapes of each type in theShape.
def geompy.MakeCDG
 Get a point, situated at the centre of mass of theShape.
def geompy.GetVertexByIndex
 Get a vertex sub-shape by index depended with orientation.
def geompy.GetFirstVertex
 Get the first vertex of wire/edge depended orientation.
def geompy.GetLastVertex
 Get the last vertex of wire/edge depended orientation.
def geompy.GetNormal
 Get a normale to the given face.
def geompy.CheckShape
 Check a topology of the given shape.
def geompy.CheckSelfIntersections
 Detect self-intersections in the given shape.
def geompy.GetPosition
 Get position (LCS) of theShape.
def geompy.KindOfShape
 Get kind of theShape.

Curve Curvature Measurement

Methods for receiving radius of curvature of curves in the given point

def geompy.CurveCurvatureByParam
 Measure curvature of a curve at a point, set by parameter.
def geompy.CurveCurvatureByPoint
 Measure curvature of a curve at a point.

Surface Curvature Measurement

Methods for receiving max and min radius of curvature of surfaces in the given point

def geompy.MaxSurfaceCurvatureByParam
 Measure max radius of curvature of surface.
def geompy.MaxSurfaceCurvatureByPoint
 Measure max radius of curvature of surface in the given point.
def geompy.MinSurfaceCurvatureByParam
 Measure min radius of curvature of surface.
def geompy.MinSurfaceCurvatureByPoint
 Measure min radius of curvature of surface in the given point.

Detailed Description

Function Documentation

def geompy.NumberOfFaces (   self,
  theShape 
)

Gives quantity of faces in the given shape.

Parameters
theShapeShape to count faces of.
Returns
Quantity of faces.

Example

References geompy.RaiseIfFailed().

def geompy.NumberOfEdges (   self,
  theShape 
)

Gives quantity of edges in the given shape.

Parameters
theShapeShape to count edges of.
Returns
Quantity of edges.

Example

References geompy.RaiseIfFailed().

def geompy.NumberOfSubShapes (   self,
  theShape,
  theShapeType 
)

Gives quantity of sub-shapes of type theShapeType in the given shape.

Parameters
theShapeShape to count sub-shapes of.
theShapeTypeType of sub-shapes to count (see ShapeType())
Returns
Quantity of sub-shapes of given type.

Example

References geompy.RaiseIfFailed().

def geompy.NumberOfSolids (   self,
  theShape 
)

Gives quantity of solids in the given shape.

Parameters
theShapeShape to count solids in.
Returns
Quantity of solids.

Example

References geompy.RaiseIfFailed().

def geompy.PointCoordinates (   self,
  Point 
)

Get point coordinates.

Returns
[x, y, z]

Example

References geompy.RaiseIfFailed().

def geompy.BasicProperties (   self,
  theShape 
)

Get summarized length of all wires, area of surface and volume of the given shape.

Parameters
theShapeShape to define properties of.
Returns
[theLength, theSurfArea, theVolume]
theLength: Summarized length of all wires of the given shape.
theSurfArea: Area of surface of the given shape.
theVolume: Volume of the given shape.

Example

References geompy.RaiseIfFailed().

def geompy.BoundingBox (   self,
  theShape 
)

Get parameters of bounding box of the given shape.

Parameters
theShapeShape to obtain bounding box of.
Returns
[Xmin,Xmax, Ymin,Ymax, Zmin,Zmax] Xmin,Xmax: Limits of shape along OX axis. Ymin,Ymax: Limits of shape along OY axis. Zmin,Zmax: Limits of shape along OZ axis.

Example

References geompy.RaiseIfFailed().

def geompy.Inertia (   self,
  theShape 
)

Get inertia matrix and moments of inertia of theShape.

Parameters
theShapeShape to calculate inertia of.
Returns
[I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz] I(1-3)(1-3): Components of the inertia matrix of the given shape. Ix,Iy,Iz: Moments of inertia of the given shape.

Example

References geompy.RaiseIfFailed().

def geompy.AreCoordsInside (   self,
  theShape,
  coords,
  tolerance = 1.e-7 
)

Get if coords are included in the shape (ST_IN or ST_ON)

Parameters
theShapeShape
coordslist of points coordinates [x1, y1, z1, x2, y2, z2, ...]
toleranceto be used (default is 1.0e-7)
Returns
list_of_boolean = [res1, res2, ...]
def geompy.MinDistance (   self,
  theShape1,
  theShape2 
)

Get minimal distance between the given shapes.

Parameters
theShape1,theShape2Shapes to find minimal distance between.
Returns
Value of the minimal distance between the given shapes.

Example

References geompy.RaiseIfFailed().

def geompy.MinDistanceComponents (   self,
  theShape1,
  theShape2 
)

Get minimal distance between the given shapes.

Parameters
theShape1,theShape2Shapes to find minimal distance between.
Returns
Value of the minimal distance between the given shapes.

Example

References geompy.RaiseIfFailed().

def geompy.GetAngle (   self,
  theShape1,
  theShape2 
)

Get angle between the given shapes in degrees.

Parameters
theShape1,theShape2Lines or linear edges to find angle between.
Note
If both arguments are vectors, the angle is computed in accordance with their orientations, otherwise the minimum angle is computed.
Returns
Value of the angle between the given shapes in degrees.

Example

References geompy.RaiseIfFailed().

def geompy.GetAngleRadians (   self,
  theShape1,
  theShape2 
)

Get angle between the given shapes in radians.

Parameters
theShape1,theShape2Lines or linear edges to find angle between.
Note
If both arguments are vectors, the angle is computed in accordance with their orientations, otherwise the minimum angle is computed.
Returns
Value of the angle between the given shapes in radians.

Example

References geompy.RaiseIfFailed().

def geompy.CurveCurvatureByParam (   self,
  theCurve,
  theParam 
)

Measure curvature of a curve at a point, set by parameter.

Parameters
theCurvea curve.
theParamparameter.
Returns
radius of curvature of theCurve.

Example

References geompy.RaiseIfFailed().

def geompy.CurveCurvatureByPoint (   self,
  theCurve,
  thePoint 
)

Measure curvature of a curve at a point.

Parameters
theCurvea curve.
thePointgiven point.
Returns
radius of curvature of theCurve.

Example

References geompy.RaiseIfFailed().

def geompy.MaxSurfaceCurvatureByParam (   self,
  theSurf,
  theUParam,
  theVParam 
)

Measure max radius of curvature of surface.

Parameters
theSurfthe given surface.
theUParamValue of U-parameter on the referenced surface.
theVParamValue of V-parameter on the referenced surface.
Returns
max radius of curvature of theSurf.

Example

References geompy.RaiseIfFailed().

def geompy.MaxSurfaceCurvatureByPoint (   self,
  theSurf,
  thePoint 
)

Measure max radius of curvature of surface in the given point.

Parameters
theSurfthe given surface.
thePointgiven point.
Returns
max radius of curvature of theSurf.

Example

References geompy.RaiseIfFailed().

def geompy.MinSurfaceCurvatureByParam (   self,
  theSurf,
  theUParam,
  theVParam 
)

Measure min radius of curvature of surface.

Parameters
theSurfthe given surface.
theUParamValue of U-parameter on the referenced surface.
theVParamValue of V-parameter on the referenced surface.
Returns
min radius of curvature of theSurf.

Example

References geompy.RaiseIfFailed().

def geompy.MinSurfaceCurvatureByPoint (   self,
  theSurf,
  thePoint 
)

Measure min radius of curvature of surface in the given point.

Parameters
theSurfthe given surface.
thePointgiven point.
Returns
min radius of curvature of theSurf.

Example

References geompy.RaiseIfFailed().

def geompy.Tolerance (   self,
  theShape 
)

Get min and max tolerances of sub-shapes of theShape.

Parameters
theShapeShape, to get tolerances of.
Returns
[FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
FaceMin,FaceMax: Min and max tolerances of the faces.
EdgeMin,EdgeMax: Min and max tolerances of the edges.
VertMin,VertMax: Min and max tolerances of the vertices.

Example

References geompy.RaiseIfFailed().

def geompy.WhatIs (   self,
  theShape 
)

Obtain description of the given shape (number of sub-shapes of each type)

Parameters
theShapeShape to be described.
Returns
Description of the given shape.

Example

References geompy.RaiseIfFailed().

def geompy.NbShapes (   self,
  theShape,
  theType 
)

Obtain quantity of shapes of the given type in theShape.

If theShape is of type theType, it is also counted.

Parameters
theShapeShape to be described.
theTypethe given ShapeType().
Returns
Quantity of shapes of type theType in theShape.

Example

References geompy.EnumToLong().

def geompy.ShapeInfo (   self,
  theShape 
)

Obtain quantity of shapes of each type in theShape.

The theShape is also counted.

Parameters
theShapeShape to be described.
Returns
Dictionary of ShapeType() with bound quantities of shapes.

Example

References geompy.EnumToLong().

def geompy.MakeCDG (   self,
  theShape 
)

Get a point, situated at the centre of mass of theShape.

Parameters
theShapeShape to define centre of mass of.
Returns
New GEOM.GEOM_Object, containing the created point.

Example

References geompy.RaiseIfFailed().

def geompy.GetVertexByIndex (   self,
  theShape,
  theIndex 
)

Get a vertex sub-shape by index depended with orientation.

Parameters
theShapeShape to find sub-shape.
theIndexIndex to find vertex by this index (starting from zero)
Returns
New GEOM.GEOM_Object, containing the created vertex.

Example

References geompy.RaiseIfFailed().

def geompy.GetFirstVertex (   self,
  theShape 
)

Get the first vertex of wire/edge depended orientation.

Parameters
theShapeShape to find first vertex.
Returns
New GEOM.GEOM_Object, containing the created vertex.

Example

References geompy.RaiseIfFailed().

def geompy.GetLastVertex (   self,
  theShape 
)

Get the last vertex of wire/edge depended orientation.

Parameters
theShapeShape to find last vertex.
Returns
New GEOM.GEOM_Object, containing the created vertex.

Example

References geompy.RaiseIfFailed().

def geompy.GetNormal (   self,
  theFace,
  theOptionalPoint = None 
)

Get a normale to the given face.

If the point is not given, the normale is calculated at the center of mass.

Parameters
theFaceFace to define normale of.
theOptionalPointPoint to compute the normale at.
Returns
New GEOM.GEOM_Object, containing the created vector.

Example

References geompy.RaiseIfFailed().

def geompy.CheckShape (   self,
  theShape,
  theIsCheckGeom = 0,
  theReturnStatus = 0 
)

Check a topology of the given shape.

Parameters
theShapeShape to check validity of.
theIsCheckGeomIf FALSE, only the shape's topology will be checked,
if TRUE, the shape's geometry will be checked also.
theReturnStatusIf FALSE and if theShape is invalid, a description
of problem is printed. if TRUE and if theShape is invalid, the description of problem is also returned.
Returns
TRUE, if the shape "seems to be valid".

Example

References geompy.RaiseIfFailed().

def geompy.CheckSelfIntersections (   self,
  theShape 
)

Detect self-intersections in the given shape.

Parameters
theShapeShape to check.
Returns
TRUE, if the shape contains no self-intersections.

Example

References geompy.RaiseIfFailed().

def geompy.GetPosition (   self,
  theShape 
)

Get position (LCS) of theShape.

Origin of the LCS is situated at the shape's center of mass. Axes of the LCS are obtained from shape's location or, if the shape is a planar face, from position of its plane.

Parameters
theShapeShape to calculate position of.
Returns
[Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz]. Ox,Oy,Oz: Coordinates of shape's LCS origin. Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction. Xx,Xy,Xz: Coordinates of shape's LCS X direction.

Example

References geompy.RaiseIfFailed().

def geompy.KindOfShape (   self,
  theShape 
)

Get kind of theShape.

Parameters
theShapeShape to get a kind of.
Returns
Returns a kind of shape in terms of GEOM.GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape.
Note
Concrete meaning of each value, returned via theIntegers or theDoubles list depends on the kind() of the shape.

Example

References geompy.RaiseIfFailed().

Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS