Copyright © 2008-2013 MultiMedia Soft

WANALYZER_RULERS_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The WANALYZER_RULERS_SETTINGS structure describes settings applied while rendering the time and amplitude rulers on the Waveform Analyzer. The current settings can be retrieved through the SettingsRulersGet method and modified through the SettingsRulersSet method.

 

 

C# definition

 

public class WANALYZER_RULERS_SETTINGS

{

     public enumVolumeScales nAmplitudeScale;

     public bool bVisibleLeft;

     public bool bTicksLeft;

     public bool bVisibleRight;

     public bool bTicksRight;

     public bool bVisibleTop;

     public bool bTicksTop;

     public bool bVisibleBottom;

     public bool bTicksBottom;

     public Color colorBackground;

     public Color colorTicks;

     public Color colorText;

     public Int16 nTopRulerHeightInPix;

     public Int16 nBottomRulerHeightInPix;

     public Int16 nVertRulerWidthInPix;

     public float fTimeTicksFrequencyInPix;

};

 

 

Member

Description

 

 

nAmplitudeScale

Scale used for vertical rulers indicating waveform amplitude.

Supported values are the following:

Mnemonic constant

Value

Meaning

SCALE_LINEAR (default)

0

Linear mode

SCALE_LOG

1

Logarithmic mode

bVisibleLeft

Boolean value that specifies if the left amplitude ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display left amplitude ruler

True (default)

Displays left amplitude ruler

bTicksLeft

Boolean value that specifies if the left amplitude ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the left amplitude ruler

True (default)

Displays ticks for the left amplitude ruler

bVisibleRight

Boolean value that specifies if the right amplitude ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display right amplitude ruler

True (default)

Displays right amplitude ruler

bTicksRight

Boolean value that specifies if the right amplitude ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the right amplitude ruler

True (default)

Displays ticks for the right amplitude ruler

bVisibleTop

Boolean value that specifies if the top time ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display top time ruler

True (default)

Displays top time ruler

bTicksTop

Boolean value that specifies if the top time ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the top time ruler

True (default)

Displays ticks for the top time ruler

bVisibleBottom

Boolean value that specifies if the bottom time ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display bottom time ruler

True (default)

Displays bottom time ruler

bTicksBottom

Boolean value that specifies if the bottom time ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the bottom time ruler

True (default)

Displays ticks for the bottom time ruler

colorBackground

Color used for rendering the rulers background.

colorTicks

Color used for rendering rulers ticks.

colorText

Color used for rendering rulers texts.

nTopRulerHeightInPix

Height of the top time ruler in pixels.

The default value is 16 pixels.

nBottomRulerHeightInPix

Height of the bottom time ruler in pixels.

The default value is 16 pixels.

nVertRulerWidthInPix

Width of vertical amplitude rulers in pixels.

The default value is 41 pixels.

fTimeTicksFrequencyInPix

Frequency of the time ticks in pixels.

The default value is 40 pixels.