Skip to main content

ZOS-API interface 2024 R2 SP02

ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData Interface Reference

Last update: 17.07.2025

Public Member Functions

void ClearData ()
 
bool AddRay (int waveNumber, double X, double Y, double Z, double L, double M, double N)
 
bool StartReadingResults ()
 
bool ReadNextResult (out int rayNumber, out int ErrorCode, out int vignetteCode, out double exr, out double exi, out double eyr, out double eyi, out double ezr, out double ezi, out double intensity)
 
bool ReadNextResultFull (out int rayNumber, out int ErrorCode, out int vignetteCode, out double xo, out double yo, out double zo, out double lo, out double mo, out double no, out double exr, out double exi, out double eyr, out double eyi, out double ezr, out double ezi, out double intensity)
 

Properties

int NumberOfRays [get]
 
int MaxRays [get]
 
bool HasResultData [get]
 

Member Function Documentation

◆ AddRay()

bool ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.AddRay ( int  waveNumber,
double  X,
double  Y,
double  Z,
double  L,
double  M,
double  N 
)

◆ ClearData()

void ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.ClearData ( )

◆ ReadNextResult()

bool ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.ReadNextResult ( out int  rayNumber,
out int  ErrorCode,
out int  vignetteCode,
out double  exr,
out double  exi,
out double  eyr,
out double  eyi,
out double  ezr,
out double  ezi,
out double  intensity 
)

◆ ReadNextResultFull()

bool ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.ReadNextResultFull ( out int  rayNumber,
out int  ErrorCode,
out int  vignetteCode,
out double  xo,
out double  yo,
out double  zo,
out double  lo,
out double  mo,
out double  no,
out double  exr,
out double  exi,
out double  eyr,
out double  eyi,
out double  ezr,
out double  ezi,
out double  intensity 
)

◆ StartReadingResults()

bool ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.StartReadingResults ( )

Property Documentation

◆ HasResultData

bool ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.HasResultData
get

◆ MaxRays

int ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.MaxRays
get

◆ NumberOfRays

int ZOSAPI.Tools.RayTrace.IRayTraceDirectPolData.NumberOfRays
get

Connect with Ansys