Joint.setAsSliderJointMotion Method

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

Description

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

"joint_var" is a variable referencing a Joint object.
# Uses no optional arguments.
returnValue = joint_var.setAsSliderJointMotion(sliderDirection)

# Uses optional arguments.
returnValue = joint_var.setAsSliderJointMotion(sliderDirection, customSliderDirectionEntity)
"joint_var" is a variable referencing a Joint object.

#include <Fusion/Components/Joint.h>

// Uses no optional arguments.
returnValue = joint_var->setAsSliderJointMotion(sliderDirection);

// Uses optional arguments.
returnValue = joint_var->setAsSliderJointMotion(sliderDirection, customSliderDirectionEntity);

Return Value

Type Description
boolean Returns true if the operation was successful.

Parameters

Name Type Description
sliderDirection JointDirections Specifies which axis the slide direction is along. If this is set to CustomJointDirection then the customSliderDirectionEntity argument must also be provided.
customSliderDirectionEntity Base If the sliderDirection is CustomJointDirection this argument is used to specify the entity that defines the custom slider 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 July 2015