Classes > WaveformAnalyzer class > Data structures > WANALYZER_VERTICAL

The WANALYZER_VERTICAL_LINE structure describes settings applied to a vertical line added to the Waveform Analyzer through the WaveformAnalyzer.GraphicItemVerticalLineAdd method. The current settings can be retrieved through the WaveformAnalyzer.GraphicItemVerticalLineParamsGet method and modified through the WaveformAnalyzer.GraphicItemVerticalLineParamsSet method.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

This structure can be also used with vertical lines added to the TracksBoard through the TracksBoard.VerticalLineAdd method. Current settings can be retrieved through the TracksBoard.VerticalLineParamsGet method and modified through the TracksBoard.VerticalLineParamsSet method.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard object section.

C# definition

public struct WANALYZER_VERTICAL_LINE

{

public Color color;

public enumWaveformLineDashStyles nDashStyle;

public Int16 nWidth;

public Int16 nTranspFactor;

public enumLineCaps nHighCap;

public enumLineCaps nLowCap;

public enumLineDashCaps nDashCap;

}

Member

Description

color

Color used for rendering the line.

nDashStyle

Line dash style.

Supported values are the following:

Mnemonic constant	Value	Meaning
LINE_DASH_STYLE_SOLID	0	Solid line.
LINE_DASH_STYLE_DASH	1	Dashed line.
LINE_DASH_STYLE_DOT	2	Dotted line.
LINE_DASH_STYLE_DASH_DOT	3	Alternating dash-dot line line.
LINE_DASH_STYLE_DASH_DOT_DOT	4	Alternating dash-dot-dot line line.

On the screenshot below you can see the different types of vertical lines with the corresponding value displayed on the buddy text:

nWidth

Line width in pixels.

nTranspFactor

Transparent factor. This value can range from 0 (total opacity) to 255 (total transparency). Values outside of this range will be automatically capped to the nearest valid value.

nHighCap

Type of cap for the high end of the line.

Supported values are the following:

Mnemonic constant	Value	Meaning
LINE_CAP_SQUARE	0	Specifies a square cap.
LINE_CAP_ROUND	1	Specifies a circular cap.
LINE_CAP_TRIANGLE	2	Specifies a triangular cap.
LINE_CAP_SQUARE_ANCHOR	3	Specifies that the line ends are anchored with a square.
LINE_CAP_ROUND_ANCHOR	4	Specifies that the line ends are anchored with a circle.
LINE_CAP_DIAMOND_ANCHOR	5	Specifies that the line ends are anchored with a diamond.
LINE_CAP_ARROW_ANCHOR	6	Specifies that the line ends are anchored with arrowheads.

On the screenshot below you can see the different types of line caps with the corresponding value displayed on the buddy text:

nLowCap

Type of cap for the low end of the line.

Supported values are the same as seen for the nHighCap field above.

nDashCap

Type of dash/dot cap for the line.

Supported values are the following:

Mnemonic constant	Value	Meaning
LINE_DASH_CAP_FLAT	0	Specifies a square cap that squares off both ends of each dash.
LINE_DASH_CAP_ROUND	1	Specifies a circular cap that rounds off both ends of each dash.
LINE_DASH_CAP_TRIANGLE	2	Specifies a triangular cap that points both ends of each dash.

On the screenshot below you can see the different types of line dash caps with the corresponding value displayed on the buddy text: