Interpolation Handler

Quick Facts

Property	Value
Class	`CENPyOlpInterpolationHandler`
Module	`cenpylib.CENPyOlpInterpolationHandler`
Package	`cenpylib`
Release	R2025.2.4
Methods	14

Quick Start


# Boilerplate Example
interpolationHandler = ...  # obtained from the runtime context
result = interpolationHandler.IsInterpolated(tpElement, 0)

Method Index

Method	Returns	Summary
`CreatePathInterpolation`	`int`	Create path interpolations between given toolpath elements.
`DeletePathInterpolation`	`int`	Delete path interpolations between given toolpath elements.
`SwitchPathInterpolationType`	`int`	Switch path interpolations types for given toolpath elements between Relative and Absolute,
`AddPathInterpolationSupport`	`int`	Add given toolpath element as support for the specified types of path interpolations.
`RemovePathInterpolationSupport`	`int`	Remove given toolpath element as support for the specified types of path interpolations.
`CreateSurfaceInterpolation`	`int`	Create surface interpolations between given toolpath tracks.
`DeleteSurfaceInterpolation`	`int`	Delete surface interpolations between given toolpath tracks.
`SwitchSurfaceInterpolationType`	`int`	Switch surface interpolations types for given toolpath tracks between Relative and Absolute,
`AddSurfaceInterpolationSupport`	`int`	Add given toolpath track as support for the specified types of surface interpolations.
`RemoveSurfaceInterpolationSupport`	`int`	Remove given toolpath track as support for the specified types of surface interpolations.
`IsInterpolated`	`bool`	Check whether or not the given toolpath element has the path interpolation of the given type.
`IsInterpolated`	`bool`	Check whether or not the given track has the surface interpolation of the given type.
`IsSupport`	`bool`	Check whether or not the given toolpath element is a support of any kind for a particular interpolation type.
`IsSupport`	`bool`	Check whether or not the given track is a support of any kind for a particular interpolation type.

Lifecycle

`CreatePathInterpolation`


def CreatePathInterpolation(startTpElement: CENPyOlpTpElement, endTpElement: CENPyOlpTpElement, types: list) -> int

Create path interpolations between given toolpath elements.

Parameters:

Name	Type	Description
`startTpElement`	`CENPyOlpTpElement`	Start toolpath element.
`endTpElement`	`CENPyOlpTpElement`	End toolpath element.
`types`	`list`	One or more types of interpolation to create.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`CreateSurfaceInterpolation`


def CreateSurfaceInterpolation(startTrack: CENPyOlpTrack, endTrack: CENPyOlpTrack, types: list) -> int

Create surface interpolations between given toolpath tracks.

Parameters:

Name	Type	Description
`startTrack`	`CENPyOlpTrack`	Start track.
`endTrack`	`CENPyOlpTrack`	End track.
`types`	`list`	One or more types of interpolation to create.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

Query Methods

`IsInterpolated`


def IsInterpolated(tpElement: CENPyOlpTpElement, type: int) -> bool

Check whether or not the given toolpath element has the path interpolation of the given type.

Parameters:

Name	Type	Description
`tpElement`	`CENPyOlpTpElement`	Reference toolpath element.
`type`	`int`	Type of interpolation to check for.

Returns: bool — True if the toolpath element has interpolation of the given type, otherwise False.

`IsInterpolated`


def IsInterpolated(track: CENPyOlpTrack, type: int) -> bool

Check whether or not the given track has the surface interpolation of the given type. Track is considered as interpolated if its event based start toolpath element has interpolation.

Parameters:

Name	Type	Description
`track`	`CENPyOlpTrack`	Reference track.
`type`	`int`	Type of interpolation to check for.

Returns: bool — True if the toolpath element has interpolation of the given type, otherwise False.

`IsSupport`


def IsSupport(tpElement: CENPyOlpTpElement, type: int) -> bool

Check whether or not the given toolpath element is a support of any kind for a particular interpolation type.

Parameters:

Name	Type	Description
`tpElement`	`CENPyOlpTpElement`	Reference toolpath element.
`type`	`int`	Type of interpolation to check for.

Returns: bool — True if the toolpath element is a support, otherwise False.

`IsSupport`


def IsSupport(track: CENPyOlpTrack, type: int) -> bool

Check whether or not the given track is a support of any kind for a particular interpolation type. Track is considered as a support if its event based start toolpath element is a support.

Parameters:

Name	Type	Description
`track`	`CENPyOlpTrack`	Reference toolpath element.
`type`	`int`	Type of interpolation to check for.

Returns: bool — True if the track is a support, otherwise False.

Mutation Methods

