RxPdfToRasterServices.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.
 
// RxPdfToRasterServices.h - interface of module, performing pdf to raster conversion
 
#ifndef __OD_PDF_TO_RASTER_MODULE__
#define __OD_PDF_TO_RASTER_MODULE__
 
#include "RxModule.h"
#include "OdBinaryData.h"
#include "StringArray.h"
#include "Ge/GePoint2d.h"
#include "Gs/GsDefs.h"
 
class OdGiRasterImage;

typedef OdSmartPtr<OdGiRasterImage> OdGiRasterImagePtr;

enum PdfConversionFlags
{
  kAnnotations = 1,          // Set if annotations are to be rendered.
  kLCDText = 2,              // Set if using text rendering optimized for LCD display.
  kNoNativeText = 4,         // Don't use the native text output available on some platforms.
  kGrayScale = 8,            // Grayscale output.
  kReverseByteOrder = 16,    // Set whether to render in a reverse Byte order.
  kDebugInfo = 128,          // Set if you want to get some debug info.
  kNoCatch = 256,            // Set if you don't want to catch exceptions.
  kLimitImageCache = 512,    // Limit image cache size.
  kForceHalfTone = 1024,     // Always use halftone for image stretching.
  kPrinting = 2048,          // Render for printing.
  kDisableAAforText = 4096,  // Set to disable anti-aliasing on text.
  kDisableAAforImage = 8192, // Set to disable anti-aliasing on images.
  kDisableAAforGeom = 16384, // Set to disable anti-aliasing on geometry (pdf paths).
};

typedef struct {
  OdString layer_name; //Name of the layer
  bool     is_on;      //Flag if the layer is enabled
  int      layerNum;
} pdf_layer;

typedef OdArray<pdf_layer> OdPdfLayerArray;

class OdPdf2ImageConversionParams {
public:

  OdPdf2ImageConversionParams() :
      bg_color(0xFFFFFFFF) //white background
    , dpi(72)              //default pdf resolution
    , flags(0)             //empty set
  {
    cropArea.set_null();
  };
 
  OdUInt32        bg_color; //Background color
  OdUInt16        dpi;      //Required resolution
  int             flags;    //Set of the PdfConversionFlags
  OdPdfLayerArray layers;   //Layers to be enabled or disabled in resulting image
  OdGsDCRect      cropArea; //Coordinates of the area to be cropped from the whole page
};
 
#include "TD_PackPush.h"

class ODRX_ABSTRACT FIRSTDLL_EXPORT OdPdf2ImageConverter : public OdRxObject
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdPdf2ImageConverter);
//DOM-IGNORE-END

  virtual OdResult loadPdf(const OdString &filename, const  OdString &password = "") = 0;

  virtual OdResult loadPdf(OdStreamBufPtr &pBuf, const  OdString &password = "") = 0;

  virtual bool isLoaded() = 0;

  virtual OdString getFilename() = 0;

  virtual OdUInt16 getPagesCount() = 0;

  virtual OdResult setActivePage(OdUInt16 pageNum = 1) = 0;

  virtual OdUInt16 getActivePage() = 0;

  virtual OdResult getLayers(OdPdfLayerArray& layers) = 0;

  virtual OdResult getPageSize(OdGsDCRect& rect) = 0;

  virtual OdGiRasterImagePtr convertPdf(const OdPdf2ImageConversionParams* params = 0) = 0;
};

typedef OdSmartPtr<OdPdf2ImageConverter> OdPdf2ImageConverterPtr;

class ODRX_ABSTRACT FIRSTDLL_EXPORT OdRxPdfToRasterServices : public OdRxModule
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxPdfToRasterServices);
//DOM-IGNORE-END

  virtual OdPdf2ImageConverterPtr createConverter() = 0;
};

typedef OdSmartPtr<OdRxPdfToRasterServices> OdRxPdfToRasterServicesPtr;
 
#include "TD_PackPop.h"
 
#endif // __OD_PDF_TO_RASTER_MODULE__