All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATKinMechanismUseItf Interface CATIKinematicsMechEdit

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIKinematicsMechEdit

Method Index

o AddKinCommand(CATIEngConnection_var,CATIKinematicsCommand_var&,CATKinematicsCommandType*): Creates a new kinematics command in a mechanism.
o AttachEngConnection(CATIEngConnection_var): Adds a new joint in a mechanism.
o DetachEngConnection(CATIEngConnection_var): Detaches a joint from a mechanism.
o GetEngConnectionInfo(CATIEngConnection_var,CATKinematicsCommandType[2]): Gives some information regarding the engineering connection aka joint.
o InitializeMechanism(): This method initializes the mechanism with all the joints and all the commands.
o RemoveKinCommand(CATIKinematicsCommand_var): Removes a kinematics command in the mechanism .

Methods

o AddKinCommand

public virtual AddKinCommand(	const	`iJoint`,
		`oCmd`,
	const	`ipCmdType`	`= NULL` )

Creates a new kinematics command in a mechanism.

Parameters:

iJoint: The joint supporting the command.
oCmd: The created command.
ipCmdType: The type of the command to create. By default this value is NULL. In this case it is no necessary to precise the type.

See also:

o AttachEngConnection

public virtual AttachEngConnection( const iJoint)

Adds a new joint in a mechanism.

Parameters:

iJoint: The joint which will be attached to the mechanism

See also:

o DetachEngConnection

public virtual DetachEngConnection( const iJoint)

Detaches a joint from a mechanism.

Parameters:

iJoint: The Joint to remove.

See also:

o GetEngConnectionInfo

public virtual GetEngConnectionInfo(	const	`iJoint`,
		`oTab`)

Gives some information regarding the engineering connection aka joint.

Parameters:

iJoint: The joint supporting the command.
oTab[2]: It gives what kind of kinematics command can be created for this joint. The size of this array is 2 because it represents the maximum number of kinematics command which can create for a joint like a cylindrical joint for instance. If it t is no possible to create a command, the value will be equal to NoKinCommandType. The kinematics command creation implies to have a controlled constraint for the given engineering connection. Among all the controlled constraint type only the following types are supported: • Translation DOF: o distance between 2 planes • Rotation DOF : o Angle between 2 planes o Hinge between 2 planes plus 1 line

See also:

o InitializeMechanism

public virtual InitializeMechanism(

)

This method initializes the mechanism with all the joints and all the commands. It uses all the engineering connections available under the mechanism’s product. It is equivalent to what we can obtain in an interactive CATIA session when we create a mechanism

o RemoveKinCommand

public virtual RemoveKinCommand( const iCmd)

Removes a kinematics command in the mechanism .

Parameters:

iCommand: The Command to remove.

See also:

This object is included in the file: CATIKinematicsMechEdit.h
If needed, your Imakefile.mk should include the module: CATKinMechanismUseItf