gcm_routines.h File Reference

API of procedures and functions of 3D solver. More...

#include <math_define.h>
#include "gcm_constraint.h"
#include "gcm_manager.h"
#include "gcm_types.h"

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
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 non-editable 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 C3D-model. More...
size_t	VolumeOfAlignOption (const ItConstraintItem &)
	The number of alignment options (GCM_alignment) for a given mate.
GCM_tdof_record	GCM_PointDOF (GCM_system gSys, GCM_geom g, const MbCartPoint3D &ctrlPnt=MbCartPoint3D::origin)
	Evaluate degrees of freedom including their corresponding possible translations for a point of a geometric object in a system of constraints. More...
	GCT_FUNC (bool) CheckSatisfaction(GCM_system)
	Collect ill-conditioned part of the constraint system. More...
GCM_dof_estimation	GCM_FormalDOF (GCM_system gSys, GCM_geom g)
	Estimate from below and above the amount of formal degrees of freedom for a geometric object. It is defined by a minimal set of linearly independent parameters determining instanteneous motion of a rigid (constrained) body. More...
GCM_tdof_record	GCM_PureTDOF (GCM_system gSys, GCM_geom g)
	Compute pure translational degrees of freedom of a geometric object. Such degrees remains for a (constrained) body after eliminating any possibilities of rotation. More...

Detailed Description

API of procedures and functions of 3D solver.

Function Documentation

GCM_FormalDOF()

GCM_dof_estimation GCM_FormalDOF	(	GCM_system	gSys,
		GCM_geom	g
	)

Estimate from below and above the amount of formal degrees of freedom for a geometric object. It is defined by a minimal set of linearly independent parameters determining instanteneous motion of a rigid (constrained) body.

Parameters

[in]	gSys	- System of constraints.
[in]	g	- Descriptor of geometric object.

Returns

Quantitative estimation (lower and upper bounds with inclusion) on formal degrees of freedom.

Note

For testing purposes.

GCM_PureTDOF()

GCM_tdof_record GCM_PureTDOF	(	GCM_system	gSys,
		GCM_geom	g
	)

Compute pure translational degrees of freedom of a geometric object. Such degrees remains for a (constrained) body after eliminating any possibilities of rotation.

Parameters

[in]	gSys	- System of constraints.
[in]	g	- Descriptor of geometric object.

Returns

Record on evaluated pure translational degrees of freedom.

Note

For testing purposes.