TXSLib : Class TCircularScalarWidget
La classe TCircularScalarWidget est parente de toutes les classes de widgets qui représentent une valeur numérique scalaire par un visualisation sur un axe circulaire.
Elle complémente donc la classe TScalarWidget en ajoutant un axe circulaire et la gestion de la visualisation des zones de couleurs le long de cet axe.
La classe TCircularScalarWidget est abstraite, vous ne pouvez pas créer un objet de ce type.
Relations d'héritage
- Hérite de :
- TScalarWidget.
- Est Héritée par :
- TCompass
- TKnob
- TMeter
Propriétés de l'axe circulaire
Note : Toutes les propriétés définissant l'axe circulaire sont implémentées au moyen de fonctions virtuelles pour l'écriture de la valeur de ces propriétés. Cela implique que les classes qui héritent de TCircularScalarWidget peuvent surcharger ces fonctions.
| Propriétés | Type | Ecriture | Lecture |
| ScaleColor | QColor | SetScaleColor | GetScaleColor |
| ScaleDigitsAfterDecimalSeparator | int | SetScaleDigitsAfterDecimalSeparator | GetScaleDigitsAfterDecimalSeparator |
| ScaleDigitsBeforeDecimalSeparator | int | SetScaleDigitsBeforeDecimalSeparator | GetScaleDigitsBeforeDecimalSeparator |
| ScaleExcursion | double | SetScaleExcursion | GetScaleExcursion |
| ScaleLabelsColor | QColor | SetScaleLabelsColor | GetScaleLabelsColor |
| ScaleLabelsFont | QFont | SetScaleLabelsFont | GetScaleLabelsFont |
| ScaleLabelsNumberFormat | TXS::NumberFormat | SetScaleLabelsNumberFormat | GetScaleLabelsNumberFormat |
| ScaleLabelsVisible | bool | SetScaleLabelsVisible | GetScaleLabelsVisible |
| ScaleMinorTicksSize | int | SetScaleMinorTicksSize | GetScaleMinorTicksSize |
| ScaleMinorTicksVisible | bool | SetScaleMinorTicksVisible | GetScaleMinorTicksVisible |
| ScaleNumberOfMinorTicks | int | SetScaleNumberOfMinorTicks | GetScaleNumberOfMinorTicks |
| ScaleNumberOfTicks | int | SetScaleNumberOfTicks | GetScaleNumberOfTicks |
| ScaleOrigin | double | SetScaleExcursion | GetScaleOrigin |
| ScaleStyle | TXS::LineStyle | SetScaleStyle | GetScaleStyle |
| ScaleThickness | int | SetScaleThickness | GetScaleThickness |
| ScaleTicksColor | QColor | SetScaleTicksColor | GetScaleTicksColor |
| ScaleTicksInterval | double | SetScaleTicksInterval | GetScaleTicksInterval |
| ScaleTicksSize | int | SetScaleTicksSize | GetScaleTicksSize |
| ScaleTicksSpecification | TXS::TicksSpecification | SetScaleTicksSpecification | GetScaleTicksSpecification |
| ScaleTicksVisible | bool | SetScaleTicksVisible | GetScaleTicksVisible |
| ScaleVisible | bool | SetScaleVisible | IsScaleVisible |
Propriétés de visualisation des zones de couleurs
| Propriétés | Type | Ecriture | Lecture |
| AutoAdjustColorZonesLeds | bool | SetAutoAdjustColorZonesLeds | GetAutoAdjustColorZonesLeds |
| ColorZonesBackColor | QColor | SetColorZonesBackColor | GetColorZonesBackColor |
| ColorZonesBlocks | int | SetColorZonesBlocks | GetColorZonesBlocks |
| ColorZonesBlocksWidth | int | SetColorZonesBlocksWidth | GetColorZonesBlocksWidth |
| ColorZonesIsTransparent | bool | SetColorZonesIsTransparent | GetColorZonesIsTransparent |
| ColorZonesLedsVisible | bool | SetColorZonesLedsVisible | GetColorZonesLedsVisible |
| ColorZonesStyle | TXS::KnobColorZonesStyle | SetColorZonesStyle | GetColorZonesStyle |
| ColorZonesThickness | int | SetColorZonesThickness | GetColorZonesThickness |
| DefaultColorZonesLedsColorAboveCursor | QColor | SetDefaultColorZonesLedsColorA... | GetDefaultColorZonesLedsColorA... |
| DefaultColorZonesLedsColorBelowCursor | QColor | SetDefaultColorZonesLedsColorB... | GetDefaultColorZonesLedsColorB... |
| DefaultOutOfBoundsColorZonesLedsColor | QColor | SetDefaultOutOfBoundsColorZ... | GetDefaultOutOfBoundsColorZ... |
| OutOfBoundsColorZonesLedsVisible | bool | SetOutOfBoundsColorZonesLeds... | GetOutOfBoundsColorZonesLeds... |
| Use3DEffectForColorZones | bool | SetUse3DEffectForColorZones | GetUse3DEffectForColorZones |
Détails des propriétés de l'axe circulaire
Description : Cette propriété définie la couleur de l'axe.
Plus de détails : Gestion des axes
Type : QColor
Valeur par défaut : Couleur de la palette courante de l'application avec le rôle "QPalette::ButtonText" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : virtual void SetScaleColor(const QColor& Color);
Lecture : QColor GetScaleColor();
Description : Cette propriété définie le nombre de chiffres après le séparateur décimal. Le comportement de cette propriété dépend de la valeur de la propriété ScaleLabelsNumberFormat.
Plus de détails : Formatage des nombres
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 6
Ecriture : virtual void SetNumericIndicatorDigitsAfterDecimalSeparator(const int& nDigits)
Lecture : int GetNumericIndicatorDigitsAfterDecimalSeparator();
Description : Cette propriété définie le nombre de chiffres avant le séparateur décimal. Le comportement de cette propriété dépend de la valeur de la propriété ScaleLabelsNumberFormat.
Plus de détails : Formatage des nombres
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 6
Ecriture : virtual void SetScaleDigitsBeforeDecimalSeparator(const int& nDigits)
Lecture : int GetScaleDigitsBeforeDecimalSeparator();
Description : Cette propriété définie la longueur de l'axe exprimée en degrés d'angle. Elle est définie par une fonction qui définie également la propriété ScaleOrigin car ces deux propriétés sont étroitement liées. Cela permet de vérifier leur adéquation l'une avec l'autre. L'origine de l'axe circulaire est située au point cardinal Ouest. Le sens de rotation positif est le sens des aiguilles d'une montre. La valeur de l'excursion doit être comprise en 10 et 350. La valeur de l'origine doit être comprise entre 0 et 360. Le paramètre "FullExcursion" permet de régler une excursion à 360°. Il doit toujours être à la valeur false sauf dans le cas de la classe héritante "TCompass" qui est une exception. Cette classe surcharge la fonction "SetScaleExcursion" pour imposer un cercle complet pour la rose des vents.
Plus de détails : Gestion des axes
Type : double
Valeur par défaut : 300
Ecriture : virtual bool SetScaleExcursion(const double& Origin, const double& Excursion, const bool& FullExcursion = false)
Lecture : bool GetScaleExcursion();
Description : Cette propriété définie la couleur des étiquettes des graduations principales de l'axe.
Plus de détails : Gestion des axes
Type : QColor
Valeur par défaut : Couleur de la palette courante de l'application avec le rôle "QPalette::ButtonText" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : virtual void SetScaleLabelsColor(const QColor& Color);
Lecture : QColor GetScaleLabelsColor();
Description : Cette propriété définie la police de caractères des étiquettes des graduations principales de l'axe.
Plus de détails : Gestion des axes
Type : QFont
Valeur par défaut : Police par défaut de l'application
Ecriture : virtual void SetScaleLabelsFont(const QFont& Font);
Lecture : QFont GetScaleLabelsFont();
Description : Cette propriété définie le format d'affichage des nombres des étiquettes des graduations principales de l'axe.
Plus de détails : Formatage des nombres
Type : TXS::NumberFormat
Valeur par défaut : TXS::NumberFormat_Any_Compact.
Ecriture : virtual void SetScaleLabelsNumberFormat(const TXS::NumberFormat& Format)
Lecture : TXS::NumberFormat GetScaleLabelsNumberFormat();
Description : Cette propriété définie si les étiquettes des graduations principales de l'axe sont visibles ou non.
Plus de détails : Formatage des nombres
Type : bool
Valeur par défaut : true
Ecriture : virtual void SetScaleLabelsVisible(const bool& Tf)
Lecture : bool GetScaleLabelsVisible();
Description : Cette propriété définie la longueur en pixels des graduations secondaires de l'axe.
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 5
Ecriture : virtual void SetScaleMinorTicksSize(const int& Size)
Lecture : int GetScaleMinorTicksSize();
Description : Cette propriété définie si les graduations secondaires de l'axe sont visibles ou non.
Plus de détails : Gestion des axes
Type : bool
Valeur par défaut : true
Ecriture : virtual void SetScaleMinorTicksVisible(const bool& Tf)
Lecture : bool GetScaleMinorTicksVisible();
Description : Cette propriété définie le nombre de graduations secondaires entre deux graduations principales de l'axe.
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 5
Ecriture : virtual void SetScaleNumberOfMinorTicks(const int& Ticks)
Lecture : int GetScaleNumberOfMinorTicks();
Description : Cette propriété définie le nombre de graduations principales de l'axe. Le comportement de cette propriété est liée à la valeur courante de la propriété ScaleTicksSpecification. Selon la valeur de cette dernière la propriété "ScaleNumberOfTicks" sera ou non prise en compte.
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 11
Ecriture : virtual void SetScaleNumberOfTicks(const int& Ticks)
Lecture : int GetScaleNumberOfTicks();
Description : Cette propriété définie l'origine de l'axe exprimée en degrés d'angle. Elle est définie par une fonction qui définie également la propriété ScaleExcursion car ces deux propriétés sont étroitement liées. Cela permet de vérifier leur adéquation l'une avec l'autre. L'origine de l'axe circulaire est située au point cardinal Ouest. Le sens de rotation positif est le sens des aiguilles d'une montre. La valeur de l'excursion doit être comprise en 10 et 350. La valeur de l'origine doit être comprise entre 0 et 360. Le paramètre "FullExcursion" permet de régler une excursion à 360°. Il doit toujours être à la valeur false sauf dans le cas de la classe héritante "TCompass" qui est une exception. Cette classe surcharge la fonction "SetScaleExcursion" pour imposer un cercle complet pour la rose des vents.
Plus de détails : Gestion des axes
Type : double
Valeur par défaut : -60
Ecriture : virtual bool SetScaleExcursion(const double& Origin, const double& Excursion, const bool& FullExcursion = false)
Lecture : bool GetScaleOrigin();
Description : Cette propriété définie le style de ligne de l'axe.
Type : TXS::LineStyle
Valeur par défaut : TXS::SolidLine
Ecriture : virtual void SetScaleStyle(const TXS::LineStyle& Style)
Lecture : TXS::LineStyle GetScaleStyle();
Description : Cette propriété définie l'épaisseur de la ligne d'axe.
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 1
Ecriture : virtual void SetScaleThickness(const int& Thickness)
Lecture : int GetScaleThickness();
Description : Cette propriété définie la couleur des graduations de l'axe.
Plus de détails : Gestion des axes
Type : QColor
Valeur par défaut : Couleur de la palette courante de l'application avec le rôle "QPalette::ButtonText" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : virtual void SetScaleTicksColor(const QColor& Color);
Lecture : QColor GetScaleTicksColor();
Description : Cette propriété définie l'intervalle entre les graduations principales de l'axe. Le comportement de cette propriété est liée à la valeur courante de la propriété ScaleTicksSpecification. Selon la valeur de cette dernière la propriété "ScaleTicksInterval" sera ou non prise en compte.
Plus de détails : Gestion des axes
Type : double
Valeur par défaut : 10
Ecriture : virtual void SetScaleTicksInterval(const double& Interval)
Lecture : double GetScaleTicksInterval();
Description : Cette propriété définie la longueur en pixels des graduations principales de l'axe.
Plus de détails : Gestion des axes
Type : int
Valeur par défaut : 10
Ecriture : virtual void SetScaleTicksSize(const int& Size)
Lecture : int GetScaleTicksSize();
Description : Cette propriété définie le choix de l'algorithme de calcul des valeurs des graduations principales de l'axe.
Une explication détaillée est documentée à la page : Gestion des axes
Type : TXS::TicksSpecification
Valeur par défaut : TXS::TicksSpecification_Adjusted
Ecriture : virtual void SetScaleTicksSpecification(const TXS::TicksSpecification& Specification)
Lecture : TXS::TicksSpecification GetScaleTicksSpecification();
Description : Cette propriété définie si les graduations principales de l'axe sont visibles ou non.
Plus de détails : Gestion des axes
Type : bool
Valeur par défaut : true
Ecriture : virtual void SetScaleTicksVisible(const bool& Tf)
Lecture : bool GetScaleTicksVisible();
Description : Cette propriété définie si l'axe est visible ou non.
Plus de détails : Gestion des axes
Type : bool
Valeur par défaut : true
Ecriture : virtual void SetScaleVisible(const bool& Tf)
Lecture : bool IsScaleVisible();
Détails des propriétés de visualisation des zones de couleurs
Description : Cette propriété définie si les paramètres de visualisation des zones de couleurs sont calculés automatiquement ou non.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : bool
Valeur par défaut : true
Ecriture : void SetAutoAdjustColorZonesLeds(const bool& Tf)
Lecture : bool GetAutoAdjustColorZonesLeds();
Description : Cette propriété définie la couleur de fond de la zone de visualisation des zones de couleurs.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : QColor
Valeur par défaut : Blanc
Ecriture : void SetColorZonesBackColor(const QColor& Color);
Lecture : QColor GetColorZonesBackColor();
Description : Cette propriété définie le nombre de blocs de zones de couleurs le long de l'axe. Le comportement de cette propriété dépend de la valeur des propriétés AutoAdjustColorZonesLeds et ColorZonesStyle.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : int
Valeur par défaut : 50
Ecriture : SetColorZonesBlocks(const int& nTicks);
Lecture : int GetColorZonesBlocks();
Description : Cette propriété définie la taille des blocs de zones de couleurs le long de l'axe. Le comportement de cette propriété dépend de la valeur des propriétés AutoAdjustColorZonesLeds et ColorZonesStyle.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : int
Valeur par défaut : 12
Ecriture : SetColorZonesBlocksWidth(const int& nWwiidth);
Lecture : int GetColorZonesBlocksWidth();
Description : Cette propriété définie si la zone des zones de couleur doit avoir un fond transparent ou non. Si le fond n'est pas transparent il sera de la couleur de la propriété ColorZonesBackColor.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : bool
Valeur par défaut : true
Ecriture : void SetColorZonesIsTransparent(const bool& Tf)
Lecture : bool GetColorZonesIsTransparent();
Description : Cette propriété définie si les blocs leds des zones de couleurs sont visibles ou non.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : bool
Valeur par défaut : true
Ecriture : void SetColorZonesLedsVisible(const bool& Tf)
Lecture : bool GetColorZonesLedsVisible();
Description : Cette propriété définie le style de visualisation des zones de couleurs.
Type : TXS::KnobColorZonesStyle
Valeur par défaut : TXS::KnobColorZonesStyle_Dots
Ecriture : void SetColorZonesStyle(const TXS::KnobColorZonesStyle& Specification)
Lecture : TXS::KnobColorZonesStyle GetColorZonesStyle();
Description : Cette propriété définie l'épaisseur de la zone de visualisation des zones de couleur le ong du rayon de l'axe circulaire.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : int
Valeur par défaut : 20
Ecriture : SetColorZonesThickness(const int& nWidth);
Lecture : int GetColorZonesThickness();
Description : Cette propriété définie la couleur de la zone des zones de couleurs pour les valeurs supérieures à la valeur de la propriété "Value" de l'objet.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : QColor
Valeur par défaut : QColor(132,8,8,255) (Rouge très foncé)
Ecriture : void SetDefaultColorZonesLedsColorAboveCursor(const QColor& Color);
Lecture : QColor GetDefaultColorZonesLedsColorAboveCursor();
Description : Cette propriété définie la couleur de la zone des zones de couleurs pour les valeurs inférieures à la valeur de la propriété "Value" de l'objet lorsque cette valeur n'est pas comprise entre tous les seuils hauts et bas de toutes les zones de couleurs définies.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : QColor
Valeur par défaut : QColor(255,5,5,255) (Rouge)
Ecriture : void SetDefaultColorZonesLedsColorBelowCursor(const QColor& Color);
Lecture : QColor GetDefaultColorZonesLedsColorBelowCursor();
Description : Cette propriété définie la couleur des blocs led de la zone de visualisation des zones de couleurs pour les valeurs d'echelle de l'axe non comprises dans la gamme de valeurs spécifiée. En effet, selon l'alogrithme utilisé pour calculer les valeurs extrêmes de l'axe, il est possible que celui-ci prenne des valeurs différentes afin d'améliorer la lecture des graduations. Dans ce cas la zone de visualisation des zones de couleurs peut couvrir une zone qui ne sera jamais atteinte par la propriété "Value" de l'objet. Cette propriété définie la couleur de cettet zone non couverte.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : QColor
Valeur par défaut : QColor(128,128,128,255); (GRis moyen)
Ecriture : void SetDefaultOutOfBoundsColorZonesLedsColor(const QColor& Color);
Lecture : QColor GetDefaultOutOfBoundsColorZonesLedsColor();
Description : Cette propriété définie si les blocs leds des zones de couleurs hors gamme sont visibles ou non. Voir la propriété DefaultOutOfBoundsColorZonesLedsColor.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : bool
Valeur par défaut : true
Ecriture : void SetOutOfBoundsColorZonesLedsVisible(const bool& Tf)
Lecture : bool GetOutOfBoundsColorZonesLedsVisible();
Description : Cette propriété définie si les blocs leds des zones de couleurs sont affiché avec un effet 3D ou non.
Plus de détails : Généralités sur les zones de couleurs
Plus de détails : Visualisation des zones de couleurs sur axe circulaire
Type : bool
Valeur par défaut : true
Ecriture : void SetUse3DEffectForColorZones(const bool& Tf)
Lecture : bool GetUse3DEffectForColorZones();