Skip to main content

ZOS-API interface 2024 R1

ZOSAPI.Tools.Layouts Namespace Reference

Last update: 17.07.2025

Classes

interface  I3DViewerExport
 
interface  ICrossSectionExport
 Interfaces and methods for saving an output image for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface. More...
 
interface  IImageExportData
 
interface  IImagePixel
 
interface  INSC3DLayoutExport
 
interface  INSCShadedModelExport
 
interface  IShadedModelExport
 

Enumerations

enum  CameraViewpointOptions { Isometric = 0 , XY , YZ , XZ }
 
enum  RealPupilOptions {
  Pupils_Off = 0 , Pupils_4 = 4 , Pupils_8 = 8 , Pupils_16 = 16 ,
  Pupils_32 = 32
}
 
enum  ColorRaysByCrossSectionOptions { Fields = 0 , Waves , Wavelength }
 
enum  LineThicknessOptions {
  Thinnest = -2 , Thin = -1 , Standard = 0 , Thick = 1 ,
  Thickest = 2
}
 
enum  RayTraceOptions { UseRays = 0 , LightningTraceTrueColor , LightningTraceAvgWavelength }
 
enum  ColorRaysByNSCOptions {
  SourceNumber , WaveNumber , ConfigNumber , Wavelength ,
  SegmentNumber
}
 
enum  DetectorPixelColorOptions { DoNotColorIndividualPoints , ByRaysOnLayout , ByLastAnalysis }
 
enum  DetectorDisplayModeOptions {
  Consider , GreyScaleFlux , InverseGreyScaleFlux , FalseColorFlux ,
  InverseFalseColorFlux , GreyScaleIrradiance , InverseGreyScaleIrradiance , FalseColorIrradiance ,
  InverseFalseColorIrradiance
}
 
enum  OpacityOptions { Ignore = 0 , Consider , All50Percent }
 
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
}
 
enum  DrawSectionOptions { P100 = 0 , P75 , P50 , P25 }
 
enum  NumberSegmentsOptions {
  S_8 = 0 , S_16 , S_32 , S_64 ,
  S_128
}
 
enum  BrightnessOptions {
  P100 = 0 , P90 , P80 , P70 ,
  P60 , P50 , P40 , P30 ,
  P20 , P10
}
 
enum  ColorRaysByOptions { Fields = 0 , Waves , Config , Wavelength }
 

Enumeration Type Documentation

◆ BackgroundOptions

Enumerator
White 
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 

◆ BrightnessOptions

Enumerator
P100 
P90 
P80 
P70 
P60 
P50 
P40 
P30 
P20 
P10 

◆ CameraViewpointOptions

Enumerator
Isometric 
XY 
YZ 
XZ 

◆ ColorRaysByCrossSectionOptions

Enumerator
Fields 
Waves 
Wavelength 

◆ ColorRaysByNSCOptions

Enumerator
SourceNumber 
WaveNumber 
ConfigNumber 
Wavelength 
SegmentNumber 

◆ ColorRaysByOptions

Enumerator
Fields 
Waves 
Config 
Wavelength 

◆ DetectorDisplayModeOptions

Enumerator
Consider 
GreyScaleFlux 
InverseGreyScaleFlux 
FalseColorFlux 
InverseFalseColorFlux 
GreyScaleIrradiance 
InverseGreyScaleIrradiance 
FalseColorIrradiance 
InverseFalseColorIrradiance 

◆ DetectorPixelColorOptions

Enumerator
DoNotColorIndividualPoints 
ByRaysOnLayout 
ByLastAnalysis 

◆ DrawSectionOptions

Enumerator
P100 
P75 
P50 
P25 

◆ LineThicknessOptions

Enumerator
Thinnest 
Thin 
Standard 
Thick 
Thickest 

◆ NumberSegmentsOptions

Enumerator
S_8 
S_16 
S_32 
S_64 
S_128 

◆ OpacityOptions

Enumerator
Ignore 
Consider 
All50Percent 

◆ RayTraceOptions

Enumerator
UseRays 
LightningTraceTrueColor 
LightningTraceAvgWavelength 

◆ RealPupilOptions

Enumerator
Pupils_Off 
Pupils_4 
Pupils_8 
Pupils_16 
Pupils_32 

Connect with Ansys