Version: 9.15.0
Home
GEOM Module Reference

Data Structures

struct  Parameter
 Object creation parameters. More...
 
struct  CreationInformation
 
struct  ModifInfo
 Reporting on shape healing. More...
 
interface  GEOM_BaseObject
 A common root of objects in GEOM module. More...
 
interface  GEOM_Object
 Interface of geometric object. More...
 
interface  GEOM_Field
 Interface of the field. More...
 
interface  GEOM_FieldStep
 Interface of the field time step. More...
 
interface  GEOM_BoolFieldStep
 Interface of the boolean field time step. More...
 
interface  GEOM_IntFieldStep
 Interface of the integer field time step. More...
 
interface  GEOM_DoubleFieldStep
 Interface of the double field time step. More...
 
interface  GEOM_StringFieldStep
 Interface of the string field time step. More...
 
interface  GEOM_IOperations
 Basic methods of all geometric operations. More...
 
interface  GEOM_IBasicOperations
 Interface for basic geometry creation. More...
 
interface  GEOM_ITransformOperations
 Interface for shapes transforming. More...
 
interface  GEOM_I3DPrimOperations
 Interface for 3D primitives creation. More...
 
interface  GEOM_IShapesOperations
 Interface for Shapes creation: More...
 
interface  GEOM_IBlocksOperations
 Interface for Blocks construction Face from points or edges, Block from faces, Blocks multi-translation and multi-rotation. More...
 
interface  GEOM_IBooleanOperations
 Interface for boolean operations (Cut, Fuse, Common) More...
 
interface  GEOM_ICurvesOperations
 Interface for curves creation. More...
 
interface  GEOM_ILocalOperations
 Interface for fillet and chamfer creation. More...
 
interface  GEOM_IHealingOperations
 Interface for shape healing operations. More...
 
interface  GEOM_IInsertOperations
 Interface for shape insert operations (like copy, import). More...
 
interface  GEOM_IKindOfShape
 Interface for shape_kind enumeration. More...
 
interface  GEOM_IMeasureOperations
 Interface for measurement (distance, whatis) and properties calculation (like Centre of Mass, Inertia, etc.). More...
 
interface  GEOM_IGroupOperations
 Interface for groups creation. More...
 
interface  GEOM_IFieldOperations
 Interface for field operation. More...
 
interface  GEOM_ITestOperations
 Interface for testing operations. More...
 
interface  GEOM_ICanonicalRecognition
 Interface for canonical recognition operations. More...
 
interface  GEOM_Gen
 Interface to access other GEOM interfaces. More...
 
interface  ISTLOperations
 Interface for STLPlugin modeling functions. More...
 
interface  IBREPOperations
 Interface for BREPPlugin modeling functions. More...
 
interface  ISTEPOperations
 Interface for STEPPlugin modeling functions. More...
 
interface  IIGESOperations
 Interface for IGESPlugin modeling functions. More...
 
interface  IXAOOperations
 Interface for XAOPlugin modeling functions. More...
 
interface  IVTKOperations
 Interface for VTKPlugin modeling functions. More...
 

Typedefs

typedef sequence< ParameterParameters
 
typedef sequence< CreationInformationCreationInformationSeq
 
typedef sequence< ModifInfoModifStatistics
 
typedef sequence< string > string_array
 
typedef sequence< short > short_array
 
typedef sequence< boolean > ListOfBool
 
typedef sequence< long > ListOfLong
 
typedef sequence< double > ListOfDouble
 
typedef sequence< ListOfDoubleListOfListOfDouble
 
typedef sequence< ListOfLongListOfListOfLong
 
typedef sequence< GEOM_ObjectListOfGO
 
typedef sequence< GEOM_BaseObjectListOfGBO
 
typedef sequence< GEOM_FieldListOfFields
 
typedef sequence< SALOMEDS::SObject > object_list
 

Enumerations

enum  shape_type {
  COMPOUND , COMPSOLID , SOLID , SHELL ,
  FACE , WIRE , EDGE , VERTEX ,
  SHAPE , FLAT
}
 Topological types of shapes (like Open Cascade types) More...
 
enum  marker_type {
  MT_NONE , MT_POINT , MT_PLUS , MT_STAR ,
  MT_X , MT_O , MT_O_POINT , MT_O_PLUS ,
  MT_O_STAR , MT_O_X , MT_RING1 , MT_RING2 ,
  MT_RING3 , MT_BALL , MT_USER
}
 Marker type. More...
 
