Position

Quick Facts


# Boilerplate Example
position = ...  # obtained from the runtime context
result = position.GetCoordinates()

Method	Returns	Summary
`GetCoordinates`	`list`	Get all toolpath element coordinates.
`GetViaPointCoordinates`	`list`	Get all via point coordinates.
`GetOrientation`	`list`	Get all orientations.
`GetRefTpElement`	`CENPyOlpTpElement`	Get the reference toolpath element.
`GetPositionRelation`	`int`	Get the relation of the position.
`GetMatrix`	`CENPyOlpMatrix`	Get the represented toolpath element matrix.
`GetViaPointMatrix`	`CENPyOlpMatrix`	Get the represented via point matrix.
`GetViaPointName`	`str`	Get the name of the Via point if it exists, nullptr otherwise.
`GetJointValues`	`list`	Get all toolpath element joint values.
`GetExternalJointValues`	`list`	Get all toolpath element external joint values.

Method	Returns	Summary
`SetCoordinates`	`—`	Set all toolpath element coordinates.
`SetCoordinates`	`—`	Set all toolpath element coordinates using the list.
`SetViaPointCoordinates`	`—`	Set all via point coordinates.
`SetViaPointCoordinates`	`—`	Set all via point coordinates using the list.
`SetOrientation`	`—`	Set all orientations.
`SetOrientation`	`—`	Set all orientations using the list.
`SetRefTpElement`	`—`	Set the reference toolpath element.
`SetPositionRelation`	`—`	Set the new relation for the position.
`SetPositionRelation`	`—`	Set the position relation to Base frame and the base frame index.
`SetJointValues`	`—`	Set all toolpath element joint values.
`SetExternalJointValues`	`—`	Set all toolpath element external joint values.

Method	Returns	Summary
`X`	`float`	Get X coordinate.
`Y`	`float`	Get Y coordinate.
`Z`	`float`	Get Z coordinate.
`RX`	`float`	Get Rx orientation.
`RY`	`float`	Get Ry orientation.
`RZ`	`float`	Get Rz orientation.
`TranslatePosition`	`—`	Translates the toolpath element position locally in given direction.
`TranslatePosition`	`—`	Translates the toolpath element position locally in given direction relative to the base frame, specified by its index.
`TranslateViaPointPosition`	`—`	Translates the via point position locally in given direction.
`TranslateViaPointPosition`	`—`	Translates the via point position locally in given direction relative to the base frame, specified by its index.
`RotatePosition`	`—`	Rotates the position locally around given direction.
`RotatePosition`	`—`	Rotates the position locally around given direction relative to the base frame, specified by its index.

This class is documented as of release R2026.1.1.

Was this page helpful?