Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Tools::Sequences::IFromPathAnalysisGenerationSettings

Last update: 13.03.2026

Definition:

Sequence generation settings interface for the From Path Analysis Filters mode.

Inherits from:

Members

Properties

Property FilterNumber

Definition:

int ZOSAPI.Tools.Sequences.IFromPathAnalysisGenerationSettings.FilterNumber

The number of the Path Analysis generated filter to generate sequence(s) from / up to. Setting this to zero (which is the default), or a negative number, results in sequences for all path filters being generated.

If IncludeAllUpToFilterNumber is true, then sequences will be generated from all path filters up to and including this number. Otherwise, only the path at this exact filter number.

Return type: int

Property IncludeAllUpToFilterNumber

Definition:

bool ZOSAPI.Tools.Sequences.IFromPathAnalysisGenerationSettings.IncludeAllUpToFilterNumber

Whether to generate sequences from all Path Analysis filters up to and including FilterNumber. Defaults to true.

Return type: bool

Connect with Ansys