`DeletePathInterpolation`


def DeletePathInterpolation(startTpElement: CENPyOlpTpElement, endTpElement: CENPyOlpTpElement, types: list) -> int

Delete path interpolations between given toolpath elements.

Parameters:

Name	Type	Description
`startTpElement`	`CENPyOlpTpElement`	Start toolpath element.
`endTpElement`	`CENPyOlpTpElement`	End toolpath element.
`types`	`list`	One or more types of interpolation to delete.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`AddPathInterpolationSupport`


def AddPathInterpolationSupport(tpElement: CENPyOlpTpElement, types: list) -> int

Add given toolpath element as support for the specified types of path interpolations.

Parameters:

Name	Type	Description
`tpElement`	`CENPyOlpTpElement`	Reference toolpath element.
`types`	`list`	One or more types of interpolation to add support to.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`RemovePathInterpolationSupport`


def RemovePathInterpolationSupport(tpElement: CENPyOlpTpElement, types: list) -> int

Remove given toolpath element as support for the specified types of path interpolations.

Parameters:

Name	Type	Description
`tpElement`	`CENPyOlpTpElement`	Reference toolpath element.
`types`	`list`	One or more types of interpolation to remove support from.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`DeleteSurfaceInterpolation`


def DeleteSurfaceInterpolation(startTrack: CENPyOlpTrack, endTrack: CENPyOlpTrack, types: list) -> int

Delete surface interpolations between given toolpath tracks.

Parameters:

Name	Type	Description
`startTrack`	`CENPyOlpTrack`	Start track.
`endTrack`	`CENPyOlpTrack`	End track.
`types`	`list`	One or more types of interpolation to delete.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`AddSurfaceInterpolationSupport`


def AddSurfaceInterpolationSupport(track: CENPyOlpTrack, types: list) -> int

Add given toolpath track as support for the specified types of surface interpolations.

Parameters:

Name	Type	Description
`track`	`CENPyOlpTrack`	Reference track.
`types`	`list`	One or more types of interpolation to add support to.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`RemoveSurfaceInterpolationSupport`


def RemoveSurfaceInterpolationSupport(track: CENPyOlpTrack, types: list) -> int

Remove given toolpath track as support for the specified types of surface interpolations.

Parameters:

Name	Type	Description
`track`	`CENPyOlpTrack`	Reference track.
`types`	`list`	One or more types of interpolation to remove support from.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

Utilities

`SwitchPathInterpolationType`


def SwitchPathInterpolationType(startTpElement: CENPyOlpTpElement, endTpElement: CENPyOlpTpElement, types: list) -> int

Switch path interpolations types for given toolpath elements between Relative and Absolute, or between JoltSmooth and JoltFix.

Parameters:

Name	Type	Description
`startTpElement`	`CENPyOlpTpElement`	Start toolpath element.
`endTpElement`	`CENPyOlpTpElement`	End toolpath element.
`types`	`list`	One or more current types of interpolation that should be switched.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

`SwitchSurfaceInterpolationType`


def SwitchSurfaceInterpolationType(startTrack: CENPyOlpTrack, endTrack: CENPyOlpTrack, types: list) -> int

Switch surface interpolations types for given toolpath tracks between Relative and Absolute, or between JoltSmooth and JoltFix.

Parameters:

Name	Type	Description
`startTrack`	`CENPyOlpTrack`	Start track.
`endTrack`	`CENPyOlpTrack`	End track.
`types`	`list`	One or more current types of interpolation that should be switched.

Returns: int — ERR_NO_ERROR (0) if successful, error code otherwise.

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?

Interpolation Handler

Quick Facts

Quick Start

Method Index

Lifecycle

CreatePathInterpolation

CreateSurfaceInterpolation

Query Methods

IsInterpolated

IsInterpolated

IsSupport

IsSupport

Mutation Methods

DeletePathInterpolation

AddPathInterpolationSupport

RemovePathInterpolationSupport

DeleteSurfaceInterpolation

AddSurfaceInterpolationSupport

RemoveSurfaceInterpolationSupport

Utilities

SwitchPathInterpolationType

SwitchSurfaceInterpolationType

Related Types

Version Notes

`CreatePathInterpolation`

`CreateSurfaceInterpolation`

`IsInterpolated`

`IsInterpolated`

`IsSupport`

`IsSupport`

`DeletePathInterpolation`

`AddPathInterpolationSupport`

`RemovePathInterpolationSupport`

`DeleteSurfaceInterpolation`

`AddSurfaceInterpolationSupport`

`RemoveSurfaceInterpolationSupport`

`SwitchPathInterpolationType`

`SwitchSurfaceInterpolationType`