DATAKIT API  V2025.1
util_kinematics_dtk.hpp File Reference

Go to the source code of this file.

Data Structures

class  Dtk_KinCommand
 Dtk_KinCommand represents a command to simulate a mechanism. More...
 
class  Dtk_KinConstraint
 Dtk_KinConstraint represents a constraint to define a joint. More...
 
class  Dtk_KinCurve
 Dtk_KinCurve represents a curve associated at a law. More...
 
class  Dtk_Kinematic
 Dtk_Kinematic represents a kinematic. More...
 
class  Dtk_KinFixPart
 Dtk_KinFixPart represents the fixed part to simulate the mechanism. More...
 
class  Dtk_KinFormula
 Dtk_KinFormula represents the formula defined the law. More...
 
class  Dtk_KinJoint
 Dtk_KinJoint represents a joint to define a mechanism. More...
 
class  Dtk_KinLaw
 Dtk_KinLaw represents a law associated at a command. More...
 
class  Dtk_KinMechanism
 Dtk_KinMechanism represents a kinematic mechanism. More...
 
class  Dtk_KinNamedValue
 Dtk_KinNamedValue represents a named value. More...
 
class  Dtk_KinParameter
 Dtk_KinParameter represents a kinematic parameter. More...
 
class  Dtk_KinProduct
 Dtk_KinProduct represents a kinematic product. More...
 
class  Dtk_KinSpeedAcceleration
 Dtk_KinSpeedAcceleration represents a mechanism speed/acceleration. More...
 

Typedefs

typedef Dtk_SmartPtr< Dtk_KinCommandDtk_KinCommandPtr
 
typedef Dtk_tab< Dtk_KinCommandPtrDtk_KinCommandTab
 
typedef Dtk_NodeConnector Dtk_KinConnector
 
typedef Dtk_NodeConnectorPtr Dtk_KinConnectorPtr
 
typedef Dtk_tab< Dtk_NodeConnectorPtrDtk_KinConnectorTab
 
typedef Dtk_SmartPtr< Dtk_KinConstraintDtk_KinConstraintPtr
 
typedef Dtk_tab< Dtk_KinConstraintPtrDtk_KinConstraintTab
 
typedef Dtk_SmartPtr< Dtk_KinCurveDtk_KinCurvePtr
 
typedef Dtk_tab< Dtk_KinCurvePtrDtk_KinCurveTab
 
typedef Dtk_SmartPtr< Dtk_KinematicDtk_KinematicPtr
 
typedef Dtk_SmartPtr< Dtk_KinFixPartDtk_KinFixPartPtr
 
typedef Dtk_SmartPtr< Dtk_KinFormulaDtk_KinFormulaPtr
 
typedef Dtk_SmartPtr< Dtk_KinJointDtk_KinJointPtr
 
typedef Dtk_tab< Dtk_KinJointPtrDtk_KinJointTab
 
typedef Dtk_SmartPtr< Dtk_KinLawDtk_KinLawPtr
 
typedef Dtk_tab< Dtk_KinLawPtrDtk_KinLawTab
 
typedef Dtk_SmartPtr< Dtk_KinMechanismDtk_KinMechanismPtr
 
typedef Dtk_tab< Dtk_KinMechanismPtrDtk_KinMechanismTab
 
typedef Dtk_SmartPtr< Dtk_KinNamedValueDtk_KinNamedValuePtr
 
typedef Dtk_SmartPtr< Dtk_KinParameterDtk_KinParameterPtr
 
typedef Dtk_tab< Dtk_KinParameterPtrDtk_KinParameterTab
 
typedef Dtk_Component Dtk_KinPart
 
typedef Dtk_ComponentPtr Dtk_KinPartPtr
 
typedef Dtk_tab< Dtk_ComponentPtrDtk_KinPartTab
 
typedef Dtk_SmartPtr< Dtk_KinProductDtk_KinProductPtr
 
typedef Dtk_tab< Dtk_KinProductPtrDtk_KinProductTab
 
typedef Dtk_SmartPtr< Dtk_KinSpeedAccelerationDtk_KinSpeedAccelerationPtr
 
typedef Dtk_tab< Dtk_KinSpeedAccelerationPtrDtk_KinSpeedAccelerationTab
 
typedef Dtk_tab< Dtk_pntDtk_PointTab
 
typedef Dtk_tab< Dtk_stringDtk_StringTab
 

Enumerations

enum  COMMAND_TYPE {
  KIN_CMD_NOTHING = 0, KIN_CMD_ANGLE = 1, KIN_CMD_LENGTH = 2, KIN_CMD_ANGLE_JOINT1 = 3,
  KIN_CMD_LENGTH_JOINT1 = 4, KIN_CMD_ANGLE_JOINT2 = 5, KIN_CMD_LENGTH_JOINT2 = 6
}
 Enum for the command type. More...
 
