DbRasterImageDef.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 __DBRASTERIMAGEDEF_H
#define __DBRASTERIMAGEDEF_H
 
#include "TD_PackPush.h"
 
// Forward declarations
//
 
class OdDbDictionary;
 
#include "DbObjectReactor.h"
#include "DbObject.h"
#include "Gi/GiRasterImage.h"
#include "Ge/GeVector2d.h"
#include "RxObjectImpl.h"
#include "DbDictionary.h"
#include "DbSymUtl.h"
 
#ifdef ISM_EXPORTS
#define ISM_EXPORT           OD_TOOLKIT_EXPORT
#define ISM_EXPORT_STATIC    OD_STATIC_EXPORT
#else
#define ISM_EXPORT           OD_TOOLKIT_IMPORT
#define ISM_EXPORT_STATIC    OD_STATIC_IMPORT
#endif

class ISM_EXPORT OdDbRasterImageDef : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRasterImageDef);
 
  typedef OdGiRasterImage::Units Units;
 
  OdDbRasterImageDef();
  
  OdResult subErase(
    bool erasing);
  virtual void subHandOverTo (
    OdDbObject* pNewObject);
  void subClose();
 
  OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual OdResult setSourceFileName(const OdString& pathName);

  virtual OdString sourceFileName() const;

  virtual OdResult load(
    bool modifyDatabase = true);

  virtual void unload(
    bool modifyDatabase = true);

  virtual bool isLoaded() const;

  virtual OdGeVector2d size() const;
 

  virtual OdGeVector2d resolutionMMPerPixel() const;

  virtual OdResult setResolutionMMPerPixel(const OdGeVector2d&);

  int entityCount(bool* pbLocked = NULL) const;
  
  void updateEntities() const;

  virtual OdGiRasterImage::Units resolutionUnits() const;

  virtual void setResolutionUnits(enum OdGiRasterImage::Units);

  virtual OdGiRasterImagePtr image(bool load = true);

  virtual void setImage(OdGiRasterImage* pImage, bool modifyDatabase = true);

  static OdDbObjectId createImageDictionary(OdDbDatabase* pDb);

  static OdDbObjectId imageDictionary(OdDbDatabase* pDb);

  static const OdConstString& dictionaryName() { return ACAD_IMAGE_DICT; }
 
  enum
  { 
    kMaxSuggestNameSize = 2049 
  };

  static OdString suggestName(const OdDbDictionary* pImageDictionary,
                  const OdString& strFilePath, int nMaxLength = kMaxSuggestNameSize);
  
  OdString activeFileName() const;
  
  OdResult setActiveFileName(const OdString& pPathName);
  /*   comment this out for a while
 
  int colorDepth() const;
  OdGiSentScanLines* makeScanLines(
    const OdGiRequestScanLines* pReq,
    const OdGeMatrix2d& pixToScreen,
    OdGePoint2dArray* pActiveClipBndy = 0, // Data will be modified!
    bool draftQuality = false,
    bool isTransparent = false,
    const double brightness = 50.0,
    const double contrast = 50.0,
    const double fade = 0.0
    ) const;
  OdString searchForActivePath();
  void embed(); // this function is not implemented in ARX
  bool isEmbedded() const;
  OdString fileType() const;
  void setUndoStoreSize(unsigned int maxImages = 10);
  unsigned int undoStoreSize() const;
  bool imageModified() const;
  void setImageModified(bool modified);
  void loadThumbnail(OdUInt16& maxWidth, OdUInt16& maxHeight,
    OdUInt8* pPalette = 0, int nPaletteEntries = 0);
  void unloadThumbnail();
  void* createThumbnailBitmap(BITMAPINFO*& pBitmapInfo,
    OdUInt8 brightness = 50, OdUInt8 contrast = 50, OdUInt8 fade = 0);
  IeFileDesc* fileDescCopy() const;
  void getScanLines(OdGiBitmap& bitmap,
    double brightness = 50.0,
    double contrast = 50.0,
    double fade = 0.0) const;
  void openImage(IeImg*& pImage);
  void closeImage();
 
  */
  static int classVersion();
