bmpalint.h

Go to the documentation of this file.
00001 // $Id: bmpalint.h 751 2006-03-31 15:43:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 // Bitmap export palette interface class that provides an interface
00099 // between the real palette and the sorted version of the palette
00100 
00101 #ifndef INC_BMPALINT
00102 #define INC_BMPALINT
00103 
00104 /**************************************************************************************
00105 >   class BitmapExportPaletteInterface : public CC_CLASS_MEMDUMP
00106     Author:     Jonathan_Payne (Xara Group Ltd) <camelotdev@xara.com>
00107     Created:    29/11/2000
00108     Purpose:    Provides an interface between the real palette and the sorted version
00109                 of the palette
00110 **************************************************************************************/
00111 class BitmapExportPaletteInterface : public CC_CLASS_MEMDUMP
00112 {
00113     // Declare the class for memory tracking
00114     CC_DECLARE_MEMDUMP(BitmapExportPaletteInterface);
00115 
00116 private:    // Private constants
00117     enum {
00118         MAX_PALETTE_ENTRYS      = 256
00119     };
00120 
00121 public:     // Public constants
00122     enum PaletteSortType{SORT_NONE, SORT_USE, SORT_LUMINANCE, SORT_HUE};
00123 
00124 private:    // Data
00125     // Array index == value in real palette, value == value in sorted palette
00126     INT32 m_PaletteRealToSorted[MAX_PALETTE_ENTRYS];
00127 
00128     // Array index == value in sorted palette, value == value in real palette
00129     INT32 m_PaletteSortedToReal[MAX_PALETTE_ENTRYS];
00130 
00131     PaletteSortType m_CurrentSortType;
00132 
00133 private:    // Statics
00134     // If this is false, we need to regenerate the arrays before using them again
00135     static bool m_SortedPaletteValid;
00136 
00137 public:     // Constructors
00138     BitmapExportPaletteInterface();
00139 
00140 public:     // Interface
00141     INT32       GetNumberOfColours();
00142 
00143     void            SetPaletteSortType(PaletteSortType newSortType);
00144     PaletteSortType GetPaletteSortType();
00145 
00146     BYTE    GetRed  (INT32 index);
00147     BYTE    GetGreen(INT32 index);
00148     BYTE    GetBlue (INT32 index);
00149     INT32       GetFlags(INT32 index);
00150 
00151     void    SetRed  (INT32 index, BYTE red);
00152     void    SetGreen(INT32 index, BYTE green);
00153     void    SetBlue (INT32 index, BYTE blue);
00154     void    SetFlags(INT32 index, INT32 flags);
00155 
00156     // Function to convert from a index in the sorted palette to an index in the real palette
00157     INT32       SortedValueToRealValue(INT32 index);
00158     INT32       RealValueToSortedValue(INT32 index);
00159 
00160 public:     // Static interface
00161     static void InvalidateSortedPalette();
00162 
00163 private:    // Implementation
00164     void ValidateSortedPalette();
00165 
00166 private:    // Static functions (so that they can be passed to qsort)
00167     static INT32 LuminanceComparisonFn(const INT32 *arg1, const INT32 *arg2);
00168     static INT32 HueComparisonFn(const INT32 *arg1, const INT32 *arg2);
00169 };
00170 
00171 #endif  // INC_BMPALINT

Generated on Sat Nov 10 03:44:27 2007 for Camelot by  doxygen 1.4.4