enum  DTK_KINEMATIC_TYPE {
  DTK_KIN_TYPE_UNKNOWN, DTK_KIN_TYPE_JOINT, DTK_KIN_TYPE_COMMAND, DTK_KIN_TYPE_MECHANISM,
  DTK_KIN_TYPE_LAW, DTK_KIN_TYPE_SPEED_ACCELERATION
}
 Enum for parameter father type. More...
 
enum  JOINT_TYPE {
  DTK_NOTHING = 0, DTK_PRISMATIC = 1, DTK_REVOLUTE = 2, DTK_RIGID = 10,
  DTK_SPHERICAL = 11, DTK_POINT_CURVE = 12, DTK_SLIDE_CURVE = 13, DTK_ROLL = 14,
  DTK_CYLINDRICAL = 15, DTK_UNIVERSAL_JOINT = 16, DTK_CV_JOINT = 17, DTK_GEAR = 18,
  DTK_RACK = 19, DTK_CABLE = 20, DTK_SCREW = 21, DTK_POINT_SURFACE = 22,
  DTK_PLANAR = 23
}
 Enum for the joints type. More...
 

Functions

Dtk_status Dtk_DeleteKinematics ()
 Delete the kinematic object. More...
 
Dtk_status Dtk_DumpKinematics (const Dtk_string &inFileName)
 Write Dump file. More...
 
Dtk_KinematicPtr Dtk_GetKinematics ()
 Return the kinematic object. More...
 
void Dtk_SetKinematics (Dtk_KinematicPtr inKinematic)
 Set the kinematic object. More...
 
void DumpTransfo (FILE *inFile, Dtk_transfo transfo)
 

Typedef Documentation

◆ Dtk_KinCommandPtr

◆ Dtk_KinCommandTab

◆ Dtk_KinConnector

◆ Dtk_KinConnectorPtr

◆ Dtk_KinConnectorTab

◆ Dtk_KinConstraintPtr

◆ Dtk_KinConstraintTab

◆ Dtk_KinCurvePtr

◆ Dtk_KinCurveTab

◆ Dtk_KinematicPtr

◆ Dtk_KinFixPartPtr

◆ Dtk_KinFormulaPtr

◆ Dtk_KinJointPtr

◆ Dtk_KinJointTab

◆ Dtk_KinLawPtr

◆ Dtk_KinLawTab

◆ Dtk_KinMechanismPtr

◆ Dtk_KinMechanismTab

◆ Dtk_KinNamedValuePtr

◆ Dtk_KinParameterPtr

◆ Dtk_KinParameterTab

◆ Dtk_KinPart

◆ Dtk_KinPartPtr

◆ Dtk_KinPartTab

◆ Dtk_KinProductPtr

◆ Dtk_KinProductTab

◆ Dtk_KinSpeedAccelerationPtr

◆ Dtk_KinSpeedAccelerationTab

◆ Dtk_PointTab

◆ Dtk_StringTab

Enumeration Type Documentation

◆ COMMAND_TYPE

Enum for the command type.

Enumerator
KIN_CMD_NOTHING 
KIN_CMD_ANGLE 
KIN_CMD_LENGTH 
KIN_CMD_ANGLE_JOINT1 
KIN_CMD_LENGTH_JOINT1 
KIN_CMD_ANGLE_JOINT2 
KIN_CMD_LENGTH_JOINT2 
140 {
141  KIN_CMD_NOTHING = 0,
142  KIN_CMD_ANGLE = 1,
143  KIN_CMD_LENGTH = 2,
148 };

◆ DTK_KINEMATIC_TYPE

Enum for parameter father type.

Enumerator
DTK_KIN_TYPE_UNKNOWN 
DTK_KIN_TYPE_JOINT 
DTK_KIN_TYPE_COMMAND 
DTK_KIN_TYPE_MECHANISM 
DTK_KIN_TYPE_LAW 
DTK_KIN_TYPE_SPEED_ACCELERATION 

◆ JOINT_TYPE

enum JOINT_TYPE

Enum for the joints type.

