Joint.setAsBallJointMotion Method

Description

Redefines the relationship between the two joint geometries as a ball joint.

This method will fail in the case where the jointType property returns InferredJointType.

To use this method, you need to position the timeline marker to immediately before this joint. This can be accomplished using the following code: thisJoint.timelineObject.rollTo(True)

Syntax

Python
C++

"joint_var" is a variable referencing a Joint object.

# Uses no optional arguments.
returnValue = joint_var.setAsBallJointMotion(pitchDirection, yawDirection)

# Uses optional arguments.
returnValue = joint_var.setAsBallJointMotion(pitchDirection, yawDirection, customPitchDirection, customYawDirection)

"joint_var" is a variable referencing a Joint object.

#include <Fusion/Components/Joint.h>

// Uses no optional arguments.
returnValue = joint_var->setAsBallJointMotion(pitchDirection, yawDirection);

// Uses optional arguments.
returnValue = joint_var->setAsBallJointMotion(pitchDirection, yawDirection, customPitchDirection, customYawDirection);

Parameters

pitchDirection

JointDirections

Defines the direction the pitch angle is measured from. This can be ZAxisJointDirection or CustomJointDirection. If CustomJointDirection is specified then you must also provide a value for the customPitchDirection argument.

yawDirection

JointDirections

Defines the direction the yaw is measured from. This can be XAxisJointDirection or CustomJointDirection. If CustomJointDirection is specified then you must also provide a value for the customYawDirection argument.

customPitchDirection

Base

If the pitchDirection argument is customPitchDirection this argument is used to define the direction the pitch angel is measured from. This can be several types of entities that can define a direction.

This is an optional argument whose default value is null.

customYawDirection

Base

If the yawDirection argument is customPitchDirection this argument is used to define the direction the yaw angel is measured from. This can be several types of entities that can define a direction.

This is an optional argument whose default value is null.

Joint.setAsBallJointMotion Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
boolean	Returns true if the operation was successful.

Name	Type	Description
pitchDirection	JointDirections	Defines the direction the pitch angle is measured from. This can be ZAxisJointDirection or CustomJointDirection. If CustomJointDirection is specified then you must also provide a value for the customPitchDirection argument.
yawDirection	JointDirections	Defines the direction the yaw is measured from. This can be XAxisJointDirection or CustomJointDirection. If CustomJointDirection is specified then you must also provide a value for the customYawDirection argument.
customPitchDirection	Base	If the pitchDirection argument is customPitchDirection this argument is used to define the direction the pitch angel is measured from. This can be several types of entities that can define a direction. This is an optional argument whose default value is null.
customYawDirection	Base	If the yawDirection argument is customPitchDirection this argument is used to define the direction the yaw angel is measured from. This can be several types of entities that can define a direction. This is an optional argument whose default value is null.