Skip to Content
Python API ReferenceAPI DomainsToolpathTp Element

Tp Element

Quick Facts

PropertyValue
ClassCENPyOlpTpElement
Modulecenpylib.CENPyOlpTpElement
Packagecenpylib
ReleaseR2026.1.1
Methods26

Quick Start

# Boilerplate Example
tpElement = ...  # obtained from the runtime context
result = tpElement.GetName()

Query Methods

MethodReturnsSummary
GetNamestrGet the name of the toolpath element.
GetTrackCENPyOlpTrackGet the track corresponding to this toolpath element.
GetProcessTypeintGet the process type of the toolpath element.
GetMotionTypeintGet the motion type of the toolpath element.
GetTargetTypeintGets the target type of the underlying toolpath element.
GetConfigBehaviorintGets the config behavior of the underlying toolpath element.
GetConfigUserStringstrGets the config user string of the underlying toolpath element.
GetTurnBehaviorintGets the turn behavior of the underlying toolpath element.
GetTurnUserStringstrGets the turn user string of the underlying toolpath element.
GetCollisionStatusintGets the collision status of the underlying toolpath element.
GetSimulationCollisionStatusintGets the collision status of the underlying toolpath element from the simulation.
GetReachabilityStatusintGets the reachability status of the underlying toolpath element.
GetSingularityStatusintGets the singularity status of the underlying toolpath element.
GetTeachFlagsintGets the teach flags indicating the modifications made to the underlying toolpath element.
GetMatrixCENPyOlpMatrixGets the current matrix of the toolpath element.
GetViaPointMatrixCENPyOlpMatrixGets the current matrix of the via point of the toolpath element.
GetInitialPathMatrixCENPyOlpMatrixGet the initial path matrix which has been saved after PathCompute but before AlignmentCompute.
GetInitialPathMatrixTranslatedInBaseFrameCENPyOlpMatrixGet the initial path matrix moved with the given coordinates relative to the specified base frame.
GetGlobalTransformedMatrixCENPyOlpMatrixGet the path matrix which has been saved after global transformation compute in aligned state.
GetGlobalTransformedMatrixUnalignedCENPyOlpMatrixGet the path matrix which has been saved after global transformation compute in unaligned state.
GetBaseFrameTransformedMatrixUnalignedCENPyOlpMatrixGets the matrix of the toolpath element on a GlobalTransformed compute state without alignment information with respect to base frame.
GetInitialNeighbourMatrixCENPyOlpMatrixGet the next or previous toolpath element, relative to the current one, within the current operation.
GetMatrixToActiveBaseFrameCENPyOlpMatrixGet the toolpath element matrix with respect to active (output) base frame.
GetMatrixToBaseFrameCENPyOlpMatrixGet the toolpath element matrix with respect to the given base frame index.
GetStateMatrixByTypeCENPyOlpMatrixGets the matrix of the toolpath element by compute state, with alignment and world-matrix options.

Mutation Methods

MethodReturnsSummary
SetName—Set the name of the toolpath element.

Changes in R2026.1.1

Compared to R2026.1:

  • Method count increased from 24 to 26

  • [NEW] GetViaPointMatrix: New method added

  • [NEW] GetStateMatrixByType: New method added

Version Notes

This class is documented as of release R2026.1.1.

Was this page helpful?
Teach HandlerTp Element — Mutation Methods