Skip to Content

Point

Quick Facts

PropertyValue
ClassCENPyOlpPoint
Modulecenpylib.CENPyOlpPoint
Packagecenpylib
ReleaseR2025.2.4
Methods10

Quick Start

# Boilerplate Example point = ... # obtained from the runtime context result = point.GetXYZ()

Method Index

MethodReturnsSummary
SetXYZSet coordinates of OlpPoint
GetXYZtupleGet list of coordinates.
GetXfloatGet X coordinate.
GetYfloatGet Y coordinate.
GetZfloatGet Z coordinate.
SetXSet X coordinate.
SetYSet Y coordinate.
SetZSet Z coordinate.
TransformTransform the point.
DistfloatGet the distance between the current and the given point.

Query Methods

GetXYZ

def GetXYZ() -> tuple

Get list of coordinates.

Returns: tuple — List of doubles with coordinates in meters.

GetX

def GetX() -> float

Get X coordinate.

Returns: float — X value in meters.

GetY

def GetY() -> float

Get Y coordinate.

Returns: float — Y value in meters.

GetZ

def GetZ() -> float

Get Z coordinate.

Returns: float — Z value in meters.

Mutation Methods

SetXYZ

def SetXYZ(x: float, y: float, z: float)

Set coordinates of OlpPoint

Parameters:

NameTypeDescription
xfloatX in meters.
yfloatY in meters.
zfloatZ in meters.

SetX

def SetX(val: float)

Set X coordinate.

Parameters:

NameTypeDescription
valfloatX value in meters.

SetY

def SetY(val: float)

Set Y coordinate.

Parameters:

NameTypeDescription
valfloatY value in meters.

SetZ

def SetZ(val: float)

Set Z coordinate.

Parameters:

NameTypeDescription
valfloatZ value in meters.

Execution & Actions

Transform

def Transform(pyTransformationMatrix: CENPyOlpMatrix)

Transform the point.

Parameters:

NameTypeDescription
pyTransformationMatrixCENPyOlpMatrixTransformation matrix.

Utilities

Dist

def Dist(pySecondPt: CENPyOlpPoint) -> float

Get the distance between the current and the given point.

Parameters:

NameTypeDescription
pySecondPtCENPyOlpPointAnother point.

Returns: float — Distance in meters.

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?