AsBuiltJoint.setAsPinSlotJointMotion Method

Parent Object: AsBuiltJoint
Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/AsBuiltJoint.h>

Description

Redefines the relationship between the two joint geometries as a pin-slot 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

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.
# Uses no optional arguments.
returnValue = asBuiltJoint_var.setAsPinSlotJointMotion(rotationAxis, slideDirection)

# Uses optional arguments.
returnValue = asBuiltJoint_var.setAsPinSlotJointMotion(rotationAxis, slideDirection, geometry, customRotationAxisEntity, customSlideDirectionEntity)
"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

#include <Fusion/Components/AsBuiltJoint.h>

// Uses no optional arguments.
returnValue = asBuiltJoint_var->setAsPinSlotJointMotion(rotationAxis, slideDirection);

// Uses optional arguments.
returnValue = asBuiltJoint_var->setAsPinSlotJointMotion(rotationAxis, slideDirection, geometry, customRotationAxisEntity, customSlideDirectionEntity);

Return Value

Type Description
boolean Returns true if the operation was successful.

Parameters

Name Type Description
rotationAxis JointDirections Specifies which axis the rotation is around. If this is set to CustomJointDirection then the customRotationAxisEntity argument must also be provided.
slideDirection JointDirections Specifies which axis the slide direction is along. If this is set to CustomJointDirection then the customSlideDirectionEntity argument must also be provided.
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.
customRotationAxisEntity Base If the rotationAxis is customAxisEntity this argument is used to specify the entity that defines the custom axis of rotation. This can be several types of entities that an axis can be derived

This is an optional argument whose default value is null.
customSlideDirectionEntity Base If the slideDirection is CustomJointDirection this argument is used to specify the entity that defines the custom slide direction. This can be several types of entities that can define a direction.

This is an optional argument whose default value is null.

Version

Introduced in version September 2015