GlobalOptions Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
This class stores all properties which can be set in the Global Options dialog. More...

Inheritance diagram for GlobalOptions:

Public Member Functions
override object	Clone ()
	Clones the current object.
new void	DeserializationPostProcessing (ref List< FieldInfo > unfindableFields, RemainingData remainingData)
	Method for doing post-processing after XML deserialization. Especially, handling of fields which have been altered since the version the data were saved with. But also additional operations (like filling caching variables etc.) can be done here.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified System.Object, is equal to this instance.
	GlobalOptions ()
	Default constructor initializing a new instance of the GlobalOptions class.
	GlobalOptions (SerializationInfo info, StreamingContext context)
	Deserialization constructor. See the ISerializable interface for more details.
void	Save ()
	Saves this object into the User Data directory using a default file name.
void	Save (string fileName)
	Saves this object into a file in binary format.

Static Public Member Functions
static GlobalOptions	Load ()
	Loads the file used for storing the global options automatically, i.e. without user interaction. If this file could not be loaded default values are used.
static GlobalOptions	Load (string filePath)
	Loads the specified file and sets the static FilePath property to it. If this file could not be loaded an exception is thrown.

Static Public Attributes
static readonly string	CurrentVersionKey
	The key where the Global Options files used in the current version are stored (relative to the main key of VirtualLab).
static readonly string	FileDialogFilter
	The file dialog filter.
static readonly PhysicalProperty[]	PropertiesWhichIndicate1DDataArrayInitializationAsPolarDiagram
	List of physical properties for which 1D data arrays with angular coordinates are initially shown as polar diagrams.

Properties
double	AirPressureInPascals [get, set]
	The default air pressure, measured in Pascals.
double	ArtifactsThreshold [get, set]
	Default relative threshold for hiding phase artifacts.
bool	AutoCompleteBraces [get, set]
	Gets and sets whether for opening braces and quotation marks the closing character should be added automatically.
bool	AutomaticResamplingForOperations [get, set]
	Gets and sets whether automatic resampling is done in array - array operations.
float	AxisFontSize [get, set]
	Gets and sets the default font size of axes for 1D and 2D diagrams.
ColorLookUpTableForDataView2D[]	ColorLookupTables [get, set]
	Gets and sets the color lookup tables to be used as default for real part, imaginary part, amplitude, phase and squared amplitude. Use this property only in the Global Options dialog! In normal case, use Globals.DefaultColorLookupTables, which return a copy of this array.
Colorsystem	ColorSystem [get, set]
	Color system to be used for transforming CIEXYZ to RGB.
ColorLookUpTableForDataView2D	ColorTableForDetectors [get, set]
	Gets and sets the default color table for detectors.
Color	ColorUndefinedData_1D [get, set]
	A color used to indicate undefined values in 1D displays.
Color	ColorUndefinedData_2D [get, set]
	A color used to indicate undefined values in 2D displays.
static string	DefaultFilePath [get]
	Gets the default file path used when the user has not yet set an own file path.
LogDetailLevel	DefaultLoggingLevelSimulation [get, set]
	public property to set and get the default logging level for simulation
AxisDirection	DefaultRotationAxisForInitialAxisRotationSequence [get, set]
	Which kind of axis rotation sequence shall represent a non-rotation? It consists of one single rotation with angle 0, but about which axis? The same axis will be used as initial singular entry within a new axis rotation sequence.
double	DeviationThreshold [get, set]
	Deviation Threshold as used by several propagation operators.
double	DisplayDurationOfToolTips [get, set]
	Gets and sets the time in seconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).
int	DisplayDurationOfToolTipsInMilliseconds [get]
	Gets the time in milliseconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).
DefaultDocumentDuplicationState	DuplicationStateForDataArray1D [get, set]
	Gets and sets the default state for manipulating objects of type DataArray1D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.
DefaultDocumentDuplicationState	DuplicationStateForDataArray2D [get, set]
	Gets and sets the default state for manipulating objects of type DataArray1D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.
int	EmbeddingFrame [get, set]
	VirtualLab embeds (source) fields into a larger field with a frame of zeros. This property defines the width of this frame in pixels. The default value is 10.
Material	EmbeddingMaterial [get, set]
	Default embedding material.
bool	EnableLoggingAutomaticOperator [get, set]
	Enables the logging for the automatic propagation operator into message window. This setting only has an effect for the processing of Light Path Elements.
bool	ExpertMode [get, set]
	Shall non-numerical data arrays start in expert mode by default?
HarmonicFieldComponents[]	FieldComponentsForDetectors [get, set]
	Gets and sets which field components are calculated by default for certain detectors (currently Camera Detector, Electromagnetic Field Detector, PSF & MTF, Power).
VectorD	FieldSize [get]
	Gets the default field size in meters for newly generated fields.
double	FieldSizeFactor [get, set]
	Gets and sets the default oversampling factor.
double	FieldSizeTruncationFactor [get, set]
	This ratio decides whether the target field size of the Accelerated Sinc interpolation justifies field truncation in the sinc interpolation step.
string	FileExtension [get]
static string	FilePath [get, set]
	Gets and sets the file path where the currently used Global Options file is stored. Gets an empty string if no file path is stored at the expected location in registry.
ComplexToStringConversionFormat	FormatOfComplexNumbers [get, set]
	Gets and sets how complex numbers are formatted as strings.
AxisNumberFormat?	FormatOfPhysicalValues [get, set]
	Gets and sets the format of physical values (Standard, Scientific or Engineering; null means automatic selection).
I2OParameters	FreespaceParametersComponents [get, set]
	public property to set and get the freespace parameter to use for propagation to/inside components
I2OParameters	FreespaceParametersDetectors [get, set]
	public property to set and get the freespace parameters to use for propagation to detectors
Font	GUI_Font [get, set]
	Gets and sets the font generally used in the VirtualLab Graphical User Interface. The get-branch returns a copy of the actual font object, as assigning a font reference to e.g. a label and disposing the label afterwards destroys the font and thus the VirtualLab GUI.
bool	HideNumericalArtifacts [get, set]
	Shall the phase values with vanishing amplitudes (below ArtifactsThreshold) be hidden in the view?
ControlDataArray1DWithTable.InitializationOfDataArray1DwithAngularDependency	InitializationOfDataArray1DwithAngularDependency [get, set]
	Initialization mode for 1D data arrays with angular dependency.
Size	InitialWindowSize [get, set]
	Default client size for result document windows (harmonic fields, harmonic fields set, diagrams, data arrays and derived objects).
InterpolationMethod	InterpolationMethodForRealValuedSmoothing_Equidistant [get]
	The interpolation method to be used for real valued smoothing of views (ViewInterpolationMode.RealValuedSmoothing) in equidistant case.
InterpolationMethodForNonequidistantData	InterpolationMethodForRealValuedSmoothing_NonEquidistant [get]
	The interpolation method to be used for real valued smoothing of views (ViewInterpolationMode.RealValuedSmoothing) in non-equidistant case.
static bool	IsComparerTestMode [get]
	Gets and sets whether we are currently doing comparer or unit tests.
static bool	IsDesignMode [get, set]
	Gets and sets whether we are currently in the VisualStudio Designer.
bool	KeepMediaWavelengthsConstantIfEnvironmentChanges [get, set]
	If true then all wavelengths of lights sources in a light path whose temperature or pressure have been changed will be adapted in a way, keeping the media wavelengths constant. Otherwise the vacuum wavelengths will be kept constant.
LengthUnits	LengthUnit [get, set]
	Gets and sets the default length unit which is used if a pure double value is to be parsed into a length.
Color	LineColor_SingleGraphMode [get, set]
	Gets and sets the color of graph lines (in singlegraph mode) to be used as default.
Color	LineColor_SingleGraphMode_Polar [get, set]
	Gets and sets the color of graph lines (in singlegraph mode) to be used as default.
float	LineThickness [get, set]
	Gets and sets the thickness of graph lines to be used as default.
List< ColorLookUpTableForDataView2D >	ListOfColorLookupTables_forMenu [get, set]
	List of those color lookup tables which appear in the menu to select the current lookup table from.
List< PhysicalProperty >	ListOfPropertiesUsedForInitializationAsPolarDiagram [get, set]
	List of physical properties for which 1D data arrays with angular coordinates are initially shown as polar diagrams.
Themes	MainWindowTheme [get, set]
	Gets and sets the theme currently applied to the main window.
float	MarkerLineThickness_1DViews [get, set]
	Gets and sets the thickness of the lines which are used for drawing markers in 1D diagrams.
float	MarkerLineThickness_2DViews [get, set]
	Gets and sets the thickness of the lines which are used for drawing markers in 2D diagrams.
int	MaximumNumberOfRaysThatAllowsSnapping [get, set]
	Maximum number of rays that allow snapping inside the view of a ray distribution.
int	MaximumNumberOfSnapshotFiles [get, set]
	Gets and sets the maximum number of snapshot files stored per document.
int	MaximumNumberOfTableCellsForDataArrays [get, set]
	Maximum number of table cells that will be displayed in a data array 2D table.
NotifyIconVisibility	NotifyIconMode [get, set]
	Gets and sets when the notify icon and notifications are visible.
int	NumberOfDigits [get, set]
	Number of digits to be shown in numerical strings.
int	NumberOfDigitsForColorLegend [get, set]
	Number of digits to be shown in the labels of the color legend.
bool	OfflineMode [get, set]
	Gets and sets whether VirtualLab is in offline mode, i.e. no Internet access is done.
OrientationDefinitionType	OrientationDefinitionType [get, set]
	Get or set the default definition type for orientations.
double	OversamplingFactor [get, set]
	Gets and sets the default oversampling factor.
PolarizationViewSettings	PolarizationDisplayMode [get, set]
	Gets and sets how the polarization shall be shown by default: as ellipses, only the angles or only the eccentricities.
CombinedComponent	PolarizationPlane [get, set]
	Gets the polarization plane to be shown by default.
bool	PopUpErrorMessages [get, set]
	Determines whether error messages are shown as separate message boxes in addition to being logged in the Messages tab.
bool	PopUpWarningMessages [get, set]
	Determines whether warning messages are shown as separate message boxes in addition to being logged in the Messages tab.
double	PowerPortionFieldSizeEstimation [get, set]
	The value for automatic detection of the field size.
PrecisionMode	Precision [get]
	Default precision of internally stored floating point numbers. Con be either double or float. Independently from this settings calculations are done with double precision numbers.
Propagation.PropagationEngine	PropagationEngineLPD [get]
	public property to set and get the default propagation engine (used for starter toolbox)
HomogeneousMediumPropagationOperator	PropagationMethodForLinkages [get, set]
	Gets and sets the default propagation technique which shall be used for new linkages.
Color	RadialAxisColor_primary [get, set]
	Gets and sets the color of the primary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.
Color	RadialAxisColor_quaternary [get, set]
	Gets and sets the color of the quaternary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.
Color	RadialAxisColor_secondary [get, set]
	Gets and sets the color of the secondary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.
Color	RadialAxisColor_tertiary [get, set]
	Gets and sets the color of the tertiary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.
double	RelativeEdgeWidth [get, set]
	VirtualLab uses smooth edges for defining the aperture. The width of the edges is defined as relative value wrt. the field size. The default value is 0.1 (10 percent).
VectorD	SamplingDistance [get, set]
	Gets and sets the default sampling distance in meters for newly generated fields.
Vector	SamplingPoints [get, set]
	Gets and sets the default number of sampling points for newly generated fields.
double	ScalingPolarizationGrid [get, set]
	Default scaling of the polarization grid.
ViewSettings3DView	Settings3DView [get, set]
	Gets and sets the default view settings for the 3D view.
bool	ShowLegend [get, set]
	Sets and gets whether the legend shall be shown by default.
