C3D Toolkit
Kernel  117982, Vision  2.9.2.2

Classes  
struct  MtTransDof 
Record about the degree of freedom of movement. More...  
struct  MtMateParameters 
Parameters of proximity to solution for geometric constraint. More...  
struct  MtLDimensionTraits 
Characteristic data of linear dimension. More...  
struct  MtADimensionTraits 
Characteristic data of angular dimension. More...  
Functions  
GCM_result  WorseResult (GCM_result res1, GCM_result res2) 
Select "the worst" result code. More...  
GCM_result &  operator<< (GCM_result &sumRes, const GCM_result r) 
Summarize the resulting code. More...  
MtMateType  GetAutoMateType (const ItConstraintItem &cItem, bool forMove) 
Automatically assign the mate type for its arguments. More...  
bool  GetClosestParameters (const ItConstraintItem &cItem, MtMateParameters &cPars) 
Measure parameters of proximity to solution for geometric constraint. More...  
bool  GetDimensionTraits (const ItConstraintItem &dCon, MtLDimensionTraits &dPars) 
Determine the characteristic data of dimension. More...  
bool  GetDimensionTraits (const ItConstraintItem &dCon, MtADimensionTraits &dPars) 
Determine the characteristic data of angular dimension. More...  
bool  EstimateTangencyChoice (const ItConstraintItem &cItem, GCM_tan_choice tChoice) 
Whether it is possible to apply the variant of tangency to this constraint. More...  
bool  IsCompatibleMatingGeometry (const ItConstraintItem &cItem) 
Determine the compatibility of geometric objects to this constraint. More...  
bool  GCM_RelativePlacement (MbPlacement3D gPlaces[], size_t gPlacesSize, GCM_extra_param) 
Calculate "Relative placement". More...  
bool  GetMatingGeometry (const ItConstraintItem &cItem, int geomNb, bool inWCS, MtGeomType &gType, MbCartPoint3D &pc, MbVector3D &vec, double &r1, double &r2) 
Get the first or second geometric object of mate. More...  
MtGeomVariant  GCM_GeomArgument (const MbSpaceItem *, bool orient) 
Get a geometric object of type MtGeomVariant from geometry of type MbSpaceItem. More...  
void  GCM_GetProperties (GCM_system gSys, MbProperties &props) 
Get a list of editable and noneditable properties for the entire constraint system. More...  
GCM_result  GCM_DiagnoseHistoryDependent (GCM_system gSys, const ItGeom *gPtr) 
Specific diagnostics of a geometric object dependent on the construction history. More...  
void  GCM_ImportToC3D (GCM_system gSys, const TCHAR *c3dFile) 
Import the constraint system into C3Dmodel. More...  
size_t  VolumeOfAlignOption (const ItConstraintItem &) 
The number of alignment options (GCM_alignment) for a given mate.  

inline 
Select "the worst" result code.
The function selects from two error messages, something that needs attention before another error.