enum  marker_size {
  MS_NONE , MS_10 , MS_15 , MS_20 ,
  MS_25 , MS_30 , MS_35 , MS_40 ,
  MS_45 , MS_50 , MS_55 , MS_60 ,
  MS_65 , MS_70
}
 
enum  shape_state {
  ST_ON , ST_OUT , ST_ONOUT , ST_IN ,
  ST_ONIN
}
 State of shape relatively geometrical surface like plane, sphere or cylinder. More...
 
enum  find_shape_method {
  FSM_GetInPlace , FSM_Transformed , FSM_GetSame , FSM_GetShapesOnShape ,
  FSM_GetInPlaceByHistory , FSM_MultiTransformed , FSM_GetInPlace_Old
}
 Kind of method to find inside one main shape some sub-shapes, corresponding to other given shape (its argument) More...
 
enum  filling_oper_method { FOM_Default , FOM_UseOri , FOM_AutoCorrect }
 Kind of method to perform filling operation. More...
 
enum  curve_type { Polyline , Bezier , Interpolation }
 Kind of the curves. More...
 
enum  field_data_type { FDT_Bool , FDT_Int , FDT_Double , FDT_String }
 Type of field data. More...
 
enum  si_check_level {
  SI_V_V , SI_V_E , SI_E_E , SI_V_F ,
  SI_E_F , SI_ALL
}
 This enumeration represents the level of checking shape on self-interference. More...
 
enum  comparison_condition { CC_GT , CC_GE , CC_LT , CC_LE }
 This enumeration represents comparison conditions. More...
 
enum  wire_build_mode { WBM_FixTolerance , WBM_Approximation , WBM_KeepCurveType }
 Wire construction mode. Regulates the way gaps are closed. More...
 
enum  length_unit {
  LU_INCH , LU_MILLIMETER , LU_FOOT , LU_MILE ,
  LU_METER , LU_KILOMETER , LU_MILLIINCH , LU_MICROMETER ,
  LU_CENTIMETER , LU_MICROINCH
}
 Units of length. More...
 

Typedef Documentation

◆ Parameters

typedef sequence<Parameter> Parameters

◆ CreationInformationSeq

◆ ModifStatistics

typedef sequence<ModifInfo> ModifStatistics

◆ string_array

typedef sequence<string> string_array

◆ short_array

typedef sequence<short> short_array

◆ ListOfBool

typedef sequence<boolean> ListOfBool

◆ ListOfLong

typedef sequence<long> ListOfLong

◆ ListOfDouble

typedef sequence<double> ListOfDouble

◆ ListOfListOfDouble

typedef sequence<ListOfDouble> ListOfListOfDouble

◆ ListOfListOfLong

typedef sequence<ListOfLong> ListOfListOfLong

◆ ListOfGO

typedef sequence<GEOM_Object> ListOfGO

◆ ListOfGBO

typedef sequence<GEOM_BaseObject> ListOfGBO

◆ ListOfFields

typedef sequence<GEOM_Field> ListOfFields

◆ object_list

typedef sequence<SALOMEDS::SObject> object_list

Enumeration Type Documentation

◆ shape_type

enum shape_type

Topological types of shapes (like Open Cascade types)

Enumerator
COMPOUND 

A collection of arbitrary shapes

COMPSOLID 

A collection of solids

SOLID 

A part of 3D space bound by a shell

SHELL 

A collection of faces connected by some edges of their wire boundaries

FACE 

Part of a plane (in 2D geometry) or a surface (in 3D geometry) bounded by a closed wire

WIRE 

A sequence of edges connected by their vertices

EDGE 

Edge, a shape corresponding to a curve, and bound by a vertex at each extremity

VERTEX 

A zero-dimensional shape corresponding to a point in geometry

SHAPE 

Arbitrary shape in a Compound (used for processing of Compounds in some operations)

FLAT 

Flat (top-level) contents of a Compound (used for processing of Compounds in some operations)

◆ marker_type

Marker type.

Enumerator
MT_NONE 
MT_POINT 
MT_PLUS 
MT_STAR 
MT_X 
MT_O 
MT_O_POINT 
MT_O_PLUS 
MT_O_STAR 
MT_O_X 
MT_RING1 
MT_RING2 
MT_RING3 
MT_BALL 
MT_USER 

