C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

Geometric constraint. More...

#include <gcm_constraint.h>

+ Inheritance diagram for ItConstraintItem:

Public Member Functions

virtual GCM_alignment AlignType () const =0
 Condition of alignment.
 
virtual GCM_angle_type AngleType () const =0
 Kind of angular constraint ("3D" or "Planar").
 
virtual GCM_geom_axis AxisOfPlanarAngle () const =0
 Axis of angular mating specified in LCS of some solid. Only for planar kind of constraint.
 
virtual MbVector3D AxisOf3DAngle () const
 Axis of angular mating with king GCM_3D_ANGLE. More...
 
virtual GCM_c_type ConstraintType () const =0
 Type of geometric constraint.
 
virtual GCM_result ErrorCode () const =0
 Diagnostic error code attached to this constraint.
 
virtual VERSION Version () const =0
 The version of mathematical kernel in which the mating was created.

 
virtual double DimParameter () const =0
 Numerical parameter of the dimensional constraint. More...
 
virtual GCM_tan_choice TangencyChoice () const =0
 Variant of tangency for constraint of type 'GCM_TANGENT'.
 
ItGeomPtr DependentGeom () const
 Dependent geom of type GCM_DEPENDENT, it is always first geom item.
 
virtual GCM_dependent_func Function () const
 Callback function which defines a law of positioning of the first geometric object which is dependent on positions of other objects.
 
virtual ItGeomPtr GeomItem (int geomN) const =0
 Mating object of the constraint by a number of an argument . More...
 
MtArgument GeomArg (int geomN) const
 Geometric argument of the constraint. More...
 
MtGeomVariant SubGeom (int geomNb) const
 Geometric value of the argument, given in LCS of a "mating" object GeomItem(geomN). More...
 
virtual int Arity () const
 Number of geoms involved in the constraint.
 
virtual void SetErrorCode (MtResultCode3D)=0
 Specify error code for unsatisfied mating.
 
virtual void SetAxisOf3DAngle (const MbVector3D &axis)
 Specify the axis for angular mating with three-dimensional type of dimension (GCM_3D_ANGLE). More...
 

Detailed Description

Geometric constraint.

Abstract class or data structure of geometric constraint. Class ItConstraintItem can be implemented as a client application, it is used as interface via which the solver receives data about a constraint from a geometric model of CAD-system. Besides, pointer ItConstraintItem* in the solver MtGeomSolver is considered as data type "constraint", its value uniquely identifies a certain constraint during program run-time. Instance of class ItConstraintItem can be implemented both inside the solver and in a client application.

Member Function Documentation

◆ AxisOf3DAngle()

virtual MbVector3D ItConstraintItem::AxisOf3DAngle ( ) const
inlinevirtual

Axis of angular mating with king GCM_3D_ANGLE.

The function gives a vector of the rotation axis for angular dimension with 3D-kind. The vector is assigned in local coordinates of the first object, GeomItem(1).

◆ DimParameter()

virtual double ItConstraintItem::DimParameter ( ) const
pure virtual

Numerical parameter of the dimensional constraint.

If the dimensional constraint is angular, then the returning parameter is specified in radians.

Implemented in MtBoxConstraint.

◆ GeomItem()

virtual ItGeomPtr ItConstraintItem::GeomItem ( int  geomN) const
pure virtual

Mating object of the constraint by a number of an argument .

Parameters
geomN- Number of geom argument from 1 and greater.
Returns
Mating object calculating in the constraint system.

Implemented in MtBoxConstraint.

◆ GeomArg()

MtArgument ItConstraintItem::GeomArg ( int  geomN) const
inline

Geometric argument of the constraint.

The function gives a geometric argument of the constraint by a number from 1 up to Arity().

Parameters
geomN- Number of argument from 1 and greater.
Returns
Object which value is considered as argument of the constraint.

◆ SubGeom()

MtGeomVariant ItConstraintItem::SubGeom ( int  geomNb) const
inline

Geometric value of the argument, given in LCS of a "mating" object GeomItem(geomN).

The function gives a geometric value of an object which the constraint refer to. Given object specified in local CS of the mating solid, which is returned by GeomItem() func. Namely, solid GeomItem(geomN) is a subject of the evaluation, and a sub-geom specify suborinated object of mate, belonging the solid. (see ItConstraintItem::GeomItem).

Parameters
geomNb- Number of argument from 1 and greater.
Returns
Object which value is considered as argument of the constraint.

◆ SetAxisOf3DAngle()

virtual void ItConstraintItem::SetAxisOf3DAngle ( const MbVector3D axis)
inlinevirtual

Specify the axis for angular mating with three-dimensional type of dimension (GCM_3D_ANGLE).

Note
The axis is specified and stored in CS of the first object, solid given by GeomItem(1).

The documentation for this struct was generated from the following file: