Public Member Functions
void	LoadLens (bool saveIfNeeded)
	Loads this lens. Note that the current system will be replaced entirely.

IOpticalSystem	LoadNewLensSeq ()
	Creates a new sequential system from this lens.

IOpticalSystem	LoadNewLensNonSeq ()
	Creates a new non-sequential system from this lens.

bool	InsertLensSeq (int atSurface, bool ignoreObject, bool reverseSurfGeom)
	Inserts this lens into the current sequential system, at the specific surface. Note that this will fail if the current system is not sequential.

bool	InsertLensNonSeq ()
	Convert this lens to non-sequential components, and add them to the end of the current system. Note that this will fail if the current system is sequential.

Properties
string	Vendor `[get]`

string	LensName `[get]`

double	EFL `[get]`

double	EPD `[get]`

LensShape	Shape `[get]`

LensType	Type `[get]`

int	NumberOfElements `[get]`

bool	Telecentric `[get]`

Member Function Documentation

◆ InsertLensNonSeq()

bool ZOSAPI.Tools.General.ILensCatalogLens.InsertLensNonSeq ( )

Convert this lens to non-sequential components, and add them to the end of the current system. Note that this will fail if the current system is sequential.

Returns: true if the lens was inserted; otherwise false.

◆ InsertLensSeq()

bool ZOSAPI.Tools.General.ILensCatalogLens.InsertLensSeq	(	int	atSurface,
		bool	ignoreObject,
		bool	reverseSurfGeom
	)

Inserts this lens into the current sequential system, at the specific surface. Note that this will fail if the current system is not sequential.

Parameters

atSurface	Position to insert the lens.
ignoreObject
reverseSurfGeom	Change sign of surface geometry in mirror space.

Returns: true if the lens was inserted; otherwise false.

◆ LoadLens()

void ZOSAPI.Tools.General.ILensCatalogLens.LoadLens ( bool saveIfNeeded )

Loads this lens. Note that the current system will be replaced entirely.

Parameters

saveIfNeeded If set to true, the current system will be saved (if needed) before loading the new lens.

◆ LoadNewLensNonSeq()

IOpticalSystem ZOSAPI.Tools.General.ILensCatalogLens.LoadNewLensNonSeq ( )

Creates a new non-sequential system from this lens.

Returns: The new system

◆ LoadNewLensSeq()

IOpticalSystem ZOSAPI.Tools.General.ILensCatalogLens.LoadNewLensSeq ( )

Creates a new sequential system from this lens.

Returns: The new system

Property Documentation

◆ EFL

double ZOSAPI.Tools.General.ILensCatalogLens.EFL

get

◆ EPD

double ZOSAPI.Tools.General.ILensCatalogLens.EPD

get

◆ LensName

string ZOSAPI.Tools.General.ILensCatalogLens.LensName

get

◆ NumberOfElements

int ZOSAPI.Tools.General.ILensCatalogLens.NumberOfElements

get

◆ Shape

LensShape ZOSAPI.Tools.General.ILensCatalogLens.Shape

get

◆ Telecentric

bool ZOSAPI.Tools.General.ILensCatalogLens.Telecentric

get

◆ Type

LensType ZOSAPI.Tools.General.ILensCatalogLens.Type

get

◆ Vendor

string ZOSAPI.Tools.General.ILensCatalogLens.Vendor

get

ZOS-API interface 2025 R2

ZOSAPI.Tools.General.ILensCatalogLens Interface Reference

Public Member Functions

Properties