GiRasterWrappers.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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 Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 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 __OD_GI_RASTER_WRAPPERS__
#define __OD_GI_RASTER_WRAPPERS__
 
#include "Gi/GiExport.h"
#include "Gi/GiRasterImage.h"
#include "Gi/GiImage.h"
#include "UInt8Array.h"
 
#include "TD_PackPush.h"

class ODGI_EXPORT OdGiRasterImageDesc : public OdGiRasterImageParam
{
  OdUInt32                          m_pixelWidth, m_pixelHeight, m_colorDepth, m_palSize, m_alignment;
  OdGiRasterImage::PixelFormatInfo  m_pixFmt;
  Units                             m_units;
  double                            m_xPelsPerUnit, m_yPelsPerUnit;
  OdUInt8*                          m_pPal;
  OdGiRasterImage::ImageSource      m_imageSource;
  OdGiRasterImage::TransparencyMode m_transparencyMode;
  OdString                          m_fileName;
public:
  OdGiRasterImageDesc();
  
  virtual ~OdGiRasterImageDesc();

  static OdGiRasterImagePtr createObject(OdUInt32 pixelWidth, OdUInt32 pixelHeight, Units units = kNone, double xPelsPerUnit = 0.0, double yPelsPerUnit = 0.0);
  
  static OdGiRasterImagePtr createObject(OdUInt32 pixelWidth, OdUInt32 pixelHeight, OdUInt32 colorDepth, Units units = kNone, double xPelsPerUnit = 0.0, double yPelsPerUnit = 0.0);
  
  static OdGiRasterImagePtr createObject(const OdGiRasterImage *pSourceImage);

  void setFrom(const OdGiRasterImage *pSourceImage);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  OdUInt32 colorDepth() const;
  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  OdUInt32 scanLineSize() const;
  const OdUInt8* scanLines() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  PixelFormatInfo pixelFormat() const;
  OdUInt32 scanLinesAlignment() const;
  Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;

  void setPixelWidth(OdUInt32 pixelWidth);
  void setPixelHeight(OdUInt32 pixelHeight);

  void setColorDepth(OdUInt32 colorDepth);
  OdGiRasterImage::PixelFormatInfo& pixelFormat();

  void setPalette(OdUInt32 paletteSize, OdUInt8* paletteData);

  void setScanLinesAlignment(OdUInt32 alignment);

  void setDefaultResolution(Units units, double xPelsPerUnit, double yPelsPerUnit);
  OdUInt32 supportedParams() const;
  OdGiRasterImage::ImageSource imageSource() const;
  void setImageSource(OdGiRasterImage::ImageSource source);
  const OdString &sourceFileName() const;
  void setSourceFileName(const OdString &fileName);
  OdGiRasterImage::TransparencyMode transparencyMode() const;
  void setTransparencyMode(OdGiRasterImage::TransparencyMode mode);
};
 
class OdGiImageBGRA32;

class ODGI_EXPORT OdGiRasterImageBGRA32 : public OdGiRasterImageParam
{
protected:
  OdGiImageBGRA32 *m_pBGRAImage;
  OdGiRasterImage::TransparencyMode m_transparencyMode;
public:
  OdGiRasterImageBGRA32();
  
  virtual ~OdGiRasterImageBGRA32();
  
