Interface ZOSAPI::Tools::Layouts::ICrossSectionExport

Definition:

Interfaces and methods for saving an output image for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface.

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• CanCancel
• Cancel
• Close
• ColorRaysBy
• Configuration
• DeleteVignetted
• EndSurface
• ErrorMessage
• Field
• FletchRays
• ImageExportData
• IsAsynchronous
• IsFiniteDuration
• IsRunning
• IsValid
• IsValidFileName
• LowerPupil
• MarginalAndChiefRayOnly
• NumberOfRays
• OutputFileName
• OutputPixelHeight
• OutputPixelWidth
• Progress
• RaysLineThickness
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• SaveImageAsFile
• SetFieldsAll
• SetWavelengthsAll
• StartSurface
• Status
• Succeeded
• SurfaceLineThickness
• UpperPupil
• WaitForCompletion
• WaitWithTimeout
• Wavelength
• YStretch

Properties

Property SaveImageAsFile

Definition:

bool ZOSAPI.Tools.Layouts.ICrossSectionExport.SaveImageAsFile

Return type: bool

Property OutputFileName

Definition:

string ZOSAPI.Tools.Layouts.ICrossSectionExport.OutputFileName

Return type: string

Property IsValidFileName

Definition:

bool ZOSAPI.Tools.Layouts.ICrossSectionExport.IsValidFileName

Return type: bool

Property OutputPixelWidth

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.OutputPixelWidth

Return type: int

Property OutputPixelHeight

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.OutputPixelHeight

Return type: int

Property StartSurface

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.StartSurface

The first surface which will be available in the output image. If set to -1, every surface from the beginning to the EndSurface will be available.

Return type: int

Property EndSurface

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.EndSurface

The last surface which will be available in the output image. If set to -1, every surface after the StartSurface will be available.

Return type: int

Property NumberOfRays

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.NumberOfRays

The number of rays. Must be greater than 0.

Return type: int

Property YStretch

Definition:

double ZOSAPI.Tools.Layouts.ICrossSectionExport.YStretch

Return type: double

Property Wavelength

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.Wavelength

The wavelength index to use. If set to -1, all wavelengths will be displayed.

Return type: int

Property Field

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.Field

The field index to use. If set to -1, all fields will be displayed.

Return type: int

Property ColorRaysBy

Definition:

ColorRaysByCrossSectionOptions ZOSAPI.Tools.Layouts.ICrossSectionExport.ColorRaysBy

The value by which to color rays by. ColorRaysBy

Return type: ColorRaysByCrossSectionOptions

Property UpperPupil

Definition:

double ZOSAPI.Tools.Layouts.ICrossSectionExport.UpperPupil

Return type: double

Property LowerPupil

Definition:

double ZOSAPI.Tools.Layouts.ICrossSectionExport.LowerPupil

Return type: double

Property FletchRays

Definition:

bool ZOSAPI.Tools.Layouts.ICrossSectionExport.FletchRays

Return type: bool

Property DeleteVignetted

Definition:

bool ZOSAPI.Tools.Layouts.ICrossSectionExport.DeleteVignetted

Return type: bool

Property MarginalAndChiefRayOnly

Definition:

bool ZOSAPI.Tools.Layouts.ICrossSectionExport.MarginalAndChiefRayOnly

Return type: bool

Property SurfaceLineThickness

Definition:

LineThicknessOptions ZOSAPI.Tools.Layouts.ICrossSectionExport.SurfaceLineThickness

Return type: LineThicknessOptions

Property RaysLineThickness

Definition:

LineThicknessOptions ZOSAPI.Tools.Layouts.ICrossSectionExport.RaysLineThickness

Return type: LineThicknessOptions

Property Configuration

Definition:

int ZOSAPI.Tools.Layouts.ICrossSectionExport.Configuration

Return type: int

Property ImageExportData

Definition:

IImageExportData ZOSAPI.Tools.Layouts.ICrossSectionExport.ImageExportData

Return type: IImageExportData

Public functions

Function SetWavelengthsAll

void ZOSAPI.Tools.Layouts.ICrossSectionExport.SetWavelengthsAll()

Return type: void

Function SetFieldsAll

void ZOSAPI.Tools.Layouts.ICrossSectionExport.SetFieldsAll()

Return type: void