gdal_colortable.h

/******************************************************************************
 *
 * Name:     gdal_colortable.h
 * Project:  GDAL Core
 * Purpose:  Declaration of GDALColorTable class
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 1998, Frank Warmerdam
 * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef GDALCOLORTABLE_H_INCLUDED
#define GDALCOLORTABLE_H_INCLUDED
 
#include "cpl_port.h"
 
#include "gdal.h"
 
#include <memory>
#include <vector>
 
/* ******************************************************************** */
/*                             GDALColorTable                           */
/* ******************************************************************** */

 
class CPL_DLL GDALColorTable
{
    GDALPaletteInterp eInterp;
 
    std::vector<GDALColorEntry> aoEntries{};
 
  public:
    explicit GDALColorTable(GDALPaletteInterp = GPI_RGB);

    GDALColorTable(const GDALColorTable &) = default;

    GDALColorTable &operator=(const GDALColorTable &) = default;

    GDALColorTable(GDALColorTable &&) = default;

    GDALColorTable &operator=(GDALColorTable &&) = default;
 
    ~GDALColorTable();
 
    GDALColorTable *Clone() const;
    int IsSame(const GDALColorTable *poOtherCT) const;
 
    GDALPaletteInterp GetPaletteInterpretation() const;
 
    int GetColorEntryCount() const;
    const GDALColorEntry *GetColorEntry(int i) const;
    int GetColorEntryAsRGB(int i, GDALColorEntry *poEntry) const;
    void SetColorEntry(int i, const GDALColorEntry *poEntry);
    int CreateColorRamp(int nStartIndex, const GDALColorEntry *psStartColor,
                        int nEndIndex, const GDALColorEntry *psEndColor);
    bool IsIdentity() const;
 
    static std::unique_ptr<GDALColorTable>
    LoadFromFile(const char *pszFilename);

    static inline GDALColorTableH ToHandle(GDALColorTable *poCT)
    {
        return static_cast<GDALColorTableH>(poCT);
    }

    static inline GDALColorTable *FromHandle(GDALColorTableH hCT)
    {
        return static_cast<GDALColorTable *>(hCT);
    }
};
 
#endif