Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Namespace ZOSAPI::Tools::Layouts

Last update: 13.03.2026

Definition:

Classes

Enumeration types

Enumeration type CameraViewpointOptions

Definition:

enum CameraViewpointOptions {
  Isometric = 0,
  XY,
  YZ,
  XZ
}

Enumerator Isometric

Enumerator XY

Enumerator YZ

Enumerator XZ

Enumeration type RealPupilOptions

Definition:

enum RealPupilOptions {
  Pupils_Off = 0,
  Pupils_4 = 4,
  Pupils_8 = 8,
  Pupils_16 = 16,
  Pupils_32 = 32
}

Enumerator Pupils_Off

Enumerator Pupils_4

Enumerator Pupils_8

Enumerator Pupils_16

Enumerator Pupils_32

Enumeration type ColorRaysByCrossSectionOptions

Definition:

enum ColorRaysByCrossSectionOptions {
  Fields = 0,
  Waves,
  Wavelength
}

Enumerator Fields

Enumerator Waves

Enumerator Wavelength

Enumeration type LineThicknessOptions

Definition:

enum LineThicknessOptions {
  Thinnest = -2,
  Thin = -1,
  Standard = 0,
  Thick = 1,
  Thickest = 2
}

Enumerator Thinnest

Enumerator Thin

Enumerator Standard

Enumerator Thick

Enumerator Thickest

Enumeration type RayTraceOptions

Definition:

enum RayTraceOptions {
  UseRays = 0,
  LightningTraceTrueColor,
  LightningTraceAvgWavelength
}

Enumerator UseRays

Enumerator LightningTraceTrueColor

Enumerator LightningTraceAvgWavelength

Enumeration type ColorRaysByNSCOptions

Definition:

enum ColorRaysByNSCOptions {
  SourceNumber,
  WaveNumber,
  ConfigNumber,
  Wavelength,
  SegmentNumber
}

Enumerator SourceNumber

Enumerator WaveNumber

Enumerator ConfigNumber

Enumerator Wavelength

Enumerator SegmentNumber

Enumeration type DetectorPixelColorOptions

Definition:

enum DetectorPixelColorOptions {
  DoNotColorIndividualPoints,
  ByRaysOnLayout,
  ByLastAnalysis
}

Enumerator DoNotColorIndividualPoints

Enumerator ByRaysOnLayout

Enumerator ByLastAnalysis

Enumeration type DetectorDisplayModeOptions

Definition:

enum DetectorDisplayModeOptions {
  Consider,
  GreyScaleFlux,
  InverseGreyScaleFlux,
  FalseColorFlux,
  InverseFalseColorFlux,
  GreyScaleIrradiance,
  InverseGreyScaleIrradiance,
  FalseColorIrradiance,
  InverseFalseColorIrradiance
}

Enumerator Consider

Enumerator GreyScaleFlux

Enumerator InverseGreyScaleFlux

Enumerator FalseColorFlux

Enumerator InverseFalseColorFlux

Enumerator GreyScaleIrradiance

Enumerator InverseGreyScaleIrradiance

Enumerator FalseColorIrradiance

Enumerator InverseFalseColorIrradiance

Enumeration type OpacityOptions

Definition:

enum OpacityOptions {
  Ignore = 0,
  Consider,
  All50Percent
}

Enumerator Ignore

Enumerator Consider

Enumerator All50Percent

Enumeration type BackgroundOptions

Definition:

enum BackgroundOptions {
  White = 0,
  Black,
  Red,
  Green,
  Blue,
  DarkGreen,
  DarkBlue,
  Color01,
  Color02,
  Color03,
  Color04,
  Color05,
  Color06,
  Color07,
  Color08,
  Color09,
  Color10,
  Color11,
  Color12,
  Color13,
  Color14,
  Color15,
  Color16,
  Color17,
  Color18,
  Color19,
  Color20,
  Color21,
  Color22,
  Color23,
  Color24,
  Gradient01,
  Gradient02,
  Gradient03,
  Gradient04,
  Gradient05,
  Gradient06,
  Gradient07,
  Gradient08,
  Gradient09,
  Gradient10,
  GradientUser
}

Enumerator White

Enumerator Black

Enumerator Red

Enumerator Green

Enumerator Blue

Enumerator DarkGreen

Enumerator DarkBlue

Enumerator Color01

Enumerator Color02

Enumerator Color03

Enumerator Color04

Enumerator Color05

Enumerator Color06

Enumerator Color07

Enumerator Color08

Enumerator Color09

Enumerator Color10

Enumerator Color11

Enumerator Color12

Enumerator Color13

Enumerator Color14

Enumerator Color15

Enumerator Color16

Enumerator Color17

Enumerator Color18

Enumerator Color19

Enumerator Color20

Enumerator Color21

Enumerator Color22

Enumerator Color23

Enumerator Color24

Enumerator Gradient01

Enumerator Gradient02

Enumerator Gradient03

Enumerator Gradient04

Enumerator Gradient05

Enumerator Gradient06

Enumerator Gradient07

Enumerator Gradient08

Enumerator Gradient09

Enumerator Gradient10

Enumerator GradientUser

Enumeration type DrawSectionOptions

Definition:

enum DrawSectionOptions {
  P100 = 0,
  P75,
  P50,
  P25
}

Enumerator P100

Enumerator P75

Enumerator P50

Enumerator P25

Enumeration type NumberSegmentsOptions

Definition:

enum NumberSegmentsOptions {
  S_8 = 0,
  S_16,
  S_32,
  S_64,
  S_128
}

Enumerator S_8

Enumerator S_16

Enumerator S_32

Enumerator S_64

Enumerator S_128

Enumeration type BrightnessOptions

Definition:

enum BrightnessOptions {
  P100 = 0,
  P90,
  P80,
  P70,
  P60,
  P50,
  P40,
  P30,
  P20,
  P10
}

Enumerator P100

Enumerator P90

Enumerator P80

Enumerator P70

Enumerator P60

Enumerator P50

Enumerator P40

Enumerator P30

Enumerator P20

Enumerator P10

Enumeration type ColorRaysByOptions

Definition:

enum ColorRaysByOptions {
  Fields = 0,
  Waves,
  Config,
  Wavelength
}

Enumerator Fields

Enumerator Waves

Enumerator Config

Enumerator Wavelength

Connect with Ansys