protected:
  OdDbObjectPtr subWblockClone(OdDbIdMapping& idMap, OdDbObject* owner, bool bPrimary) const override;
};
 
 
 

class ISM_EXPORT OdDbRasterImageDefReactor : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRasterImageDefReactor);
 
  OdDbRasterImageDefReactor();
 
  OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
  
  void erased(
    const OdDbObject* pObject, 
    bool erasing = true);

  void modified(
    const OdDbObject* pObject);
 
  enum DeleteImageEvent
  {
    kUnload = 1,
    kErase = 2
  };

  static void setEnable(
    bool enable);

  virtual bool onDeleteImage( 
    const OdDbRasterImageDef* pImageDef,
    DeleteImageEvent event,
    bool cancelAllowed);
  
  static int classVersion();
};

typedef OdSmartPtr<OdDbRasterImageDefReactor> OdDbRasterImageDefReactorPtr;

class ISM_EXPORT OdDbRasterImageDefTransReactor : public OdDbObjectReactor
{
protected:
  OdDbRasterImageDefTransReactor() {}
public:
  ODRX_DECLARE_MEMBERS(OdDbRasterImageDefTransReactor);

  virtual bool onDeleteImage( const OdDbRasterImageDef* pImageDef,
                              OdDbRasterImageDefReactor::DeleteImageEvent event,
                              bool cancelAllowed ) = 0;
};
 
/*   comment this for a while */
 
#if 0 
 

class TOOLKIT_EXPORT OdDbRasterImageDefFileAccessReactor : public OdDbObjectReactor
{
protected:
  OdDbRasterImageDefFileAccessReactor() {}
public:
  ODRX_DECLARE_MEMBERS(OdDbRasterImageDefFileAccessReactor);
  
  virtual void onAttach(const OdDbRasterImageDef*, const OdString& pPath) = 0;
  
  virtual void onDetach(const OdDbRasterImageDef*, const OdString& pPath) = 0;
  
  virtual bool onOpen(const OdDbRasterImageDef*, const OdString& pPath,
    const OdString& pActivePath, bool& replacePath, OdString& replacementPath) = 0;

  virtual bool onPathChange(const OdDbRasterImageDef*,
    const OdString& pPath, const OdString& pActivePath,
    bool& replacePath, OdString& replacementPath) = 0;

  virtual void onClose(const OdDbRasterImageDef*, const OdString& pPath) = 0;

  virtual void onDialog(OdDbRasterImageDef*,
    const OdString& pCaption, const OdString& pFileExtensions) = 0;
};
 
#endif
 
 
// next 3 functions are static...
inline OdDbObjectId OdDbRasterImageDef::createImageDictionary(OdDbDatabase* pDb) {
  if (!pDb)
    throw OdError(eNoDatabase);
  OdDbDictionaryPtr pRootDict = pDb->getNamedObjectsDictionaryId().safeOpenObject(OdDb::kForWrite);
  OdDbObjectId ImgDictId = pRootDict->getAt(ACAD_IMAGE_DICT);
  if (ImgDictId.isNull()) {
    OdDbObjectPtr pImgDict = OdDbDictionary::createObject();
    ImgDictId = pRootDict->setAt(ACAD_IMAGE_DICT, pImgDict);
  }
  return ImgDictId;
}
 
inline OdDbObjectId OdDbRasterImageDef::imageDictionary(OdDbDatabase* pDb) {
  if (!pDb)
    throw OdError(eNoDatabase);
  OdDbDictionaryPtr pDict = pDb->getNamedObjectsDictionaryId().safeOpenObject();
  return pDict->getAt(ACAD_IMAGE_DICT);
}
 
inline OdString OdDbRasterImageDef::suggestName(const OdDbDictionary* pDic, const OdString& strPath, int nMaxLength) {
  return pDic->suggestName(strPath, nMaxLength);
}

typedef OdSmartPtr<OdDbRasterImageDef> OdDbRasterImageDefPtr;
 
#include "TD_PackPop.h"
 
#endif // __DBRASTERIMAGEDEF_H