lib/maracasVisuLib/src/interface/wxWindows/widgets/pPlotter/pColorPoint.h

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26 #ifndef __pColorPoint_h__
  27 #define __pColorPoint_h__
  28
  29 //------------------------------------------------------------------------------------------------------------
  30 // WX headers inclusion.
  31 // For compilers that support precompilation, includes <wx/wx.h>.
  32 //------------------------------------------------------------------------------------------------------------
  33
  34 #include <wx/wxprec.h>
  35 #ifdef __BORLANDC__
  36 #pragma hdrstop
  37 #endif
  38 #ifndef WX_PRECOMP
  39 #include <wx/wx.h>
  40 #endif
  41
  42 //------------------------------------------------------------------------------------------------------------
  43 // Class definition
  44 //------------------------------------------------------------------------------------------------------------
  45
  46 class pColorPoint : public wxObject {
  47
  48 public:
  49         //------------------------------------------------------------------------------------------------------------
  50         // Constructors and destructors
  51         //------------------------------------------------------------------------------------------------------------
  52
  53         /**
  54         * Create a point of the function.
  55         * @param x The x real value
  56         * @param _color The asigned colour
  57         * @param isTemp The temporal o fixed asignation to the color
  58         */
  59         pColorPoint(double  x , wxColour  col, bool isTemp);
  60
  61         ~pColorPoint();
  62
  63         //------------------------------------------------------------------------------------------------------------
  64         // Methods definition
  65         //------------------------------------------------------------------------------------------------------------
  66
  67         /*
  68         * Returns the x-value of the point
  69         * @retval realX
  70         */
  71         double getRealX ();
  72         /**
  73         * Returns the colour of the point
  74         * @retval colour
  75         */
  76         wxColor getColor ();
  77         /**
  78         * Sets the x-value of the point
  79         * @param x
  80         */
  81         void setRealX(double x)
  82         {
  83                 realX = x;
  84         }
  85         /**
  86         * Sets the  colour of the point
  87         * @param _col
  88         */
  89         void setColor(wxColour _col)
  90         {
  91                 colour = _col;
  92         }
  93
  94         /**
  95         * Indicates if the colour point is temporal or not
  96         * @retval isTemporal
  97         */
  98         bool isTemporalColor ();
  99
 100         //------------------------------------------------------------------------------------------------------------
 101         // Attributes declration
 102         //------------------------------------------------------------------------------------------------------------
 103
 104 private:
 105         /*
 106         * The x-value of the point
 107         */
 108         double realX;
 109         /*
 110         * The colour of the point
 111         */
 112         wxColour colour;
 113         /*
 114         * Represents the attibute of being temporal or not
 115         */
 116         bool isTemporal;
 117
 118         DECLARE_CLASS (pColorPoint)
 119 };
 120
 121 #endif
 122
 123