Enumerator
DTK_NOTHING 
DTK_PRISMATIC 
DTK_REVOLUTE 
DTK_RIGID 
DTK_SPHERICAL 
DTK_POINT_CURVE 
DTK_SLIDE_CURVE 
DTK_ROLL 
DTK_CYLINDRICAL 
DTK_UNIVERSAL_JOINT 
DTK_CV_JOINT 
DTK_GEAR 
DTK_RACK 
DTK_CABLE 
DTK_SCREW 
DTK_POINT_SURFACE 
DTK_PLANAR 
118 {
119  DTK_NOTHING = 0,
120  DTK_PRISMATIC = 1,
121  DTK_REVOLUTE = 2,
122  DTK_RIGID = 10,
123  DTK_SPHERICAL = 11,
124  DTK_POINT_CURVE = 12,
125  DTK_SLIDE_CURVE = 13,
126  DTK_ROLL = 14,
127  DTK_CYLINDRICAL = 15,
128  DTK_UNIVERSAL_JOINT = 16,
129  DTK_CV_JOINT = 17,
130  DTK_GEAR = 18,
131  DTK_RACK = 19,
132  DTK_CABLE = 20,
133  DTK_SCREW = 21,
134  DTK_POINT_SURFACE = 22,
135  DTK_PLANAR = 23
136 };

Function Documentation

◆ DumpTransfo()

void DumpTransfo ( FILE *  inFile,
Dtk_transfo  transfo 
)
KIN_CMD_ANGLE_JOINT1
@ KIN_CMD_ANGLE_JOINT1
Definition: util_kinematics_dtk.hpp:144
DTK_SLIDE_CURVE
@ DTK_SLIDE_CURVE
Definition: util_kinematics_dtk.hpp:125
DTK_POINT_CURVE
@ DTK_POINT_CURVE
Definition: util_kinematics_dtk.hpp:124
DTK_REVOLUTE
@ DTK_REVOLUTE
Definition: util_kinematics_dtk.hpp:121
DTK_KIN_TYPE_LAW
@ DTK_KIN_TYPE_LAW
Definition: util_kinematics_dtk.hpp:112
DTK_NOTHING
@ DTK_NOTHING
Definition: util_kinematics_dtk.hpp:119
KIN_CMD_NOTHING
@ KIN_CMD_NOTHING
Definition: util_kinematics_dtk.hpp:141
DTK_PLANAR
@ DTK_PLANAR
Definition: util_kinematics_dtk.hpp:135
DTK_CV_JOINT
@ DTK_CV_JOINT
Definition: util_kinematics_dtk.hpp:129
DTK_PRISMATIC
@ DTK_PRISMATIC
Definition: util_kinematics_dtk.hpp:120
DTK_KIN_TYPE_JOINT
@ DTK_KIN_TYPE_JOINT
Definition: util_kinematics_dtk.hpp:109
DTK_KIN_TYPE_UNKNOWN
@ DTK_KIN_TYPE_UNKNOWN
Definition: util_kinematics_dtk.hpp:108
KIN_CMD_LENGTH_JOINT1
@ KIN_CMD_LENGTH_JOINT1
Definition: util_kinematics_dtk.hpp:145
KIN_CMD_LENGTH
@ KIN_CMD_LENGTH
Definition: util_kinematics_dtk.hpp:143
DTK_ROLL
@ DTK_ROLL
Definition: util_kinematics_dtk.hpp:126
KIN_CMD_ANGLE_JOINT2
@ KIN_CMD_ANGLE_JOINT2
Definition: util_kinematics_dtk.hpp:146
DTK_CABLE
@ DTK_CABLE
Definition: util_kinematics_dtk.hpp:132
DTK_SPHERICAL
@ DTK_SPHERICAL
Definition: util_kinematics_dtk.hpp:123
DTK_RACK
@ DTK_RACK
Definition: util_kinematics_dtk.hpp:131
DTK_UNIVERSAL_JOINT
@ DTK_UNIVERSAL_JOINT
Definition: util_kinematics_dtk.hpp:128
DTK_RIGID
@ DTK_RIGID
Definition: util_kinematics_dtk.hpp:122
DTK_SCREW
@ DTK_SCREW
Definition: util_kinematics_dtk.hpp:133
KIN_CMD_LENGTH_JOINT2
@ KIN_CMD_LENGTH_JOINT2
Definition: util_kinematics_dtk.hpp:147
DTK_KIN_TYPE_COMMAND
@ DTK_KIN_TYPE_COMMAND
Definition: util_kinematics_dtk.hpp:110
DTK_CYLINDRICAL
@ DTK_CYLINDRICAL
Definition: util_kinematics_dtk.hpp:127
DTK_KIN_TYPE_MECHANISM
@ DTK_KIN_TYPE_MECHANISM
Definition: util_kinematics_dtk.hpp:111
DTK_KIN_TYPE_SPEED_ACCELERATION
@ DTK_KIN_TYPE_SPEED_ACCELERATION
Definition: util_kinematics_dtk.hpp:113
DTK_GEAR
@ DTK_GEAR
Definition: util_kinematics_dtk.hpp:130
DTK_POINT_SURFACE
@ DTK_POINT_SURFACE
Definition: util_kinematics_dtk.hpp:134
KIN_CMD_ANGLE
@ KIN_CMD_ANGLE
Definition: util_kinematics_dtk.hpp:142