Skip to main content

ZOS-API interface 2025 R2

ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData Interface Reference

Last update: 16.07.2025

Public Member Functions

void UsePrimaryWavelength ()
 
void UseAnyWavelength ()
 
bool StartReadingResults ()
 
bool ReadNextResult (out int rayNumber, out int ErrorCode, out int wave, out int numSegments)
 
bool ReadNextSegment (out int segmentLevel, out int segmentParent, out int hitObj, out int InsideOf, out double x, out double y, out double z, out double l, out double m, out double n, out double exr, out double exi, out double eyr, out double eyi, out double ezr, out double ezi, out double intensity, out double pathLength)
 

Properties

bool UseSingleSource [get, set]
 
int SurfaceNumber [get, set]
 
int ObjectNumber [get, set]
 
int MaxRays [get, set]
 
NSCTraceOptions TraceOptions [get, set]
 
int Wavelength [get, set]
 
bool HasResultData [get]
 

Member Function Documentation

◆ ReadNextResult()

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.ReadNextResult ( out int  rayNumber,
out int  ErrorCode,
out int  wave,
out int  numSegments 
)

◆ ReadNextSegment()

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.ReadNextSegment ( out int  segmentLevel,
out int  segmentParent,
out int  hitObj,
out int  InsideOf,
out double  x,
out double  y,
out double  z,
out double  l,
out double  m,
out double  n,
out double  exr,
out double  exi,
out double  eyr,
out double  eyi,
out double  ezr,
out double  ezi,
out double  intensity,
out double  pathLength 
)

◆ StartReadingResults()

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

◆ UseAnyWavelength()

void ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.UseAnyWavelength ( )

◆ UsePrimaryWavelength()

void ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.UsePrimaryWavelength ( )

Property Documentation

◆ HasResultData

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.HasResultData
get

◆ MaxRays

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.MaxRays
getset

◆ ObjectNumber

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.ObjectNumber
getset

◆ SurfaceNumber

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.SurfaceNumber
getset

◆ TraceOptions

NSCTraceOptions ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.TraceOptions
getset

◆ UseSingleSource

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.UseSingleSource
getset

◆ Wavelength

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.Wavelength
getset

Connect with Ansys