JointDefine Class

class NXOpen.Motion.JointDefine

Bases: NXOpen.TaggedObject

Represents a joint define object

New in version NX5.0.0.

Properties

Property Description
AxisType Returns or sets the axis type.
DisplCurveType Returns or sets the displacemnet curve type of a screw joint
DisplayScale Returns or sets the display scale
ExcludeRxConstraint Returns or sets the options of excluded rx constraint.
ExcludeRyConstraint Returns or sets the option of excluded ry constraint.
ExcludeRzConstraint Returns or sets the options of excluded rz constraint.
ExcludeXConstraint Returns or sets the options of excluded x constraint.
ExcludeYConstraint Returns or sets the options of excluded y constraint.
ExcludeZConstraint Returns or sets the options of excluded z constraint.
FirstCsys Returns or sets the CSYS of first link
FirstLink Returns or sets the first link object
FirstMatrix Returns or sets the matrix of first link
FirstOrientationType Returns or sets the first orientation type of joint
FirstOrigin Returns or sets the origin of first link
FirstVector Returns or sets the direction of first link
JointType Returns or sets the joint type
LimitsDefined Returns or sets the option of defining limits for joint
LowerLimitAngleExpression Returns the lower limit angular expression.
LowerLimitDefined Returns or sets the option of defining lower limit for joint
LowerLimitExpression Returns the lower limit expression.
MethodType Returns or sets the method type of a screw joint
Name Returns or sets the joint name
RatioType Returns or sets the ratio type of a screw joint
RotationAllowed Returns or sets the options of allowing rotation.
ScrewDisplCurveFunction Returns or sets the displacement curve function tag.
ScrewDisplCurveProfile Returns the displacement curve Profile.
ScrewRatioExpression Returns the screw ratio expression.
ScrewRatioProfile Returns the ratio Profile.
ScrewSplineFunction Returns or sets the spline function tag.
SecondCsys Returns or sets the csys of second link
SecondLink Returns or sets the second link
SecondMatrix Returns or sets the matrix of second link
SecondOrientationType Returns or sets the second orientation type of joint
SecondOrigin Returns or sets the origin of second link
SecondVector Returns or sets the direction of second link
SnapLinks Returns or sets the option of snap links
Tag Returns the Tag for this object.
TranslationAllowed Returns or sets the options of allowing rotation.
UpperLimitAngleExpression Returns the upper limit angular expression.
UpperLimitDefined Returns or sets the option of defining upper limit for joint
UpperLimitExpression Returns the upper limit expression.

Methods

Enumerations

JointDefineOrientationType Enumeration Defines the orientation type of joint
JointDefineScrewJointDisplCurveType Enumeration Defines the displacement curve type for screw joints
JointDefineScrewJointMethodType Enumeration Defines the method type of screw joints
JointDefineScrewJointRatioType Enumeration Defines the ratio type for screw joints
JointDefineType Enumeration Joint define type
JointDefineUniversalJointAxisType Enumeration Defines the axis type for universal joints

Property Detail

AxisType

JointDefine.AxisType

Returns or sets the axis type.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Universal < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature AxisType

Returns:
Return type:NXOpen.Motion.JointDefineUniversalJointAxisType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature AxisType

