ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData Interface Reference
Last update: 17.07.2025Classes which implement this interface allow to handle refractive index FEA datasets. More...
Public Member Functions | |
| void | ImportDirectIndex (string filename) |
| ISTAR_PointWithIndex[] | GetFEAPointsSafe () |
| bool | IsDirectIndexApplied () |
| void | UnloadData () |
| ICoordinateTransform | GetTransformValues (int transformType) |
| Transform types are 0 - User coordinate adapter transform, 1 - GRSO to Local transform, 2 - Total transform (matrix product of 0 and 1) | |
| ISTAR_PointWithIndex[] | GetTransformedFEAPointsSafe (int coordinateOption) |
| Returns points after applying the selected transform. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO. | |
| ISTAR_PointWithIndex[] | GetTransformedFEAPointsNoImportRequired (String filename, int adaptCase, double[,] adapterR, double[] adapterO, int coordinateOption) |
| Returns points after applying the selected transform. This version does not require a prior call to ImportDirectIndex and thus no lens update is issued. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO. adaptCase usage to indicate FEA data coord system in the file: 0-InOSLocal, 1-InOSGlobal, 2-ToOSLocalViaTransform, 3-ToOSGlobalViaTransform. | |
Properties | |
| int | SurfaceNumber [get] |
| bool | IsDirectIndexImported [get] |
| int | NumberOfDataPoints [get] |
| string | Filename [get] |
Detailed Description
Classes which implement this interface allow to handle refractive index FEA datasets.
Member Function Documentation
◆ GetFEAPointsSafe()
| ISTAR_PointWithIndex[] ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.GetFEAPointsSafe | ( | ) |
◆ GetTransformedFEAPointsNoImportRequired()
| ISTAR_PointWithIndex[] ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.GetTransformedFEAPointsNoImportRequired | ( | String | filename, |
| int | adaptCase, | ||
| double | adapterR[,], | ||
| double[] | adapterO, | ||
| int | coordinateOption | ||
| ) |
Returns points after applying the selected transform. This version does not require a prior call to ImportDirectIndex and thus no lens update is issued. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO. adaptCase usage to indicate FEA data coord system in the file: 0-InOSLocal, 1-InOSGlobal, 2-ToOSLocalViaTransform, 3-ToOSGlobalViaTransform.
◆ GetTransformedFEAPointsSafe()
| ISTAR_PointWithIndex[] ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.GetTransformedFEAPointsSafe | ( | int | coordinateOption | ) |
Returns points after applying the selected transform. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO.
◆ GetTransformValues()
| ICoordinateTransform ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.GetTransformValues | ( | int | transformType | ) |
Transform types are 0 - User coordinate adapter transform, 1 - GRSO to Local transform, 2 - Total transform (matrix product of 0 and 1)
◆ ImportDirectIndex()
| void ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.ImportDirectIndex | ( | string | filename | ) |
◆ IsDirectIndexApplied()
| bool ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.IsDirectIndexApplied | ( | ) |
◆ UnloadData()
| void ZOSAPI.Editors.LDE.ISTAR_DirectIndexFEAData.UnloadData | ( | ) |
Property Documentation
◆ Filename
|
get |
◆ IsDirectIndexImported
|
get |
◆ NumberOfDataPoints
|
get |
◆ SurfaceNumber
|
get |
