Version: 6.5.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions
GEOM::GEOM_IMeasureOperations Interface Reference

Interface for measurement (distance, whatis) and properties calculation (like Centre of Mass, Inertia, etc.). More...

import "GEOM_Gen.idl";

Public Member Functions

GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape, out ListOfLong theIntegers, out ListOfDouble theDoubles)
 Get kind of theShape.
void GetPosition (in GEOM_Object theShape, out double Ox, out double Oy, out double Oz, out double Zx, out double Zy, out double Zz, out double Xx, out double Xy, out double Xz)
 Get position (LCS) of theShape.
void GetBasicProperties (in GEOM_Object theShape, out double theLength, out double theSurfArea, out double theVolume)
 Get summarized length of all wires, area of surface and volume of the given shape.
GEOM_Object GetCentreOfMass (in GEOM_Object theShape)
 Get a point, situated at the centre of mass of theShape.
GEOM_Object GetVertexByIndex (in GEOM_Object theShape, in long index)
GEOM_Object GetNormal (in GEOM_Object theFace, in GEOM_Object theOptionalPoint)
 Get a vector, representing the normal of theFace. If the face is not planar, theOptionalPoint is obligatory.
void GetInertia (in GEOM_Object theShape, out double I11, out double I12, out double I13, out double I21, out double I22, out double I23, out double I31, out double I32, out double I33, out double Ix, out double Iy, out double Iz)
 Get inertia matrix and moments of inertia of theShape.
void GetBoundingBox (in GEOM_Object theShape, out double Xmin, out double Xmax, out double Ymin, out double Ymax, out double Zmin, out double Zmax)
 Get parameters of bounding box of the given shape.
void GetTolerance (in GEOM_Object theShape, out double FaceMin, out double FaceMax, out double EdgeMin, out double EdgeMax, out double VertMin, out double VertMax)
 Get min and max tolerances of sub-shapes of theShape.
boolean CheckShape (in GEOM_Object theShape, out string theDescription)
 Check a topology of the given shape.
boolean CheckShapeWithGeometry (in GEOM_Object theShape, out string theDescription)
 Check a topology and a geometry of the given shape.
boolean CheckSelfIntersections (in GEOM_Object theShape, out ListOfLong theIntersections)
 Check a topology of the given shape on self-intersections presence.
string IsGoodForSolid (in GEOM_Object theShape)
 Check if the given shape can be an argument for MakeSolid operation.
string WhatIs (in GEOM_Object theShape)
 btain description of the given shape
ListOfBool AreCoordsInside (in GEOM_Object theShape, in ListOfDouble coords, in double tolerance)
 Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on the shape theShape.
double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2, out double X1, out double Y1, out double Z1, out double X2, out double Y2, out double Z2)
 Get minimal distance between the given shapes.
double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2)
 Get angle between the given lines or linear edges.
double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2)
 Get angle between the given vectors.
void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z)
 Get point coordinates.
double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam)
 Get radius of curvature of curve in the point determinated by param.
double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint)
 Get radius of curvature of curve in the given point.
double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam, in double theVParam)
 Get max radius of curvature of surface in the point determinated by params.
double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint)
 Get max radius of curvature of surface in the given point.
double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam, in double theVParam)
 Get min radius of curvature of surface in the point determinated by params.
double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint)
 Get min radius of curvature of surface in the given point.
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 measurement (distance, whatis) and properties calculation (like Centre of Mass, Inertia, etc.).

Member Function Documentation

GEOM_IKindOfShape::shape_kind GEOM::GEOM_IMeasureOperations::KindOfShape ( in GEOM_Object  theShape,
out ListOfLong  theIntegers,
out ListOfDouble  theDoubles 
)

Get kind of theShape.

Parameters
theShapeShape to get a kind of.
theIntegersOutput. Integer and enumerated shape's parameters (kind of surface, closed/unclosed, number of edges, etc.)
theDoublesOutput. Double shape's parameters (coordinates, dimensions, etc.)
Note
Concrete meaning of each value, returned via theIntegers or theDoubles list depends on the kind of the shape.
Returns
Returns a kind of shape in terms of GEOM_IKindOfShape.shape_kind enumeration.
void GEOM::GEOM_IMeasureOperations::GetPosition ( in GEOM_Object  theShape,
out double  Ox,
out double  Oy,
out double  Oz,
out double  Zx,
out double  Zy,
out double  Zz,
out double  Xx,
out double  Xy,
out double  Xz 
)