  static OdGiRasterImagePtr createObject(OdGiImageBGRA32 *pImage, OdGiRasterImage::TransparencyMode transparencyMode = OdGiRasterImage::kTransparency8Bit);
  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  OdUInt32 colorDepth() const;
  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  OdUInt32 scanLineSize() const;
  const OdUInt8* scanLines() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  OdGiRasterImage::PixelFormatInfo pixelFormat() const;
  OdUInt32 scanLinesAlignment() const;
  OdGiRasterImage::Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;
  OdUInt32 supportedParams() const;
  OdGiRasterImage::ImageSource imageSource() const;
  OdGiRasterImage::TransparencyMode transparencyMode() const;
  void setTransparencyMode(OdGiRasterImage::TransparencyMode mode);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiRasterImageBGRA32Holder : public OdGiRasterImageBGRA32
{
protected:
  OdGiImageBGRA32 m_ImageCopy;
public:
  OdGiRasterImageBGRA32Holder();
  
  ~OdGiRasterImageBGRA32Holder();
  
  static OdGiRasterImagePtr createObject(OdGiImageBGRA32 *pImage, OdGiRasterImage::TransparencyMode transparencyMode = OdGiRasterImage::kTransparency8Bit);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiRasterImageBGRA32Copy : public OdGiRasterImageBGRA32Holder
{
private:
  OdGiPixelBGRA32Array m_pxArray;
public:
  OdGiRasterImageBGRA32Copy();
  
  ~OdGiRasterImageBGRA32Copy();
  
  static OdGiRasterImagePtr createObject(OdGiImageBGRA32 *pImage, OdGiRasterImage::TransparencyMode transparencyMode = OdGiRasterImage::kTransparency8Bit);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiRasterImageHolder : public OdGiRasterImageParam
{
  OdUInt32                          m_pixelWidth, m_pixelHeight, m_colorDepth, m_alignment;
  OdGiRasterImage::PixelFormatInfo  m_pixFmt;
  Units                             m_units;
  double                            m_xPelsPerUnit, m_yPelsPerUnit;
  OdGiRasterImage::ImageSource      m_imageSource;
  OdString                          m_fileName;
  OdGiRasterImage::TransparencyMode m_transparencyMode;
  int                               m_transparentColor;
  OdUInt8Array                      m_palData;
  OdUInt8Array                      m_pixData;
public:
  OdGiRasterImageHolder();
  
  virtual ~OdGiRasterImageHolder();

  void setFrom(const OdGiRasterImage* pOrig);

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pImage);
  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;
  OdUInt32 colorDepth() const;
  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  OdUInt32 scanLineSize() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  PixelFormatInfo pixelFormat() const;
  OdUInt32 scanLinesAlignment() const;
  int transparentColor() const;
  ImageSource imageSource() const;
  const OdString &sourceFileName() const;
  TransparencyMode transparencyMode() const;
  OdUInt32 supportedParams() const;
  void setImageSource(ImageSource source);
  void setSourceFileName(const OdString &fileName);
  void setTransparencyMode(TransparencyMode mode);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiRasterImageWrapper : public OdGiRasterImageParam
{
  OdGiRasterImagePtr m_pOrig;
public:
  OdGiRasterImageWrapper();
  virtual ~OdGiRasterImageWrapper();

  void setOriginal(const OdGiRasterImage* pOrig);
  const OdGiRasterImage *original() const;
  OdGiRasterImagePtr cloneOriginal() const;
  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;
  OdUInt32 colorDepth() const;
  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  OdUInt32 scanLineSize() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  PixelFormatInfo pixelFormat() const;
  OdUInt32 scanLinesAlignment() const;
  int transparentColor() const;
  ImageSource imageSource() const;
  const OdString &sourceFileName() const;
  TransparencyMode transparencyMode() const;
  OdUInt32 supportedParams() const;
  void setImageSource(ImageSource source);
  void setSourceFileName(const OdString &fileName);
  void setTransparencyMode(TransparencyMode mode);
  void* imp() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiBitonalRasterTransformer : public OdGiRasterImageWrapper
{
  RGBQUAD m_palette[2] = {};
  int m_transpColor;
public:
  OdGiBitonalRasterTransformer();
  virtual ~OdGiBitonalRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig, ODCOLORREF foregroundColor, ODCOLORREF backgroundColor, bool transparent);

  void setOriginal(const OdGiRasterImage* pOrig, ODCOLORREF foregroundColor, ODCOLORREF backgroundColor, bool transparent);

  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  PixelFormatInfo pixelFormat() const;
  int transparentColor() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiUpsideDownRasterTransformer : public OdGiRasterImageWrapper
{
public:
  OdGiUpsideDownRasterTransformer();
  
  virtual ~OdGiUpsideDownRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig);
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiLeftToRightRasterTransformer : public OdGiRasterImageWrapper
{
public:
  OdGiLeftToRightRasterTransformer();
  
  virtual ~OdGiLeftToRightRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig);
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiHorizontalToVerticalRasterTransformer : public OdGiRasterImageWrapper
{
protected:
  bool m_bCcw;
public:
  OdGiHorizontalToVerticalRasterTransformer();
  
  virtual ~OdGiHorizontalToVerticalRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig, bool bCcw = false);
  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;
  OdUInt32 scanLineSize() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};

class ODGI_EXPORT OdGiInversionRasterTransformer : public OdGiRasterImageWrapper
{
public:
  OdGiInversionRasterTransformer();
  virtual ~OdGiInversionRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig);
  ODCOLORREF color(OdUInt32 colorIndex) const;
  void paletteData(OdUInt8* bytes) const;
  
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  const OdUInt8* scanLines() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
protected:
  virtual ODCOLORREF colorXform(ODCOLORREF color) const;
};

class ODGI_EXPORT OdGiGrayscaleRasterTransformer : public OdGiInversionRasterTransformer
{
public:
  OdGiGrayscaleRasterTransformer();
  
  virtual ~OdGiGrayscaleRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
protected:
  virtual ODCOLORREF colorXform(ODCOLORREF color) const;
};

class ODGI_EXPORT OdGiTintRasterTransformer : public OdGiInversionRasterTransformer
{
public:
  OdGiTintRasterTransformer();
        
  virtual ~OdGiTintRasterTransformer();

        static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig, const ODCOLORREF& clrTint );
        OdRxObjectPtr clone() const;
        void copyFrom(const OdRxObject *pSource);
protected:
        virtual ODCOLORREF colorXform(ODCOLORREF color) const;
protected:
        double m_dRedScale;
        double m_dGreenScale;
        double m_dBlueScale;
};

class ODGI_EXPORT OdGiMonochromaticRasterTransformer : public OdGiGrayscaleRasterTransformer
{
  int m_threshold;
public:
  OdGiMonochromaticRasterTransformer();
  virtual ~OdGiMonochromaticRasterTransformer();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig, int threshold = 127);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
  void setThreshold(OdUInt8 treshold) { m_threshold = treshold; if (m_threshold > 254) m_threshold = 254; };
  int threshold() const { return m_threshold; }
protected:
  virtual ODCOLORREF colorXform(ODCOLORREF color) const;
};

