AsBuiltJoint.setAsBallJointMotion Method

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

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

Syntax

Python
C++

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

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

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

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

#include <Fusion/Components/AsBuiltJoint.h>

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

// Uses optional arguments.
returnValue = asBuiltJoint_var->setAsBallJointMotion(pitchDirection, yawDirection, geometry, 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.

geometry

JointGeometry

Redefines the joint geometry. If not provided, the existing geometry is used. This argument is required if the current joint motion is rigid.

This is an optional argument whose default value is null.

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.

Type	Description
boolean	Returns true if the operation was successful.

AsBuiltJoint.setAsBallJointMotion Method

Description

Syntax

Return Value

Parameters

Version

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.
geometry	JointGeometry	Redefines the joint geometry. If not provided, the existing geometry is used. This argument is required if the current joint motion is rigid. This is an optional argument whose default value is null.
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.