Get position (LCS) of theShape.

Parameters
theShapeShape to calculate position of.
Ox,Oy,OzOutput. Coordinates of shape's location origin. Origin of the LCS is situated at the shape's center of mass.
Zx,Zy,ZzOutput. Coordinates of shape's location normal(main) direction.
Xx,Xy,XzOutput. Coordinates of shape's location X direction. Axes of the LCS are obtained from shape's location or, if the shape is a planar face, from position of its plane.
Returns
Returns position of the shape through the last nine arguments.
void GEOM::GEOM_IMeasureOperations::GetBasicProperties ( in GEOM_Object  theShape,
out double  theLength,
out double  theSurfArea,
out double  theVolume 
)

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

Parameters
theShapeShape to define properties of.
theLengthOutput. Summarized length of all wires of the given shape.
theSurfAreaOutput. Area of surface of the given shape.
theVolumeOutput. Volume of the given shape.
Returns
Returns shape properties through the last three arguments.
GEOM_Object GEOM::GEOM_IMeasureOperations::GetCentreOfMass ( in GEOM_Object  theShape)

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

Parameters
theShapeShape to define centre of mass of.
Returns
New GEOM_Object, containing the created point.
GEOM_Object GEOM::GEOM_IMeasureOperations::GetVertexByIndex ( in GEOM_Object  theShape,
in long  index 
)
GEOM_Object GEOM::GEOM_IMeasureOperations::GetNormal ( in GEOM_Object  theFace,
in GEOM_Object  theOptionalPoint 
)

Get a vector, representing the normal of theFace. If the face is not planar, theOptionalPoint is obligatory.

Parameters
theFaceShape (face) to define the normal of.
theOptionalPointShape (point) to define the normal at. Can be NULL in case of planar face.
Returns
New GEOM_Object, containing the created normal vector.
void GEOM::GEOM_IMeasureOperations::GetInertia ( in GEOM_Object  theShape,
out double  I11,
out double  I12,
out double  I13,
out double  I21,
out double  I22,
out double  I23,
out double  I31,
out double  I32,
out double  I33,
out double  Ix,
out double  Iy,
out double  Iz 
)

Get inertia matrix and moments of inertia of theShape.

Parameters
theShapeShape to calculate inertia of.
I11,I12,I13,I21,I22,I23,I31,I32,I33Output. Components of the inertia matrix of the given shape.
Ix,Iy,IzOutput. Moments of inertia of the given shape.
Returns
Returns inertia through the last twelve arguments.
void GEOM::GEOM_IMeasureOperations::GetBoundingBox ( in GEOM_Object  theShape,
out double  Xmin,
out double  Xmax,
out double  Ymin,
out double  Ymax,
out double  Zmin,
out double  Zmax 
)

Get parameters of bounding box of the given shape.

Parameters
theShapeShape to obtain bounding box of.
Xmin,XmaxOutput. Limits of shape along OX axis.
Ymin,YmaxOutput. Limits of shape along OY axis.
Zmin,ZmaxOutput. Limits of shape along OZ axis.
Returns
Returns parameters of bounding box through the last six arguments.
void GEOM::GEOM_IMeasureOperations::GetTolerance ( in GEOM_Object  theShape,
out double  FaceMin,
out double  FaceMax,
out double  EdgeMin,
out double  EdgeMax,
out double  VertMin,
out double  VertMax 
)

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

Parameters
theShapeShape, to get tolerances of.
FaceMin,FaceMaxOutput. Min and max tolerances of the faces.
EdgeMin,EdgeMaxOutput. Min and max tolerances of the edges.
VertMin,VertMaxOutput. Min and max tolerances of the vertices.
Returns
Returns shape tolerances through the last six arguments.
boolean GEOM::GEOM_IMeasureOperations::CheckShape ( in GEOM_Object  theShape,
out string  theDescription 
)

Check a topology of the given shape.

Parameters
theShapeShape to check validity of.
theDescriptionOutput. Description of problems in the shape, if they are.
Returns
TRUE, if the shape "seems to be valid" from the topological point of view.
boolean GEOM::GEOM_IMeasureOperations::CheckShapeWithGeometry ( in GEOM_Object  theShape,
out string  theDescription 
)

Check a topology and a geometry of the given shape.

Parameters
theShapeShape to check validity of.
theDescriptionOutput. Description of problems in the shape, if they are.
Returns
TRUE, if the shape "seems to be valid".
boolean GEOM::GEOM_IMeasureOperations::CheckSelfIntersections ( in GEOM_Object  theShape,
out ListOfLong  theIntersections 
)