bool	ShowMinimap [get, set]
	Gets and sets whether a minimap (extended scrollbar) is shown to the right.
bool	ShowPolarization [get, set]
	Gets and sets whether the polarization shall be shown.
bool	ShowPolarizationArrows [get, set]
	shall the arrows of the polarization ellipses be shown
bool	ShowPolarizationGrid [get, set]
	shall the polarization Grid be shown
PredefinedCodeEditorTheme	SourceCodeEditorTheme [get, set]
	Gets and sets whether the source code editor shall use a dark mode or the normal bright mode.
bool	StoreSnapshotFiles [get, set]
	Gets and sets whether snapshot files are generated every time a document changes.
Color	SymbolColor_Polar_SingleGraphMode [get, set]
	Gets and sets the color of graph symbols (in singlegraph mode of polar diagram) to be used as default.
Color	SymbolColor_SingleGraphMode [get, set]
	Gets and sets the color of graph symbols (in singlegraph mode) to be used as default.
float	SymbolScalingFactor [get, set]
	Gets and sets the scaling factor of graph symbols to be used as default.
DiagramSymbolShape	SymbolShape_MultiGraphMode [get, set]
	Gets and sets the shape of graph symbols (in multigraph mode) to be used as default. Different symbol shapes will be used not before all colors are used for different subsets.
DiagramSymbolShape	SymbolShape_Polar_MultiGraphMode [get, set]
	Gets and sets the shape of graph symbols (in multigraph mode of polar diagram) to be used as default. Different symbol shapes will be used not before all colors are used for different subsets.
DiagramSymbolShape	SymbolShape_Polar_SingleGraphMode [get, set]
	Gets and sets the shape of graph symbols (in singlegraph mode of polar diagram) to be used as default.
DiagramSymbolShape	SymbolShape_SingleGraphMode [get, set]
	Gets and sets the shape of graph symbols (in singlegraph mode) to be used as default.
double	SystemTemperatureInDegreesCelsius [get, set]
	The default system temperature, measured in degrees Celsius.
TempFolderHandlingAfterUse	TempFolderHandlingAfterZARUnpacking [get, set]
	Default state for handling the temporary folder which is used for unpacking a Zemax ZAR archive. This determines whether the user has to be asked if she want to save the folder's contents.
float	TitleFontSize [get, set]
	Gets and sets the default font size of diagram titles for 2D diagrams.
bool	UseComponentCSforStackPreview [get, set]
	Gets and sets whether the stack preview uses the coordinate system of the parent component. In this case the preview is rotated and flipped as needed. Otherwise always the stack coordinate system is used, which means that interfaces run from left to right.
bool	UseEmbeddingForOperations [get, set]
	Gets and sets whether an embedding is to be used for Field * Transmission Operations.
bool	UseIndicatorForHiddenDigitsInPhysicalUnitTextbox [get, set]
	Shall physicalUnitTextBoxes indicate that some digits where hidden due to rounding?
bool	UseOrthogonalLinkagesInOpticalSetupView [get, set]
	Gets and sets whether the linkages of an Optical Setup are drawn in the flowchart with orthogonal (true) or straight (false) connector lines.
bool	UseRecommendedFont [get, set]
	Gets and sets whether a preset font is used (true) or whether the user configures the font individually (false).
bool	UseSmoothedGraphics [get, set]
	Gets and sets the shape of graph symbols to be used as default.
bool	UseSpecialNumberOfDigitsForColorLegend [get, set]
	If true, a specially defined number of digits will be used for color legend labels.
bool	UseStandardRangeForCAView [get, set]
	Shall the standard range be used as default for the view of harmonic fields?
bool	UseTransparencyForClipboard [get, set]
	Gets and sets whether document windows copied to the clipboard have a transparent background.
bool	UseZOSAPI [get, set]
	Gets and sets whether the ZOSAPI_NetHelper.dll (and thus Zemax OpticStudio®) is used for the import of Zemax files.
double	Wavelength [get, set]
	Gets and sets the default wavelength in \(\mathrm{m}\).
