Interface ZOSAPI::Editors::LDE::ILDETiltDecenterData

Definition:

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;

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;

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

Members

• AfterSurfaceDecenterX
• AfterSurfaceDecenterY
• AfterSurfaceMode
• AfterSurfaceModeSurface
• AfterSurfaceModeSurfaceIsThis
• AfterSurfaceOrder
• AfterSurfaceTiltX
• AfterSurfaceTiltY
• AfterSurfaceTiltZ
• BeforeAfterSurfaceEnabled
• BeforeSurfaceDecenterX
• BeforeSurfaceDecenterY
• BeforeSurfaceOrder
• BeforeSurfaceTiltX
• BeforeSurfaceTiltY
• BeforeSurfaceTiltZ
• CoordinateReturn
• CoordinateReturnEnabled
• CoordinateReturnToSurface
• SetAfterSurfaceModeExplicit
• SetAfterSurfaceModePickup
• SetAfterSurfaceModePickupThis
• SetAfterSurfaceModeReverse
• SetAfterSurfaceModeReverseThis

Properties

Property BeforeSurfaceOrder

Definition:

TiltDecenterOrderType ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceOrder

Return type: TiltDecenterOrderType

Property BeforeSurfaceDecenterX

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceDecenterX

Return type: double

Property BeforeSurfaceDecenterY

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceDecenterY

Return type: double

Property BeforeSurfaceTiltX

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltX

Return type: double

Property BeforeSurfaceTiltY

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltY

Return type: double

Property BeforeSurfaceTiltZ

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeSurfaceTiltZ

Return type: double

Property AfterSurfaceMode

Definition:

TiltDecenterPickupType ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceMode

Return type: TiltDecenterPickupType

Property AfterSurfaceModeSurface

Definition:

int ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceModeSurface

Return type: int

Property AfterSurfaceModeSurfaceIsThis

Definition:

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceModeSurfaceIsThis

Return type: bool

Property AfterSurfaceOrder

Definition:

TiltDecenterOrderType ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceOrder

Return type: TiltDecenterOrderType

Property AfterSurfaceDecenterX

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceDecenterX

Return type: double

Property AfterSurfaceDecenterY

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceDecenterY

Return type: double

Property AfterSurfaceTiltX

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltX

Return type: double

Property AfterSurfaceTiltY

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltY

Return type: double

Property AfterSurfaceTiltZ

Definition:

double ZOSAPI.Editors.LDE.ILDETiltDecenterData.AfterSurfaceTiltZ

Return type: double

Property BeforeAfterSurfaceEnabled

Definition:

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.BeforeAfterSurfaceEnabled

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

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

Return type: bool

Property CoordinateReturnEnabled

Definition:

bool ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturnEnabled

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

true if coordinate data is enabled; otherwise, false.

Return type: bool

Property CoordinateReturn

Definition:

CoordinateReturnType ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturn

Return type: CoordinateReturnType

Property CoordinateReturnToSurface

Definition:

int ZOSAPI.Editors.LDE.ILDETiltDecenterData.CoordinateReturnToSurface

Return type: int

Public functions

Function SetAfterSurfaceModeExplicit

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

Return type: void

Function SetAfterSurfaceModePickup

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

Parameters:

• int fromSurface

Return type: bool

Function SetAfterSurfaceModeReverse

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

Parameters:

• int fromSurface

Return type: bool

Function SetAfterSurfaceModePickupThis

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

Return type: bool

Function SetAfterSurfaceModeReverseThis

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

Return type: bool