class ODGI_EXPORT OdGiRasterImageAlphaChannelAdder : public OdGiRasterImageParam
{
protected:
  const OdGiRasterImage*  m_pOrigImage;
  ODCOLORREF              m_clPixelAlpha;
  OdUInt8                 m_nPixelAlphaThreshold;
public:
  
  OdGiRasterImageAlphaChannelAdder();
  
  virtual ~OdGiRasterImageAlphaChannelAdder();
  
  static OdGiRasterImagePtr createObject( const OdGiRasterImage* pOrig, ODCOLORREF cutColor, OdUInt8 threshold = 0 );

  OdUInt32 scanLineSize() const;
  const OdUInt8* scanLines() const;
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;

  OdUInt32 pixelWidth() const;
  OdUInt32 pixelHeight() const;
  OdUInt32 colorDepth() const;
  OdUInt32 numColors() const;
  ODCOLORREF color(OdUInt32 colorIndex) const;
  OdUInt32 paletteDataSize() const;
  void paletteData(OdUInt8* bytes) const;
  OdGiRasterImage::PixelFormatInfo pixelFormat() const;
  OdUInt32 scanLinesAlignment() const;
  OdGiRasterImage::Units defaultResolution(double& xPelsPerUnit, double& yPelsPerUnit) const;
  OdUInt32 supportedParams() const;
  OdGiRasterImage::ImageSource imageSource() const;
  OdGiRasterImage::TransparencyMode transparencyMode() const;
  void setTransparencyMode(OdGiRasterImage::TransparencyMode mode);
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
 
protected:
  OdUInt8 getAlphaValue( OdUInt8 red, OdUInt8 green, OdUInt8 blue ) const;
};
//DOM-IGNORE-BEGIN
#if 0 // @@@TODO: implement at least nearest, bilinear and bicubic resamplers

class ODGI_EXPORT OdGiNearestRasterResampler : public OdGiRasterImageWrapper
{
  OdUInt32 m_newPixWidth, m_newPixHeight;
public:
  OdGiNearestRasterResampler();
  virtual ~OdGiNearestRasterResampler();

  static OdGiRasterImagePtr createObject(const OdGiRasterImage* pOrig, OdUInt32 newPixWidth, OdUInt32 newPixHeight);
  void scanLines(OdUInt8* scnLines, OdUInt32 firstScanline, OdUInt32 numLines = 1) const;
  
  const OdUInt8* scanLines() const;
  OdRxObjectPtr clone() const;
  void copyFrom(const OdRxObject *pSource);
};
//DOM-IGNORE-END
#endif
 
#include "TD_PackPop.h"
 
#endif //  __OD_GI_RASTER_WRAPPERS__