Color	YAxisColor_left_MultiGraphMode [get, set]
	Gets and sets the color of the left y-axis and its associated graphs in multigraph mode to be used as default.
Color	YAxisColor_right_MultiGraphMode [get, set]
	Gets and sets the color of the right y-axis and its associated graphs in multigraph mode to be used as default.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
This class stores all properties which can be set in the Global Options dialog.

Constructor & Destructor Documentation

GlobalOptions()

GlobalOptions	(	SerializationInfo	info,
		StreamingContext	context
	)

Deserialization constructor. See the ISerializable interface for more details.

Parameters

info	SerializationInfo
context	StreamingContext

Member Function Documentation

Clone()

override object Clone

(

)

Clones the current object.

Returns

Deep copy of this object.

DeserializationPostProcessing()

new void DeserializationPostProcessing	(	ref List< FieldInfo >	unfindableFields,
		RemainingData	remainingData
	)

Method for doing post-processing after XML deserialization. Especially, handling of fields which have been altered since the version the data were saved with. But also additional operations (like filling caching variables etc.) can be done here.

Parameters

unfindableFields	List of all those fields which are expected but could not be read from XML.
remainingData	Data contained in XML but which haven't been read yet.

Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent
	)

Determines whether the specified System.Object, is equal to this instance.

Parameters

otherObject	The System.Object to compare with this instance.
equalityIntent	The equality intent.

Returns

true if the specified System.Object is equal to this instance; otherwise, false.

Load() [1/2]

static GlobalOptions Load ( )

static

Loads the file used for storing the global options automatically, i.e. without user interaction. If this file could not be loaded default values are used.

Returns

The loaded global options. A new GlobalOptions object if the file could not be loaded.

Load() [2/2]

static GlobalOptions Load ( string  filePath )

static

Loads the specified file and sets the static FilePath property to it. If this file could not be loaded an exception is thrown.

Parameters

filePath

Full path of the file.

Returns

The loaded global options.

Save()

void Save

(

string

fileName

)

Saves this object into a file in binary format.

Parameters

fileName

Complete path of file.

Property Documentation

AutoCompleteBraces

bool AutoCompleteBraces

getset

Gets and sets whether for opening braces and quotation marks the closing character should be added automatically.

AutomaticResamplingForOperations

bool AutomaticResamplingForOperations

getset

Gets and sets whether automatic resampling is done in array - array operations.

AxisFontSize

float AxisFontSize

getset

Gets and sets the default font size of axes for 1D and 2D diagrams.

ColorTableForDetectors

ColorLookUpTableForDataView2D ColorTableForDetectors

getset

Gets and sets the default color table for detectors.

DisplayDurationOfToolTips

double DisplayDurationOfToolTips

getset

Gets and sets the time in seconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).

DisplayDurationOfToolTipsInMilliseconds

int DisplayDurationOfToolTipsInMilliseconds

get

Gets the time in milliseconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).

DuplicationStateForDataArray1D

DefaultDocumentDuplicationState DuplicationStateForDataArray1D

getset

Gets and sets the default state for manipulating objects of type DataArray1D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.

DuplicationStateForDataArray2D

DefaultDocumentDuplicationState DuplicationStateForDataArray2D

getset

Gets and sets the default state for manipulating objects of type DataArray1D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.

EmbeddingFrame

int EmbeddingFrame

getset

VirtualLab embeds (source) fields into a larger field with a frame of zeros. This property defines the width of this frame in pixels. The default value is 10.

FieldComponentsForDetectors

HarmonicFieldComponents [] FieldComponentsForDetectors

getset

Gets and sets which field components are calculated by default for certain detectors (currently Camera Detector, Electromagnetic Field Detector, PSF & MTF, Power).

FieldSizeFactor

double FieldSizeFactor

getset

Gets and sets the default oversampling factor.

FormatOfComplexNumbers

ComplexToStringConversionFormat FormatOfComplexNumbers

getset

Gets and sets how complex numbers are formatted as strings.

FormatOfPhysicalValues

