AsBuiltJoint.setAsSliderJointMotion Method

Redefines the relationship between the two joint geometries as a slider 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.setAsSliderJointMotion(sliderDirection)

# Uses optional arguments.
returnValue = asBuiltJoint_var.setAsSliderJointMotion(sliderDirection, geometry, customSliderDirectionEntity)

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

#include <Fusion/Components/AsBuiltJoint.h>

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

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

Parameters

sliderDirection

JointDirections

Specifies which axis the slide direction is along. If this is set to CustomJointDirection then the customSliderDirectionEntity 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.

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.

Type	Description
boolean	Returns true if the operation was successful.

AsBuiltJoint.setAsSliderJointMotion Method

Description

Syntax

Return Value

Parameters

Version

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.
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.
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.