Parameters:axisType (NXOpen.Motion.JointDefineUniversalJointAxisType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

DisplCurveType

JointDefine.DisplCurveType

Returns or sets the displacemnet curve type of a screw joint

-------------------------------------

Getter Method

Signature DisplCurveType

Returns:
Return type:NXOpen.Motion.JointDefineScrewJointDisplCurveType

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplCurveType

Parameters:displCurveType (NXOpen.Motion.JointDefineScrewJointDisplCurveType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

DisplayScale

JointDefine.DisplayScale

Returns or sets the display scale

-------------------------------------

Getter Method

Signature DisplayScale

Returns:
Return type:float

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature DisplayScale

Parameters:displayScale (float) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeRxConstraint

JointDefine.ExcludeRxConstraint

Returns or sets the options of excluded rx constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeRxConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeRxConstraint

Parameters:excludeRxConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeRyConstraint

JointDefine.ExcludeRyConstraint

Returns or sets the option of excluded ry constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeRyConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeRyConstraint

Parameters:excludeRyConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeRzConstraint

JointDefine.ExcludeRzConstraint

Returns or sets the options of excluded rz constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeRzConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeRzConstraint

Parameters:excludeRzConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeXConstraint

JointDefine.ExcludeXConstraint

Returns or sets the options of excluded x constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeXConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeXConstraint

Parameters:excludeXConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeYConstraint

JointDefine.ExcludeYConstraint

Returns or sets the options of excluded y constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeYConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeYConstraint

Parameters:excludeYConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExcludeZConstraint

JointDefine.ExcludeZConstraint

Returns or sets the options of excluded z constraint.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Fixed < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature ExcludeZConstraint

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature ExcludeZConstraint

Parameters:excludeZConstraint (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstCsys

JointDefine.FirstCsys

Returns or sets the CSYS of first link

-------------------------------------

Getter Method

Signature FirstCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature FirstCsys

Parameters:csys1 (NXOpen.CoordinateSystem) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstMatrix

JointDefine.FirstMatrix

Returns or sets the matrix of first link

-------------------------------------

Getter Method

Signature FirstMatrix

Returns:
Return type:NXOpen.NXMatrix

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature FirstMatrix

Parameters:matrix1 (NXOpen.NXMatrix) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstOrientationType

JointDefine.FirstOrientationType

Returns or sets the first orientation type of joint

-------------------------------------

Getter Method

Signature FirstOrientationType

Returns:
Return type:NXOpen.Motion.JointDefineOrientationType

New in version NX8.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature FirstOrientationType

Parameters:orientationType (NXOpen.Motion.JointDefineOrientationType) –

New in version NX8.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstOrigin

JointDefine.FirstOrigin

Returns or sets the origin of first link

-------------------------------------

Getter Method

Signature FirstOrigin

Returns:
Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature FirstOrigin

Parameters:origin1 (NXOpen.Point) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

FirstVector

JointDefine.FirstVector

Returns or sets the direction of first link

-------------------------------------

Getter Method

Signature FirstVector

Returns:
Return type:NXOpen.Direction

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature FirstVector

Parameters:vector1 (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

JointType

JointDefine.JointType

Returns or sets the joint type

-------------------------------------

Getter Method

Signature JointType

Returns:
Return type:NXOpen.Motion.JointDefineType

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature JointType

Parameters:jointType (NXOpen.Motion.JointDefineType) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

LimitsDefined

JointDefine.LimitsDefined

Returns or sets the option of defining limits for joint

-------------------------------------

Getter Method

Signature LimitsDefined

Returns:
Return type:bool

New in version NX5.0.0.

Deprecated since version NX11.0.0: Use Motion.JointDefine.UpperLimitDefined() and Motion.JointDefine.LowerLimitDefined() instead.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature LimitsDefined

Parameters:limitsDefined (bool) –

New in version NX5.0.0.

Deprecated since version NX11.0.0: Use Motion.JointDefine.UpperLimitDefined() and Motion.JointDefine.LowerLimitDefined() instead.

License requirements: mechanisms (“MECHANISMS”)

LowerLimitAngleExpression

JointDefine.LowerLimitAngleExpression

Returns the lower limit angular expression.

Only used when limits option is TRUE

-------------------------------------

Getter Method

Signature LowerLimitAngleExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

LowerLimitDefined

JointDefine.LowerLimitDefined

Returns or sets the option of defining lower limit for joint

-------------------------------------

Getter Method

Signature LowerLimitDefined

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature LowerLimitDefined

Parameters:limitDefined (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

LowerLimitExpression

JointDefine.LowerLimitExpression

Returns the lower limit expression.

Only used when limits option is TRUE

-------------------------------------

Getter Method

Signature LowerLimitExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

MethodType

JointDefine.MethodType

Returns or sets the method type of a screw joint

-------------------------------------

Getter Method

Signature MethodType

Returns:
Return type:NXOpen.Motion.JointDefineScrewJointMethodType

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MethodType

Parameters:methodType (NXOpen.Motion.JointDefineScrewJointMethodType) –

New in version NX12.0.0.

License requirements: None.

Name

JointDefine.Name

Returns or sets the joint name

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Name

Parameters:jointName (str) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

RatioType

JointDefine.RatioType

Returns or sets the ratio type of a screw joint

-------------------------------------

Getter Method

Signature RatioType

Returns:
Return type:NXOpen.Motion.JointDefineScrewJointRatioType

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RatioType

Parameters:ratioType (NXOpen.Motion.JointDefineScrewJointRatioType) –

New in version NX12.0.0.

License requirements: None.

RotationAllowed

JointDefine.RotationAllowed

Returns or sets the options of allowing rotation.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Planar < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature RotationAllowed

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature RotationAllowed

Parameters:rotationAllowed (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ScrewDisplCurveFunction

JointDefine.ScrewDisplCurveFunction

Returns or sets the displacement curve function tag.

Only valid for Simcenter Solver if method type is Motion.JointDefineScrewJointMethodType.Displacementcurve

-------------------------------------

Getter Method

Signature ScrewDisplCurveFunction

Returns:
Return type:NXOpen.CAE.Function

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScrewDisplCurveFunction

Parameters:displCurveFunction (NXOpen.CAE.Function) –

New in version NX12.0.0.

License requirements: None.

ScrewDisplCurveProfile

JointDefine.ScrewDisplCurveProfile

Returns the displacement curve Profile.

-------------------------------------

Getter Method

Signature ScrewDisplCurveProfile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: None.

ScrewRatioExpression

JointDefine.ScrewRatioExpression

Returns the screw ratio expression.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Screw < Motion.JointDefineType>`. For Simcenter Solver, method type must be :py:class:` Motion.JointDefineScrewJointMethodType.Ratio < Motion.JointDefineScrewJointMethodType>` which is the pitch of a screw’s thread, and ratio type must be :py:class:` Motion.JointDefineScrewJointRatioType.Expression < Motion.JointDefineScrewJointRatioType>`

-------------------------------------

Getter Method

Signature ScrewRatioExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ScrewRatioProfile

JointDefine.ScrewRatioProfile

Returns the ratio Profile.

-------------------------------------

Getter Method

Signature ScrewRatioProfile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: None.

ScrewSplineFunction

JointDefine.ScrewSplineFunction

Returns or sets the spline function tag.

Only valid for LMS solver if method type is Motion.JointDefineScrewJointMethodType.Ratio, and ratio type is Motion.JointDefineScrewJointRatioType.Spline

-------------------------------------

Getter Method

Signature ScrewSplineFunction

Returns:
Return type:NXOpen.CAE.Function

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScrewSplineFunction

Parameters:splineFunction (NXOpen.CAE.Function) –

New in version NX12.0.0.

License requirements: None.

SecondCsys

JointDefine.SecondCsys

Returns or sets the csys of second link

-------------------------------------

Getter Method

Signature SecondCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature SecondCsys

Parameters:csys2 (NXOpen.CoordinateSystem) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondMatrix

JointDefine.SecondMatrix

Returns or sets the matrix of second link

-------------------------------------

Getter Method

Signature SecondMatrix

Returns:
Return type:NXOpen.NXMatrix

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature SecondMatrix

Parameters:matrix2 (NXOpen.NXMatrix) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondOrientationType

JointDefine.SecondOrientationType

Returns or sets the second orientation type of joint

-------------------------------------

Getter Method

Signature SecondOrientationType

Returns:
Return type:NXOpen.Motion.JointDefineOrientationType

New in version NX8.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature SecondOrientationType

Parameters:orientationType (NXOpen.Motion.JointDefineOrientationType) –

New in version NX8.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondOrigin

JointDefine.SecondOrigin

Returns or sets the origin of second link

-------------------------------------

Getter Method

Signature SecondOrigin

Returns:
Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature SecondOrigin

Parameters:origin2 (NXOpen.Point) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

SecondVector

JointDefine.SecondVector

Returns or sets the direction of second link

-------------------------------------

Getter Method

Signature SecondVector

Returns:
Return type:NXOpen.Direction

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature SecondVector

Parameters:vector2 (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

TranslationAllowed

JointDefine.TranslationAllowed

Returns or sets the options of allowing rotation.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Constantvelocity < Motion.JointDefineType>`

-------------------------------------

Getter Method

Signature TranslationAllowed

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature TranslationAllowed

Parameters:translationAllowed (bool) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

UpperLimitAngleExpression

JointDefine.UpperLimitAngleExpression

Returns the upper limit angular expression.

Only used when limits option is TRUE

-------------------------------------

Getter Method

Signature UpperLimitAngleExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

UpperLimitDefined

JointDefine.UpperLimitDefined

Returns or sets the option of defining upper limit for joint

-------------------------------------

Getter Method

Signature UpperLimitDefined

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature UpperLimitDefined

Parameters:limitDefined (bool) –

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

UpperLimitExpression

JointDefine.UpperLimitExpression

Returns the upper limit expression.

Only used when limits option is TRUE

-------------------------------------

Getter Method

Signature UpperLimitExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.