MotionLinks.createInput Method

Description

Creates a MotionLinkInput object, which is the API equivalent to the Motion Link command dialog. You can use methods and properties on the returned object to set the desired options, similar to providing input and setting options in the MotionLink command dialog. Once the settings are defined you call the MotionLinks.add method passing in the MotionLinkInput object to create the actual MotionLink.

Syntax

Python
C++

"motionLinks_var" is a variable referencing a MotionLinks object.

# Uses no optional arguments.
returnValue = motionLinks_var.createInput(jointOne)

# Uses optional arguments.
returnValue = motionLinks_var.createInput(jointOne, jointTwo)

"motionLinks_var" is a variable referencing a MotionLinks object.

#include <Fusion/Components/MotionLinks.h>

// Uses no optional arguments.
returnValue = motionLinks_var->createInput(jointOne);

// Uses optional arguments.
returnValue = motionLinks_var->createInput(jointOne, jointTwo);

Parameters

jointOne

Base

Inputs the first Joint or AsBuiltJoint to link its motion(s). If the jointTwo is set to null, then two motions from the jointOne will be linked, and in this case a valid Joint or AsBuiltJoint for jointOne should have its joint motion type of BallJointType, CylindricalJointType, PinSlotJointType or PlanarJointType. A Joint or AsBuiltJoint whose joint motion is a RigidJointMotion type is never valid as the first joint.

jointTwo

Base

Inputs the second Joint or AsBuiltJoint to link its motion. If this is set to null, then the two motions from the jointOne will be linked. A Joint or AsBuiltJoint whose joint motion is a RigidJointMotion type is never valid as the second joint.

This is an optional argument whose default value is null.

MotionLinks.createInput Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
MotionLinkInput	Returns the MotionLinkInput object or null if the creation failed.

Name	Type	Description
jointOne	Base	Inputs the first Joint or AsBuiltJoint to link its motion(s). If the jointTwo is set to null, then two motions from the jointOne will be linked, and in this case a valid Joint or AsBuiltJoint for jointOne should have its joint motion type of BallJointType, CylindricalJointType, PinSlotJointType or PlanarJointType. A Joint or AsBuiltJoint whose joint motion is a RigidJointMotion type is never valid as the first joint.
jointTwo	Base	Inputs the second Joint or AsBuiltJoint to link its motion. If this is set to null, then the two motions from the jointOne will be linked. A Joint or AsBuiltJoint whose joint motion is a RigidJointMotion type is never valid as the second joint. This is an optional argument whose default value is null.