AsBuiltJoint.setAsPlanarJointMotion Method

Redefines the relationship between the two joint geometries as a planar 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.setAsPlanarJointMotion(normalDirection)

# Uses optional arguments.
returnValue = asBuiltJoint_var.setAsPlanarJointMotion(normalDirection, geometry, customNormalDirectionEntity, customPrimarySlideDirection)

"asBuiltJoint_var" is a variable referencing an AsBuiltJoint object.

#include <Fusion/Components/AsBuiltJoint.h>

// Uses no optional arguments.
returnValue = asBuiltJoint_var->setAsPlanarJointMotion(normalDirection);

// Uses optional arguments.
returnValue = asBuiltJoint_var->setAsPlanarJointMotion(normalDirection, geometry, customNormalDirectionEntity, customPrimarySlideDirection);

Parameters

normalDirection

JointDirections

Defines the direction of the normal of the single degree of rotation. This can be set to XAxisJointDirection, YAxisJointDirection, ZAxisJointDirection, or CustomJointDirection. If set to CustomJointDirection then the customNormalDirectionEntity 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.

customNormalDirectionEntity

Base

If the normalDirection is CustomJointDirection this argument is used to specify the entity that defines the direction of the normal. This can be several types of entities that can define a direction.

This is an optional argument whose default value is null.

customPrimarySlideDirection

Base

This arguments defines the direction of the primary slide direction. A default primary slide direction is automatically chosen and will be used if this argument is not provided or is null. The secondary slide direction is automatically inferred from the normal and primary slide directions.

This is an optional argument whose default value is null.

Type	Description
boolean	Returns true if the operation was successful.

AsBuiltJoint.setAsPlanarJointMotion Method

Description

Syntax

Return Value

Parameters

Version

Name	Type	Description
normalDirection	JointDirections	Defines the direction of the normal of the single degree of rotation. This can be set to XAxisJointDirection, YAxisJointDirection, ZAxisJointDirection, or CustomJointDirection. If set to CustomJointDirection then the customNormalDirectionEntity 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.
customNormalDirectionEntity	Base	If the normalDirection is CustomJointDirection this argument is used to specify the entity that defines the direction of the normal. This can be several types of entities that can define a direction. This is an optional argument whose default value is null.
customPrimarySlideDirection	Base	This arguments defines the direction of the primary slide direction. A default primary slide direction is automatically chosen and will be used if this argument is not provided or is null. The secondary slide direction is automatically inferred from the normal and primary slide directions. This is an optional argument whose default value is null.