InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
ISimpleImageStreamManager Class Referenceabstract

#include <ISimpleImageStreamManager.h>

Inheritance diagram for ISimpleImageStreamManager:
IPMUnknown

Public Member Functions

virtual ErrorCode Set (const UIDRef &imageRef, bool16 bUseHighRes, IImageAttributes *dstImageAttributes, bool16 antiAliasing=kFalse, bool16 doDiffusion=kFalse, uint8 grayThreshold=128)=0
 
virtual IImageStream * Open (void)=0
 
virtual void Close (void)=0
 
virtual IImageStreamManager * QueryImageStreamManager ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface is a helper class for creating an ImageStreamManager to convert either the proxy image data or linked image data, associated with a placed image, to a new image described by a set of IImageAttributes.

See Also
IImageStreamManager, IImageStream, IImageAttributes

Member Function Documentation

virtual void ISimpleImageStreamManager::Close (void )
pure virtual

Call Close if the Open returns a valid IImageStream after you are done with the IImageStream. Calling Close() allows the IImageStream to be Released.

virtual IImageStream* ISimpleImageStreamManager::Open (void )
pure virtual

Obtain an IImageStream from which a ReadData() method can be called to retrieve data. NOTE: This call could return NULL if an IImageStream cannot be created to map between the source and destination attributes. NOTE: The dstImageAttributes provided to Set() could be changed by the call to Open() is some circumstances. See the notes for QueryImageStream() in IImageStreamManager.h.

Returns
Ptr to an IImageStream for retrieving the converted image data.
virtual IImageStreamManager* ISimpleImageStreamManager::QueryImageStreamManager ()
pure virtual

The ISimpleImageStreamManager is a simple envelope class around the IImageStreamManager. If you want this class to do all the basic setup but then you want to tweak one or two things, you can simple ask it for its IImageStreamManager and make the changes directly. NOTE: Calls to the IImageStreamManager returned via QueryImageStreamManager() should be made after the call to Set() and BEFORE the call to Open().

Returns
Ptr to the underlying IImageStreamManager.
virtual ErrorCode ISimpleImageStreamManager::Set (const UIDRef & imageRef,
bool16 bUseHighRes,
IImageAttributes * dstImageAttributes,
bool16 antiAliasing = kFalse,
bool16 doDiffusion = kFalse,
uint8 grayThreshold = 128 
)
pure virtual

Set the conversion options.

Parameters
imageRef- IN: UIDRef of the placed image whose image data we want to use as the source.
bUseHighRes- IN: kTrue to use the high-res linked image data. kFalse to use the low resolution proxy image.
dstImageAttributes- IN/OUT: used to setup a pipeline of ImageStream segments to convert the source to a destination with the given attributes.
antiAliasing- IN: If down sampling is required, then passing kTrue causes an averaging based strategy to be used. kFalse causes a simple sub-sampling strategy to be used. Default is kFalse.
doDiffusion- IN: Sets whether or not to do diffusion during chunky to indexed conversion. Default is not.
grayThreshold- IN: If converting to 1-bit, use this value to determine if a pixel should be black or white. Default is 128