AxisNumberFormat? FormatOfPhysicalValues

getset

Gets and sets the format of physical values (Standard, Scientific or Engineering; null means automatic selection).

GUI_Font

Font GUI_Font

getset

Gets and sets the font generally used in the VirtualLab Graphical User Interface. The get-branch returns a copy of the actual font object, as assigning a font reference to e.g. a label and disposing the label afterwards destroys the font and thus the VirtualLab GUI.

InitialWindowSize

Size InitialWindowSize

getset

Default client size for result document windows (harmonic fields, harmonic fields set, diagrams, data arrays and derived objects).

IsComparerTestMode

bool IsComparerTestMode

staticget

Gets and sets whether we are currently doing comparer or unit tests.

IsDesignMode

bool IsDesignMode

staticgetset

Gets and sets whether we are currently in the VisualStudio Designer.

LengthUnit

LengthUnits LengthUnit

getset

Gets and sets the default length unit which is used if a pure double value is to be parsed into a length.

MainWindowTheme

Themes MainWindowTheme

getset

Gets and sets the theme currently applied to the main window.

MaximumNumberOfSnapshotFiles

int MaximumNumberOfSnapshotFiles

getset

Gets and sets the maximum number of snapshot files stored per document.

NotifyIconMode

NotifyIconVisibility NotifyIconMode

getset

Gets and sets when the notify icon and notifications are visible.

OfflineMode

bool OfflineMode

getset

Gets and sets whether VirtualLab is in offline mode, i.e. no Internet access is done.

OversamplingFactor

double OversamplingFactor

getset

Gets and sets the default oversampling factor.

RelativeEdgeWidth

double RelativeEdgeWidth

getset

VirtualLab uses smooth edges for defining the aperture. The width of the edges is defined as relative value wrt. the field size. The default value is 0.1 (10 percent).

SamplingDistance

VectorD SamplingDistance

getset

Gets and sets the default sampling distance in meters for newly generated fields.

SamplingPoints

Vector SamplingPoints

getset

Gets and sets the default number of sampling points for newly generated fields.

Settings3DView

ViewSettings3DView Settings3DView

getset

Gets and sets the default view settings for the 3D view.

ShowMinimap

bool ShowMinimap

getset

Gets and sets whether a minimap (extended scrollbar) is shown to the right.

SourceCodeEditorTheme

PredefinedCodeEditorTheme SourceCodeEditorTheme

getset

Gets and sets whether the source code editor shall use a dark mode or the normal bright mode.

StoreSnapshotFiles

bool StoreSnapshotFiles

getset

Gets and sets whether snapshot files are generated every time a document changes.

TitleFontSize

float TitleFontSize

getset

Gets and sets the default font size of diagram titles for 2D diagrams.

UseComponentCSforStackPreview

bool UseComponentCSforStackPreview

getset

Gets and sets whether the stack preview uses the coordinate system of the parent component. In this case the preview is rotated and flipped as needed. Otherwise always the stack coordinate system is used, which means that interfaces run from left to right.

UseEmbeddingForOperations

bool UseEmbeddingForOperations

getset

Gets and sets whether an embedding is to be used for Field * Transmission Operations.

UseOrthogonalLinkagesInOpticalSetupView

bool UseOrthogonalLinkagesInOpticalSetupView

getset

Gets and sets whether the linkages of an Optical Setup are drawn in the flowchart with orthogonal (true) or straight (false) connector lines.

UseRecommendedFont

bool UseRecommendedFont

getset

Gets and sets whether a preset font is used (true) or whether the user configures the font individually (false).

UseTransparencyForClipboard

bool UseTransparencyForClipboard

getset

Gets and sets whether document windows copied to the clipboard have a transparent background.

UseZOSAPI

bool UseZOSAPI

getset

Gets and sets whether the ZOSAPI_NetHelper.dll (and thus Zemax OpticStudio®) is used for the import of Zemax files.

Wavelength

double Wavelength

getset

Gets and sets the default wavelength in \(\mathrm{m}\).