GiCubeMap.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_CUBE_MAP__
#define __OD_GI_CUBE_MAP__
 
#include "Gi/GiExport.h"
#include "Gi/GiRasterImage.h"
#include "OdArray.h"
 
#include "TD_PackPush.h"

class ODGI_EXPORT OdGiPatchworkRasterImage : public OdGiRasterImageParam
{
  OdUInt32 m_nWidth, m_nHeight;
  OdString m_fileName;
  ImageSource m_imSrc;
  TransparencyMode m_trMode;
  ODCOLORREF m_backgroundColor;
  OdUInt8 m_bkColorEncoded[4] = {};
  struct RIEntry { OdGiRasterImagePtr m_pOrig; OdInt32 m_nPosX = 0, m_nPosY = 0; OdUInt32 m_pixWidth = 0, m_pixHeight = 0;
                   bool isInside(OdUInt32 nScanline, OdUInt32 nPix) const { return OdInt32(nScanline) >= m_nPosY && nScanline < m_nPosY + m_pixHeight &&
                                                                                   OdInt32(nPix) >= m_nPosX && nPix < m_nPosX + m_pixHeight; }
                   OdUInt32 yLoc(OdUInt32 nScanline) const { return nScanline - m_nPosY; }
                   OdUInt32 xLoc(OdUInt32 nPix) const { return nPix - m_nPosX; } };
  OdArray<RIEntry> m_rasterImages;
protected:
  const RIEntry *findEntry(OdUInt32 nScanline, OdUInt32 nPixel) const;
  void encodeBkColor();
public:
  OdGiPatchworkRasterImage();
  virtual ~OdGiPatchworkRasterImage();

  static OdGiRasterImagePtr createObject(OdUInt32 nWidth, OdUInt32 nHeight, ODCOLORREF bkColor = 0);

  void setRasterDimensions(OdUInt32 uWidth, OdUInt32 uHeight) { m_nWidth = uWidth; m_nHeight = uHeight; }

  void setBackgroundColor(ODCOLORREF bkColor) { m_backgroundColor = bkColor; if (!m_rasterImages.empty()) encodeBkColor(); }
  ODCOLORREF backgroundColor() const { return m_backgroundColor; }

  void addRasterImage(const OdGiRasterImage* pRaster, OdInt32 nPosX, OdInt32 nPosY);
  void removeRasterImage(const OdGiRasterImage *pRaster);

  OdUInt32 numRasterImages() const { return m_rasterImages.size(); }
  const OdGiRasterImage *getRasterImage(OdUInt32 nRaster, OdInt32 *pPosX = nullptr, OdInt32 *pPosY = nullptr) const
  {
    if (pPosX) *pPosX = m_rasterImages[nRaster].m_nPosX;
    if (pPosY) *pPosY = m_rasterImages[nRaster].m_nPosY;
    return m_rasterImages[nRaster].m_pOrig;
  }

  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 OdGiOCMReader
{
  public:
    struct RasterLoader
    {
      virtual OdGiRasterImagePtr load(const OdString &fileName) = 0;
    };
  protected:
    OdGiRasterImagePtr loadRastrec(const OdString &streamName, const OdString &fileName, RasterLoader *pLoader);
  public:
    static OdString substituteFileName(const OdString &streamName, const OdString &fileName);
  public:
    OdGiRasterImagePtr load(OdStreamBuf &pStreamBuf, RasterLoader *pLoader = nullptr);
};
 
#include "TD_PackPop.h"
 
#endif //  __OD_GI_CUBE_MAP__