JointInput.setAsSliderJointMotion Method

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

Description

Defines the relationship between the two joint geometries as a slider joint.

Syntax

"jointInput_var" is a variable referencing a JointInput object.

# Uses no optional arguments.
returnValue = jointInput_var.setAsSliderJointMotion(sliderDirection)

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

#include <Fusion/Components/JointInput.h>

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

// Uses optional arguments.
returnValue = jointInput_var->setAsSliderJointMotion(sliderDirection, customSliderDirectionEntity);
"jointInput_var" is a variable referencing a JointInput object.

// Uses no optional arguments.
returnValue = jointInput_var.setAsSliderJointMotion(sliderDirection);

// Uses Optional arguments.
returnValue = jointInput_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.

Samples

Name Description
BallJointMotion API Sample

Demonstrates creating a joint with ball joint motion.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.
Pin Slot Joint Motion API Sample

Demonstrates creating a joint with pin slot joint motion.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.
Planar Joint Motion API Sample

Demonstrates creating a joint with planar joint motion.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.
SliderJointMotion API Sample

Demonstrates creating a joint with slider joint motion.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Version

Introduced in version July 2015