ZOS-API interface 2025 R1

ZOSAPI.Editors.LDE.ILDETiltDecenterData Interface Reference

Last update: 17.07.2025

Surface properties tilt/decenter data. This interface can be accessed via the ILDERow interface. More...

Public Member Functions

void SetAfterSurfaceModeExplicit ()
 
bool SetAfterSurfaceModePickup (int fromSurface)
 
bool SetAfterSurfaceModeReverse (int fromSurface)
 
bool SetAfterSurfaceModePickupThis ()
 
bool SetAfterSurfaceModeReverseThis ()
 

Properties

TiltDecenterOrderType BeforeSurfaceOrder [get, set]
 
double BeforeSurfaceDecenterX [get, set]
 
double BeforeSurfaceDecenterY [get, set]
 
double BeforeSurfaceTiltX [get, set]
 
double BeforeSurfaceTiltY [get, set]
 
double BeforeSurfaceTiltZ [get, set]
 
TiltDecenterPickupType AfterSurfaceMode [get]
 
int AfterSurfaceModeSurface [get]
 
bool AfterSurfaceModeSurfaceIsThis [get]
 
TiltDecenterOrderType AfterSurfaceOrder [get, set]
 
double AfterSurfaceDecenterX [get, set]
 
double AfterSurfaceDecenterY [get, set]
 
double AfterSurfaceTiltX [get, set]
 
double AfterSurfaceTiltY [get, set]
 
double AfterSurfaceTiltZ [get, set]
 
bool BeforeAfterSurfaceEnabled [get]
 Gets a value indicating whether before/after surface data is available (true for most surfaces).

 
bool CoordinateReturnEnabled [get]
 Gets a value indicating whether the coordinate return data is available (true only for coordinate breaks).
 
CoordinateReturnType CoordinateReturn [get, set]
 
int CoordinateReturnToSurface [get, set]
 

Detailed Description

Surface properties tilt/decenter data. This interface can be accessed via the ILDERow interface.

Usage (see Example 19 for a full sample)

C#

// GetSurfaceAt(surface number shown in LDE) will return an interface ILDERow
// Through property TiltDecenterData of each interface ILDERow, we can modify data in Surface Properties > Tilt/Decenter section
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceOrder = TiltDecenterOrderType.Decenter_Tilt;
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceTiltX = 15;
TheLDE.GetSurfaceAt(2).TiltDecenterData.AfterSurfaceTiltX = -15;
TheLDE.GetSurfaceAt(3).TiltDecenterData.BeforeSurfaceTiltX = -15;
TheLDE.GetSurfaceAt(3).TiltDecenterData.AfterSurfaceTiltX = 15;
ZOSAPI.Editors.LDE.TiltDecenterOrderType
TiltDecenterOrderType
Definition: InterfacesLDE.cs:5282

C++

// GetSurfaceAt(surface number shown in LDE) will return an interface ILDERow
// Through property TiltDecenterData of each interface ILDERow, we can modify data in Surface Properties > Tilt/Decenter section
TheLDE->GetSurfaceAt(2)->TiltDecenterData->BeforeSurfaceOrder = TiltDecenterOrderType_Decenter_Tilt;
TheLDE->GetSurfaceAt(2)->TiltDecenterData->BeforeSurfaceTiltX = 15;
TheLDE->GetSurfaceAt(2)->TiltDecenterData->AfterSurfaceTiltX = -15;
TheLDE->GetSurfaceAt(3)->TiltDecenterData->BeforeSurfaceTiltX = -15;
TheLDE->GetSurfaceAt(3)->TiltDecenterData->AfterSurfaceTiltX = 15;

Matlab

