GiPalette.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __ODGIPALETTE_H__
#define __ODGIPALETTE_H__
 
#include "TD_PackPush.h"
 
#include "GiExport.h"
#include "OdArray.h"
#include "SharedPtr.h"
 
struct OdGiIntRGB
{
  OdInt32 r, g, b;
 
  OdGiIntRGB(OdInt32 _r, OdInt32 _g, OdInt32 _b)
    : r(_r), g(_g), b(_b)
  { }
  OdGiIntRGB() { }
  OdGiIntRGB(ODCOLORREF cref)
  {
    setColor(cref);
  }
 
  OdInt32 red() const { return r; }
  OdInt32 green() const { return g; }
  OdInt32 blue() const { return b; }
 
  void setRed(OdInt32 _r) { r = _r; }
  void setGreen(OdInt32 _g) { g = _g; }
  void setBlue(OdInt32 _b) { b = _b; }
  void setRGB(OdInt32 _r, OdInt32 _g, OdInt32 _b) { r = _r; g = _g; b = _b; }
 
  void setColor(ODCOLORREF cref)
  {
    setRGB((OdInt32)ODGETRED(cref), (OdInt32)ODGETGREEN(cref), (OdInt32)ODGETBLUE(cref));
  }
  ODCOLORREF color() const
  {
    return ODRGB(r, g, b);
  }
};
 
class ODGI_EXPORT OdGiColorCube
{
  protected:
    OdInt32    m_nBaseOffset;
    OdGiIntRGB m_nGridDivs;
    float      m_fIntensity;
    OdInt32    m_nGridSize;
    OdGiIntRGB m_nOffsets;
    OdGiIntRGB m_nDims;
  public:
    OdGiColorCube(OdGiIntRGB nGridDivs = OdGiIntRGB(2, 2, 2), float fIntensity = 1.0f, OdInt32 nBaseOffset = 0)
      : m_nBaseOffset(nBaseOffset)
      , m_nGridDivs(nGridDivs)
      , m_fIntensity(fIntensity)
    {
      validate();
    }
 
    OdInt32 baseOffset() const { return m_nBaseOffset; }
    const OdGiIntRGB &gridDivisions() const { return m_nGridDivs; }
    float intensity() const { return m_fIntensity; }
    OdInt32 gridSize() const { return m_nGridSize; }
    const OdGiIntRGB &offsets() const { return m_nOffsets; }
    const OdGiIntRGB &dimensions() const { return m_nDims; }
 
    ODCOLORREF color(OdInt32 nColor) const;
 
    OdInt32 closestMatch(ODCOLORREF cref) const;
 
    struct DtMatchResult
    {
      OdInt32 m_fitColors[4];
      OdInt32 m_pattern[4];
    };
 
    OdInt32 ditheredMatch(ODCOLORREF cref, DtMatchResult &results) const;
  protected:
    void validate();
};
 
class ODGI_EXPORT OdGiGrayRamp
{
  protected:
    OdInt32 m_nBaseOffset;
    OdInt32 m_nGridDivs;
    float m_fIntensity;
    OdInt32 m_nDim;
  public:
    OdGiGrayRamp(OdInt32 nGridDivs = 2, float fIntensity = 1.0f, OdInt32 nBaseOffset = 0)
      : m_nBaseOffset(nBaseOffset)
      , m_nGridDivs(nGridDivs)
      , m_fIntensity(fIntensity)
    {
      validate();
    }
 
    OdInt32 baseOffset() const { return m_nBaseOffset; }
    OdInt32 gridDivisions() const { return m_nGridDivs; }
    float intensity() const { return m_fIntensity; }
    OdInt32 dimension() const { return m_nDim; }
 
    ODCOLORREF color(OdInt32 nColor) const;
 
    OdInt32 closestMatch(ODCOLORREF cref) const;
  protected:
    void validate();
};
 
class ODGI_EXPORT OdGiPalette
{
  protected:
    struct PalEntry
    {
      ODCOLORREF m_color;
      OdInt32 m_entryHelper;
    };
    typedef OdArray<PalEntry, OdMemoryAllocator<PalEntry> > PalEntryArray;
  protected:
    PalEntryArray m_palette;
    OdSharedPtr<OdGiColorCube> m_pColorCube;
    OdSharedPtr<OdGiGrayRamp> m_pGrayRamp;
  public:
    OdGiPalette()
      : m_palette(256, 1)
    {
      initPalette();
    }
 
    ODCOLORREF color(OdUInt32 nColor) const
    {
      return m_palette[nColor].m_color;
    }
    OdInt32 entryHelper(OdUInt32 nColor) const
    {
      return m_palette[nColor].m_entryHelper;
    }
 
    void setColor(OdUInt32 nColor, ODCOLORREF color)
    {
      m_palette[nColor].m_color = color;
    }
    void setEntryHelper(OdUInt32 nColor, OdInt32 entryHelper)
    {
      m_palette[nColor].m_entryHelper = entryHelper;
    }
 
    const OdGiColorCube *colorCube() const
    {
      return m_pColorCube.get();
    }
    void setColorCube(const OdGiColorCube &colorCube)
    {
      resetColorCube(new OdGiColorCube(colorCube));
    }
    void resetColorCube()
    {
      resetColorCube(NULL);
    }
 
    const OdGiGrayRamp *grayRamp() const
    {
      return m_pGrayRamp.get();
    }
    void setGrayRamp(const OdGiGrayRamp &grayRamp)
    {
      resetGrayRamp(new OdGiGrayRamp(grayRamp));
    }
    void resetGrayRamp()
    {
      resetGrayRamp(NULL);
    }
 
    bool install(const OdGiColorCube &cb);
    bool install(const OdGiGrayRamp &gr);
    bool install(const OdGiPalette &pal2);
 
    OdInt32 closestMatch(ODCOLORREF cref, bool bThroughPal = false) const;
 
    OdInt32 firstAvailableBlock(OdInt32 blockSize) const;
 
    bool isEqualTo(const OdGiPalette &pal2) const;
    bool remove(const OdGiPalette &pal2);
 
    void clear();
  protected:
    void initPalette();
 
    void resetColorCube(OdGiColorCube *pColorCube);
    void resetGrayRamp(OdGiGrayRamp *pGrayRamp);
 
    void setColor(OdInt32 nColor, ODCOLORREF color);
};
 
#include "TD_PackPop.h"
 
#endif //#ifndef __ODGIPALETTE_H__