Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Tools::RayTrace::IRayTraceNSCSourceData

Last update: 13.03.2026

Definition:

Members

Properties

Property UseSingleSource

Definition:

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.UseSingleSource

Return type: bool

Property SurfaceNumber

Definition:

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.SurfaceNumber

Return type: int

Property ObjectNumber

Definition:

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.ObjectNumber

Return type: int

Property MaxRays

Definition:

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.MaxRays

Return type: int

Property TraceOptions

Definition:

NSCTraceOptions ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.TraceOptions

Return type: NSCTraceOptions

Property Wavelength

Definition:

int ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.Wavelength

Return type: int

Property HasResultData

Definition:

bool ZOSAPI.Tools.RayTrace.IRayTraceNSCSourceData.HasResultData

Return type: bool

Public functions

Function UsePrimaryWavelength

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

Return type: void

Function UseAnyWavelength

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

Return type: void

Function StartReadingResults

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

Return type: bool

Function ReadNextResult

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

Parameters:

  • out int rayNumber
  • out int ErrorCode
  • out int wave
  • out int numSegments

Return type: bool

Function 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)

Parameters:

  • 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

Return type: bool

Connect with Ansys