% GetSurfaceAt(surface number shown in LDE) will return an interface ILDERow
% Through property TiltDecenterData of each interface ILDERow, we can modify data in Surface Properties > Tilt/Decenter section
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceOrder = ZOSAPI.Editors.LDE.TiltDecenterOrderType.Decenter_Tilt;
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceTiltX = 15;
TheLDE.GetSurfaceAt(2).TiltDecenterData.AfterSurfaceTiltX = -15;
TheLDE.GetSurfaceAt(3).TiltDecenterData.BeforeSurfaceTiltX = -15;
TheLDE.GetSurfaceAt(3).TiltDecenterData.AfterSurfaceTiltX = 15;
ZOSAPI.Editors.LDE.ILDERow
All data for a Lens Data Editor surface. This interface can be accessed via the ILensDataEditor inter...
Definition: InterfacesLDE.cs:791
ZOSAPI.Editors.LDE
Definition: InterfacesLDE.cs:8
ZOSAPI.Editors
Definition: InterfacesEditors.cs:12
ZOSAPI
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

Python

# GetSurfaceAt(surface number shown in LDE) will return an interface ILDERow
# Through property TiltDecenterData of each interface ILDERow, we can modify data in Surface Properties > Tilt/Decenter section
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceOrder = ZOSAPI.Editors.LDE.TiltDecenterOrderType.Decenter_Tilt
TheLDE.GetSurfaceAt(2).TiltDecenterData.BeforeSurfaceTiltX = 15
TheLDE.GetSurfaceAt(2).TiltDecenterData.AfterSurfaceTiltX = -15
TheLDE.GetSurfaceAt(3).TiltDecenterData.BeforeSurfaceTiltX = -15
TheLDE.GetSurfaceAt(3).TiltDecenterData.AfterSurfaceTiltX = 15

Member Function Documentation

◆ SetAfterSurfaceModeExplicit()

void ZOSAPI.Editors.LDE.ILDETiltDecenterData.SetAfterSurfaceModeExplicit ( )

◆ SetAfterSurfaceModePickup()

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.SetAfterSurfaceModePickup ( int  fromSurface)

◆ SetAfterSurfaceModePickupThis()

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.SetAfterSurfaceModePickupThis ( )

◆ SetAfterSurfaceModeReverse()

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.SetAfterSurfaceModeReverse ( int  fromSurface)

◆ SetAfterSurfaceModeReverseThis()

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.SetAfterSurfaceModeReverseThis ( )

Property Documentation

◆ AfterSurfaceDecenterX

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceDecenterX
getset

◆ AfterSurfaceDecenterY

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceDecenterY
getset

◆ AfterSurfaceMode

TiltDecenterPickupType ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceMode
get

◆ AfterSurfaceModeSurface

int ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceModeSurface
get

◆ AfterSurfaceModeSurfaceIsThis

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceModeSurfaceIsThis
get

◆ AfterSurfaceOrder

TiltDecenterOrderType ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceOrder
getset

◆ AfterSurfaceTiltX

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltX
getset
Examples
CSharpStandalone_19_Surface_Properties.cs.

◆ AfterSurfaceTiltY

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltY
getset

◆ AfterSurfaceTiltZ

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltZ
getset

◆ BeforeAfterSurfaceEnabled

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeAfterSurfaceEnabled
get

Gets a value indicating whether before/after surface data is available (true for most surfaces).

true if before/after surface data enabled; otherwise, false.

◆ BeforeSurfaceDecenterX

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceDecenterX
getset

◆ BeforeSurfaceDecenterY

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceDecenterY
getset

◆ BeforeSurfaceOrder

TiltDecenterOrderType ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceOrder
getset
Examples
CSharpStandalone_19_Surface_Properties.cs.

◆ BeforeSurfaceTiltX

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltX
getset
Examples
CSharpStandalone_19_Surface_Properties.cs.

◆ BeforeSurfaceTiltY

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltY
getset

◆ BeforeSurfaceTiltZ

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltZ
getset

◆ CoordinateReturn

CoordinateReturnType ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturn
getset

◆ CoordinateReturnEnabled

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturnEnabled
get

Gets a value indicating whether the coordinate return data is available (true only for coordinate breaks).

true if coordinate data is enabled; otherwise, false.

◆ CoordinateReturnToSurface

int ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturnToSurface
getset

Connect with Ansys