Check a topology of the given shape on self-intersections presence.

Parameters
theShapeShape to check validity of.
theIntersectionsOutput. List of intersected sub-shapes IDs, it contains pairs of IDs.
Returns
TRUE, if the shape does not have any self-intersections.
string GEOM::GEOM_IMeasureOperations::IsGoodForSolid ( in GEOM_Object  theShape)

Check if the given shape can be an argument for MakeSolid operation.

Parameters
theShapeShape to be described.
Returns
Empty string if a solid can be made on this shape, error code otherwise.
string GEOM::GEOM_IMeasureOperations::WhatIs ( in GEOM_Object  theShape)

btain description of the given shape

O

Parameters
theShapeShape to be described.
Returns
Description of the given shape.
ListOfBool GEOM::GEOM_IMeasureOperations::AreCoordsInside ( in GEOM_Object  theShape,
in ListOfDouble  coords,
in double  tolerance 
)

Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on the shape theShape.

Parameters
theShapeShape to check.
coordslist of coordinates.
tolerancetolerance.
Returns
list of boolean.
double GEOM::GEOM_IMeasureOperations::GetMinDistance ( in GEOM_Object  theShape1,
in GEOM_Object  theShape2,
out double  X1,
out double  Y1,
out double  Z1,
out double  X2,
out double  Y2,
out double  Z2 
)

Get minimal distance between the given shapes.

Parameters
theShape1,theShape2Shapes to find minimal distance between.
X1,Y1,Z1Output. Coordinates of point on theShape1, nearest to theShape2.
X2,Y2,Z2Output. Coordinates of point on theShape2, nearest to theShape1.
Returns
Value of the minimal distance between the given shapes.
double GEOM::GEOM_IMeasureOperations::GetAngle ( in GEOM_Object  theShape1,
in GEOM_Object  theShape2 
)

Get angle between the given lines or linear edges.

Parameters
theShape1,theShape2Shapes to find angle between. Lines or linear edges.
Returns
Value of the angle between the given shapes.
double GEOM::GEOM_IMeasureOperations::GetAngleBtwVectors ( in GEOM_Object  theShape1,
in GEOM_Object  theShape2 
)

Get angle between the given vectors.

Parameters
theShape1,theShape2Vectors to find angle between.
Returns
Value of the angle between the given vectors.
void GEOM::GEOM_IMeasureOperations::PointCoordinates ( in GEOM_Object  theShape,
out double  X,
out double  Y,
out double  Z 
)

Get point coordinates.

double GEOM::GEOM_IMeasureOperations::CurveCurvatureByParam ( in GEOM_Object  theShape,
in double  theParam 
)

Get radius of curvature of curve in the point determinated by param.

Parameters
theShape- curve.
theParam- parameter on curve
Returns
Value of curvature.
double GEOM::GEOM_IMeasureOperations::CurveCurvatureByPoint ( in GEOM_Object  theShape,
in GEOM_Object  thePoint 
)

Get radius of curvature of curve in the given point.

Parameters
theShape- curve.
thePoint- point
Returns
Value of curvature.
double GEOM::GEOM_IMeasureOperations::MaxSurfaceCurvatureByParam ( in GEOM_Object  theShape,
in double  theUParam,
in double  theVParam 
)

Get max radius of curvature of surface in the point determinated by params.

Parameters
theShape- surface.
theUParam- U-parameter on surface
theVParam- V-parameter on surface
Returns
Value of curvature.
double GEOM::GEOM_IMeasureOperations::MaxSurfaceCurvatureByPoint ( in GEOM_Object  theShape,
in GEOM_Object  thePoint 
)

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

Parameters
theShape- surface.
thePoint- point
Returns
Value of curvature.
double GEOM::GEOM_IMeasureOperations::MinSurfaceCurvatureByParam ( in GEOM_Object  theShape,
in double  theUParam,
in double  theVParam 
)

Get min radius of curvature of surface in the point determinated by params.

Parameters
theShape- surface.
theUParam- U-parameter on surface
theVParam- V-parameter on surface
Returns
Value of curvature.
double GEOM::GEOM_IMeasureOperations::MinSurfaceCurvatureByPoint ( in GEOM_Object  theShape,
in GEOM_Object  thePoint 
)

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

Parameters
theShape- surface.
thePoint- point
Returns
Value of curvature.
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
theErrorIDis 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.

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