Skip to main content

ZOS-API interface 2025 R2

ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData Interface Reference

Last update: 16.07.2025

Public Member Functions

void ImportDeformations (string filename)
 
int ImportDeformations_1 (string filename)
 Import Deformation FEA data from a file.
 
ISTAR_PointWithDeformation[] GetFEAPointsSafeOld ()
 
ISTAR_PointWithDeformation[] GetFEAPointsSafe ()
 
ISTAR_PointWithDeformationAndWeight[] GetFEAPointsWithAutoWeightsSafe (int weightVariation)
 Returns FEA points with automatically calculated weights that attempt to account for unevenly spaced points in the FEA data set.
 
bool AreDeformationsApplied ()
 
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_PointWithDeformation[] 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_PointWithDeformation[] 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 ImportDeformations 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 AreDeformationsImported [get]
 
int NumberOfDataPoints [get]
 
string Filename [get]
 

Member Function Documentation

◆ AreDeformationsApplied()

bool ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.AreDeformationsApplied ( )

◆ GetFEAPointsSafe()

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsSafe ( )

◆ GetFEAPointsSafeOld()

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsSafeOld ( )

◆ GetFEAPointsWithAutoWeightsSafe()

ISTAR_PointWithDeformationAndWeight[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsWithAutoWeightsSafe ( int  weightVariation)

Returns FEA points with automatically calculated weights that attempt to account for unevenly spaced points in the FEA data set.

Parameters
weightVariation1 -> XY plane weights only; 2 -> XY, XZ and YZ weights combined
Returns

◆ GetTransformedFEAPointsNoImportRequired()

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.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 ImportDeformations 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_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.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_DeformationsFEAData.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)

◆ ImportDeformations()

void ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.ImportDeformations ( string  filename)

◆ ImportDeformations_1()

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.ImportDeformations_1 ( string  filename)

Import Deformation FEA data from a file.

Parameters
filenameFull path of the file containing the FEA data
Returns
Returns an integer signalling the status of the operation according to the following:
Value Meaning
0 The file has no header, or the file contains the correct type of data according to its header.
1 OpticStudio was unable to open the file.
2 The file has a malformed header.
3 The file contains the wrong type of data according to its header.

◆ UnloadData()

void ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.UnloadData ( )

Property Documentation

◆ AreDeformationsImported

bool ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.AreDeformationsImported
get

◆ Filename

string ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.Filename
get

◆ NumberOfDataPoints

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.NumberOfDataPoints
get

◆ SurfaceNumber

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.SurfaceNumber
get

Connect with Ansys