◆ marker_size

/brief Marker size

Enumerator
MS_NONE 
MS_10 
MS_15 
MS_20 
MS_25 
MS_30 
MS_35 
MS_40 
MS_45 
MS_50 
MS_55 
MS_60 
MS_65 
MS_70 

◆ shape_state

State of shape relatively geometrical surface like plane, sphere or cylinder.

Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()

Enumerator
ST_ON 

Shape is on surface

ST_OUT 

Shape is in the direction defined by the normal and not on surface. For plane it means above the plane, For sphere and cylinder it means outside of volume, bounded by the surface.

ST_ONOUT 

Shape is in the direction defined by the normal and on surface. ONOUT = ON || OUT

ST_IN 

Complementary to ONOUT. For plane it means below the plane, For sphere and cylinder it means inside the volume, bounded by the surface (beyond axis and surface for cylinder and beyond cented and surface for sphere).

ST_ONIN 

Complementary to OUT. ONIN = ON || IN

◆ find_shape_method

Kind of method to find inside one main shape some sub-shapes, corresponding to other given shape (its argument)

Is used in functions GEOM_Gen.RestoreSubShapesO(), GEOM_Gen.RestoreSubShapesSO(), TransferNames()

Enumerator
FSM_GetInPlace 

Use GetInPlace functionality. Suits all cases, except transformations

FSM_Transformed 

To be used only for transformation result, to find sub-shapes of argument. Only this method can be used after transformation.

FSM_GetSame 

To find only shared sub-shapes, not modified by the operation

FSM_GetShapesOnShape 

Use GetShapesOnShape method (can work only on solids)

FSM_GetInPlaceByHistory 

Use GetInPlaceByHistory method (can work only after Partition)

FSM_MultiTransformed 

To be used only for multi-transformation result. Only this method can be used after multi-transformation.

FSM_GetInPlace_Old 

Use old GetInPlace functionality.

◆ filling_oper_method

Kind of method to perform filling operation.

Is used in functions GEOM_I3DPrimOperations.MakeFilling()

Enumerator
FOM_Default 

Default (standard behaviour)

FOM_UseOri 

Use edges orientation - orientation of edges is used: if the edge is reversed, the curve from this edge is reversed before using it in the filling algorithm.

FOM_AutoCorrect 

Auto-correct edges orientation - changes the orientation of the curves using minimization of sum of distances between the end points of the edges.

◆ curve_type

enum curve_type

Kind of the curves.

Used in the functions GEOM_ICurvesOperations.MakeCurveParametric(), GEOM_ICurvesOperations.MakeCurveParametricNew(), GEOM_ICurvesOperations.MakePolyline2D, GEOM_ICurvesOperations.MakePolyline2DOnPlane.

Enumerator
Polyline 

Polyline curve

Bezier 

Bezier curve

Interpolation 

Interpolation, curve

◆ field_data_type

Type of field data.

Enumerator
FDT_Bool 
FDT_Int 
FDT_Double 
FDT_String 

◆ si_check_level

This enumeration represents the level of checking shape on self-interference.

It defines which interferferences will be checked.

Enumerator
SI_V_V 
SI_V_E 
SI_E_E 
SI_V_F 
SI_E_F 
SI_ALL 

◆ comparison_condition

This enumeration represents comparison conditions.

Enumerator
CC_GT 

Greater then.

CC_GE 

Greater then or equal to.

CC_LT 

Less then.

CC_LE 

Less then or equal to.

◆ wire_build_mode

Wire construction mode. Regulates the way gaps are closed.

Is used in function GEOM_IShapesOperations.MakeWire()

Enumerator
WBM_FixTolerance 

Do not change curves, just enlarge wire tolerance to cover the gaps

WBM_Approximation 

Replace curves, neighbour to the gap, with BSplines, connecting in the middle of the gap

WBM_KeepCurveType 

Replace curves, neighbour to the gap, with new curves of the same type and close parameters, connecting in the middle of the gap

◆ length_unit

Units of length.

Enumerator
LU_INCH 
LU_MILLIMETER 
LU_FOOT 
LU_MILE 
LU_METER 
LU_KILOMETER 
LU_MILLIINCH 
LU_MICROMETER 
LU_CENTIMETER 
LU_MICROINCH