SnapshotUtilsEx.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Stephens
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// SnapshotUtilsEx draws items into a memory based graphics context creating a bitmap,
// or "snapshot", that can be exported to a stream in a variety of formats. Drawing
// is performed internally by SnapshotUtils via the draw manager IDrawMgr.
// 
// Overloaded constructors assist in the creation of snapshots of:
// complete spreads, pages and page items or;
// selected areas of these items.
// 
// The constructors allow the caller to control the scale of the snapshot, the amount
// of bleed, whether a grayscale, RGB, CMYK or Lab bitmap is
// made and whether an alpha channel for pixel transparency should be generated.
// 
// After construction of a SnapshotUtilsEx, it is necessary to call Draw() with
// the desired draw options, including draw quality, anti-aliasing, transparency quality,
// text greeking and draw flags.
// 
// If Draw() is successful the caller can access the snapshot by exporting it to a stream
// via the Export methods or accessing it directly via CreateAGMImageAccessor. 
// If exporting to a stream, the snapshot bitmap is filtered by the image write format 
// service specified by the caller and written to the stream. A variety of filters are
// available (e.g. JPEG, TIFF, GIF).
// 
// Notes:
// 
// The default resolution of the snapshot bitmap is 72 dpi.
// 
// Downsampling will be applied if the area to be drawn could not be rendered at the requested
// scale within the limits of the frame buffer.
// 
// GetStatus() will return kFailure if memory could not be allocated for any reason or if
// the area to be drawn still could not be rendered within the limited size of frame buffer 
// after downsampling.
// 
// Sample:
// 
// void ItemSnapshot(const UIDRef& itemUIDRef, IPMStream* stream)
// 
// SnapshotUtils snapshot(itemUIDRef);
// if (snapshot.Draw()
// snapshot.ExportImageToJPEG(stream);
// 
//========================================================================================

#ifndef __SnapshotUtilsEx_h__
#define __SnapshotUtilsEx_h__

class IPMStream;
class IDataBase;

#include "IShape.h"
#include "AGMGraphicsContext.h"
#include "AGMImageAccessor.h"
#include "SnapshotUtils.h"
#include <map>

class SnapshotUtilsExImpl;
class IdleTimer;

//VPAttrMap is a map of view port attribute class IDs and values corresponding to them
typedef std::map<ClassID, PMReal> VPAttrMap;

class SnapshotUtilsEx
{
public:
 typedef enum {
 kCsGray,
 kCsRGB,
 kCsCMYK,
 kCsLab
 } SSColorSpaceFamily;

 SnapshotUtilsEx
 (
 const UIDRef& itemUIDRef, 
 const PMReal& xScaleFactor = 1.0,
 const PMReal& yScaleFactor = 1.0,
 const PMReal& desiredRes = 72.0,
 const PMReal& minRes = 72.0,
 const PMReal& bleedAmount = 0.0,
 SSColorSpaceFamily colorSpace = kCsRGB,
 bool8 addTransparencyAlpha = kFalse,
 bool8 simulateOverprint = kFalse
 );

 SnapshotUtilsEx
 (
 const PMRect& clippingBounds, 
 const PMMatrix& boundsToSpreadMatrix, 
 const UIDRef& itemUIDRef, 
 const PMReal& xScaleFactor = 1.0,
 const PMReal& yScaleFactor = 1.0,
 const PMReal& desiredRes = 72.0,
 const PMReal& minRes = 72.0,
 const PMReal& bleedAmount = 0.0, 
 SSColorSpaceFamily colorSpace = kCsRGB,
 bool8 addTransparencyAlpha = kFalse,
 bool8 simulateOverprint = kFalse
 );
 

 SnapshotUtilsEx
 (
 const PMRect& clippingBounds, 
 const PMMatrix& boundsToSpreadMatrix, 
 IDataBase* database, 
 const PMReal& xScaleFactor = 1.0,
 const PMReal& yScaleFactor = 1.0, 
 const PMReal& desiredRes = 72.0,
 const PMReal& minRes = 72.0, 
 const PMReal& bleedAmount = 0.0, 
 SSColorSpaceFamily colorSpace = kCsRGB,
 bool8 addTransparencyAlpha = kFalse,
 bool8 simulateOverprint = kFalse
 );
 
 virtual ~SnapshotUtilsEx();

 
 ErrorCode Draw(int32 flags = IShape::kPreviewMode,
 bool32 fullResolutionGraphics = kFalse, 
 const PMReal& greekBelowPtSize = 7.0, 
 bool32 enableAntiAliasing = kTrue,
 SnapshotUtils::Transparencies transparencyQuality = SnapshotUtils::kXPHigh,
 IdleTimer *abortCheck = nil,
 VPAttrMap* pVPAttrMap = nil,
 bool32 bDrawNonPrintingObjects = kTrue
 );
 
 ErrorCode Draw(UID pageItem,
 int32 flags,
 bool32 fullResolutionGraphics, 
 const PMReal& greekBelowPtSize, 
 bool32 enableAntiAliasing,
 SnapshotUtils::Transparencies transparencyQuality,
 IdleTimer *abortCheck = nil,
 VPAttrMap* pVPAttrMap = nil,
 bool32 bDrawNonPrintingObjects = kTrue
 );

 ErrorCode ExportImage
 (
 ClassID formatClass,
 IPMStream* writeStream,
 bool8 colorMapped
 ); 

 ErrorCode ExportImageToJPEG
 (
 IPMStream* writeStream, 
 SnapshotUtils::SSJPEGEncoding encoding = SnapshotUtils::kSSJPEGBaseline,
 SnapshotUtils::SSJPEGQuality quality = SnapshotUtils::kSSJPEGExcellentQuality,
 bool embedColorProfile = false
 );
 
 ErrorCode ExportImageToTIFF
 (
 IPMStream* writeStream,
 SnapshotUtils::PaletteType paletteType = SnapshotUtils::kNoPalette,
 bool embedColorProfile = false
 );

 ErrorCode ExportImageToGIF
 (
 IPMStream* writeStream, 
 SnapshotUtils::PaletteType paletteType = SnapshotUtils::kTryExactThenAdaptivePalette,
 bool8 interlaced = kFalse
 );

 ErrorCode ExportImageToPNG
 (
 IPMStream* writeStream, 
 uint32 compression = 5
 );

 AGMGraphicsContext * GetGraphicsContext(void) const;

 AGMImageAccessor * CreateAGMImageAccessor(void) const;

 AGMImageAccessor * CreateAlphaAGMImageAccessor(void) const;

protected:
 SnapshotUtilsExImpl *fImpl;
};

#endif

// End, SnapshotUtilsEx.h