Skip to main content

ZOS-API interface 2024 R1

ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform Interface Reference

Last update: 17.07.2025

Public Member Functions

void Enable ()
 
void Disable ()
 
void ResetToDefaultFrameOfReference ()
 
bool IsInDefaultFrameOfReference ()
 
void SetRotationMatrix (double R11, double R12, double R13, double R21, double R22, double R23, double R31, double R32, double R33)
 
void SetDecenter (double DX, double DY, double DZ)
 
void SetTransformValues (double R11, double R12, double R13, double R21, double R22, double R23, double R31, double R32, double R33, double DX, double DY, double DZ)
 
void SetTransformValuesWithAngles (double ThetaX, double ThetaY, double ThetaZ, double DX, double DY, double DZ)
 
double[,] ConvertAnglesToRotationMatrix (double thetaX, double thetaY, double thetaZ)
 Generates a 3x3 rotation matrix for rotations of thetaX, thetaY and thetaZ about the X-, Y- and Z-axes respectively. Convention is intrinsic rotation thetaZ about Z -> rotation thetaY about Y -> rotation thetaX about X See https://support.zemax.com/hc/en-us/articles/1500005576822-Rotation-Matrix-and-Tilt-About-X-Y-Z-in-OpticStudio. The angles should be in degrees.
 

Properties

int SurfaceNumber [get]
 
bool IsEnabled [get]
 
ICoordinateTransform Transform [get]
 
ISTAR_Decenters Decenters [get]
 
ISTAR_Rotations Rotations [get]
 

Member Function Documentation

◆ ConvertAnglesToRotationMatrix()

double[,] ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.ConvertAnglesToRotationMatrix ( double  thetaX,
double  thetaY,
double  thetaZ 
)

Generates a 3x3 rotation matrix for rotations of thetaX, thetaY and thetaZ about the X-, Y- and Z-axes respectively. Convention is intrinsic rotation thetaZ about Z -> rotation thetaY about Y -> rotation thetaX about X See https://support.zemax.com/hc/en-us/articles/1500005576822-Rotation-Matrix-and-Tilt-About-X-Y-Z-in-OpticStudio. The angles should be in degrees.

Parameters
thetaX
thetaY
thetaZ
Returns

◆ Disable()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.Disable ( )

◆ Enable()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.Enable ( )

◆ IsInDefaultFrameOfReference()

bool ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.IsInDefaultFrameOfReference ( )

◆ ResetToDefaultFrameOfReference()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.ResetToDefaultFrameOfReference ( )

◆ SetDecenter()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.SetDecenter ( double  DX,
double  DY,
double  DZ 
)

◆ SetRotationMatrix()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.SetRotationMatrix ( double  R11,
double  R12,
double  R13,
double  R21,
double  R22,
double  R23,
double  R31,
double  R32,
double  R33 
)

◆ SetTransformValues()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.SetTransformValues ( double  R11,
double  R12,
double  R13,
double  R21,
double  R22,
double  R23,
double  R31,
double  R32,
double  R33,
double  DX,
double  DY,
double  DZ 
)

◆ SetTransformValuesWithAngles()

void ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.SetTransformValuesWithAngles ( double  ThetaX,
double  ThetaY,
double  ThetaZ,
double  DX,
double  DY,
double  DZ 
)

Property Documentation

◆ Decenters

ISTAR_Decenters ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.Decenters
get

◆ IsEnabled

bool ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.IsEnabled
get

◆ Rotations

ISTAR_Rotations ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.Rotations
get

◆ SurfaceNumber

int ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.SurfaceNumber
get

◆ Transform

ICoordinateTransform ZOSAPI.Editors.LDE.ISTAR_CoordinateTransform.Transform
get

Connect with Ansys