AsBuiltJoint.setAsCylindricalJointMotion Method

Redefines the relationship between the two joint geometries as a cylindrical 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.setAsCylindricalJointMotion(rotationAxis)

# Uses optional arguments.
returnValue = asBuiltJoint_var.setAsCylindricalJointMotion(rotationAxis, geometry, customRotationAxisEntity)

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

#include <Fusion/Components/AsBuiltJoint.h>

// Uses no optional arguments.
returnValue = asBuiltJoint_var->setAsCylindricalJointMotion(rotationAxis);

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

Parameters

rotationAxis

JointDirections

Specifies which axis the rotation is around. If this is set to CustomJointDirection then the customRotationAxisEntity 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 from.

This is an optional argument whose default value is null.

Type	Description
boolean	Returns true if the operation was successful.

AsBuiltJoint.setAsCylindricalJointMotion Method

Description

Syntax

Return Value

Parameters

Version

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.
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 from. This is an optional argument whose default value is null.