inline 
Summarize the resulting code.
The operator selects from stream of error messages, something that needs attention before anything else.
MtMateType GetAutoMateType  (  const ItConstraintItem &  cItem, 
bool  forMove  
) 
Automatically assign the mate type for its arguments.
cItem[in]   Geometric constraint with unknown type: mct_Unknown (see #MtMateType). 
forMove[in]   The evaluation method for solids with the behavior of moving or expression. 
The unknown mate cItem of this feature is considered as a pair
of objects of mate for which to select the most suitable variant for connection. For example: for the two cylinders it is coaxiality. The flag forMove helps to determine variant of connections to the most natural behavior in dynamic changing objects (for example: the mouse cursor).
bool GetClosestParameters  (  const ItConstraintItem &  cItem, 
MtMateParameters &  cPars  
) 
Measure parameters of proximity to solution for geometric constraint.
[in]  cItem   Considered constraint. 
[out]  cPars   The resulting evaluation parameters. 
The mate ItConstraintItem is characterized by integer and real parameters (alignment option and size). The function GetClosestParameters calculates the state of parameters in which the mate would be satisfied or the closest to the solution.
bool GetDimensionTraits  (  const ItConstraintItem &  dCon, 
MtLDimensionTraits &  dPars  
) 
Determine the characteristic data of dimension.
[in]  dCon   Dimensional geometric constraint. 
[out]  dPars   Structure of the characteristic parameters of dimension. 
bool GetDimensionTraits  (  const ItConstraintItem &  dCon, 
MtADimensionTraits &  dPars  
) 
Determine the characteristic data of angular dimension.
[in]  dCon   Dimensional geometric constraint. 
[out]  dPars   Structure of the characteristic parameters of dimension. 
bool EstimateTangencyChoice  (  const ItConstraintItem &  cItem, 
GCM_tan_choice  tChoice  
) 
Whether it is possible to apply the variant of tangency to this constraint.
[in]  cItem   Mate which carries a pair of mating objects or at least one (first or second). 
[in]  tChoice   Tangency variant which was to be applied to mate cItem. 
bool IsCompatibleMatingGeometry  (  const ItConstraintItem &  cItem  ) 
Determine the compatibility of geometric objects to this constraint.
If in the constraint given the first and second mating objects, then a function provides about the possibility mating of given geometric objects, otherwise if only one of the objects (either first or second) is given in the mate, then function provides for the applicability of this geometric object for the given mate.
bool GCM_RelativePlacement  (  MbPlacement3D  gPlaces[], 
size_t  gPlacesSize,  
GCM_extra_param  
) 
Calculate "Relative placement".
The function implements a type of GCM_dependent_func considering dependency g1 = f( g2, g3, g4 ), namely calculates placement of first geom (g1) that is related to second geom (g2) in same way as g3 was placed relative to g4. In this way, g1 is dependent on others.
[in]  gPlaces   Array of current placements of geometric objects g1, g2 .. g4. 
[out]  gPlaces   Calculated placement of first geom g1 (it is returned to the element gPlaces[0]). 
[in]  gPlacesSize   Known size of received array gPlaces. 
bool GetMatingGeometry  (  const ItConstraintItem &  cItem, 
int  geomNb,  
bool  inWCS,  
MtGeomType &  gType,  
MbCartPoint3D &  pc,  
MbVector3D &  vec,  
double &  r1,  
double &  r2  
) 
Get the first or second geometric object of mate.
[in]  cItem   Geometric constraint. 
[in]  geomNb   1st or 2nd index of geometric object. 
[in]  inWCS   If = true, then the function returns object given in GCS otherwise in LCS of 1st or 2nd solid respectively. 
[out]  gType   A type of geometric object. 
pc,vec,r1,r2   A tuple of object parameters (described below). 
MtGeomVariant GCM_GeomArgument  (  const MbSpaceItem *  , 
bool  orient  
) 
Get a geometric object of type MtGeomVariant from geometry of type MbSpaceItem.
The function extracts geometry data of the solver type from geometric object presented class MbSpaceItem.
void GCM_GetProperties  (  GCM_system  gSys, 
MbProperties &  props  
) 
Get a list of editable and noneditable properties for the entire constraint system.
GCM_result GCM_DiagnoseHistoryDependent  (  GCM_system  gSys, 
const ItGeom *  gPtr  
) 
Specific diagnostics of a geometric object dependent on the construction history.
[in]  gSys   The system of geometric constraints in which the diagnostic object 'gPtr' is evaluated. 
[in]  gPtr   A pointer to a CAD model object whose current state is computed in the build history of the CAD assembly. 
The APIcall is aimed at diagnosing a geometric object which at the same time subordinate to the CADassembly built history and at the same time evaluated in the constraint system. The algorithm detects the situation when the current state of the historybased object contradicts the state evaluated in the solver. The result of the call is an error code that is distributed to all adjacent constraints inherited from ItConstraintItem inside the application.
void GCM_ImportToC3D  (  GCM_system  gSys, 
const TCHAR *  c3dFile  
) 
Import the constraint system into C3Dmodel.
The algorithm of import recognises a framework structures in the constraint system and writes their into C3D model format. The recognized structures are converted into wireframe representation (see MbWireFrame).