mi32/colorspread.h

Go to the documentation of this file.

#ifndef  INC_MI32_COLORSPREAD_H
#define  INC_MI32_COLORSPREAD_H

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_COLOR_H
#include <mi32/color.h>
#endif

#ifndef  GENERATING_DOXYGEN_OUTPUT
class COLOR_ARRAY;
class SERIALIZERITEM;
#endif

class COLORSPREAD {
   public:

      enum TYPE {
         TYPE_Manual =     0,
         TYPE_Standard =   1,
         TYPE_User =       2
         };

      enum PATH {
         PATH_Longest =       0,
         PATH_RGB,
         PATH_HISCW,
         PATH_HISCCW,
         PATH_HBSCW,
         PATH_HBSCCW,
         PATH_COUNT
         };

      static const SERIALIZERITEM* SerialGetItemDef ();

      COLORSPREAD ();

      ~COLORSPREAD ();

      ERRVALUE ComputePalette (
         COLOR_ARRAY& palette,      
         int NumColors              
         ) const;

      const COLOR& GetColorBegin () const
         { return (m_ColorBegin); }

      const COLOR& GetColorEnd () const
         { return (m_ColorEnd); }

      const MISTRING& GetName () const
         { return (m_Name); }

      PATH GetPath () const
         { return (m_Path); }

      TYPE GetType () const
         { return (m_Type); }

      void IniRead (
         INIHANDLE *inihnd,
         const char *IniGroup,
         const char *IniName
         );

      void IniWrite (
         INIHANDLE *inihnd,
         const char *IniGroup,
         const char *IniName
         ) const;

      bool IsReversed () const
         { return (m_IsReversed); }

      void SetColorBegin (
         const COLOR& color
         ) { m_ColorBegin = color; }

      void SetColorEnd (
         const COLOR& color
         ) { m_ColorEnd = color; }

      void SetManual (
         const COLOR& ColorBegin,
         const COLOR& ColorEnd,
         PATH path
         ) { m_Type = TYPE_Manual; m_ColorBegin = ColorBegin; m_ColorEnd = ColorEnd; m_Path = path; }

      void SetNamed (
         const MISTRING& name,
         TYPE type = TYPE_Standard
         ) { m_Type = type; m_Name = name; }

      void SetPath (
         PATH path
         ) { m_Path = path; }

      void SetReversed (
         bool reversed              
         ) { m_IsReversed = reversed; }

      void SetType (
         TYPE type                  
         ) { m_Type = type; }

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      TYPE m_Type;
      PATH m_Path;
      COLOR m_ColorBegin;
      COLOR m_ColorEnd;
      MISTRING m_Name;
      bool m_IsReversed;
      #endif
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_INCREMENT(COLORSPREAD::PATH)
#endif

#endif   // INC_MI32_COLORSPREAD_H

---