JointDefine Class

class NXOpen.Motion.JointDefine

Bases: NXOpen.TaggedObject

Represents a joint define object

New in version NX5.0.0.

Properties

Property Description
DisplayScale Returns or sets the display scale
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
LowerLimit Returns or sets the lower limit.
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.
Name Returns or sets the joint name
ScrewRatio Returns or sets the screw ratio.
ScrewRatioExpression Returns the screw ratio expression.
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.
UpperLimit Returns or sets the upper limit.
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
JointDefineType Enumeration Joint define type

Property Detail

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(displayScale)

Parameters:displayScale (float) –

New in version NX5.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(csys1)

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(matrix1)

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(orientationType)

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(origin1)

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(vector1)

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(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(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”)

LowerLimit

JointDefine.LowerLimit

Returns or sets the lower limit.

Only used when limits option is TRUE

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

Getter Method

Signature LowerLimit()

Returns:
Return type:float

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.LowerLimitExpression() or Motion.JointDefine.LowerLimitAngleExpression() to query or edit it.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature LowerLimit(lowerLimit)

Parameters:lowerLimit (float) –

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.LowerLimitExpression() or Motion.JointDefine.LowerLimitAngleExpression() to query or edit it.

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(limitDefined)

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.

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(jointName)

Parameters:jointName (str) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

ScrewRatio

JointDefine.ScrewRatio

Returns or sets the screw ratio.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Screw < Motion.JointDefineType>`, which is the pitch of a screw’s thread

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

Getter Method

Signature ScrewRatio()

Returns:
Return type:float

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.ScrewRatioExpression() to query or edit it.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ScrewRatio(screwRatio)

Parameters:screwRatio (float) –

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.ScrewRatioExpression() to query or edit it.

License requirements: mechanisms (“MECHANISMS”)

ScrewRatioExpression

JointDefine.ScrewRatioExpression

Returns the screw ratio expression.

Used only when joint subtype is :py:class:` Motion.JointDefineType.Screw < Motion.JointDefineType>`, which is the pitch of a screw’s thread

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

Getter Method

Signature ScrewRatioExpression()

Returns:
Return type:NXOpen.Expression

New in version NX8.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(csys2)

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(matrix2)

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(orientationType)

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(origin2)

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(vector2)

Parameters:vector2 (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: mechanisms (“MECHANISMS”)

UpperLimit

JointDefine.UpperLimit

Returns or sets the upper limit.

Only used when limits option is TRUE

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

Getter Method

Signature UpperLimit()

Returns:
Return type:float

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.UpperLimitExpression() or Motion.JointDefine.UpperLimitAngleExpression() to query or edit it.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature UpperLimit(upperLimit)

Parameters:upperLimit (float) –

New in version NX5.0.0.

Deprecated since version NX8.0.0: Obtain the expression using Motion.JointDefine.UpperLimitExpression() or Motion.JointDefine.UpperLimitAngleExpression() to query or edit it.

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(limitDefined)

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.