InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IReadDataImageStreamData Class Referenceabstract

#include <IReadDataImageStreamData.h>

Inheritance diagram for IReadDataImageStreamData:
IPMUnknown

Public Member Functions

virtual void SetImageReadData (IImageReadData *iImageReadData)=0
 
virtual IImageReadDataQueryImageReadData ()=0
 
virtual void SetClip (const PMRect &clipBounds, uint16 fillColor, uint32 numChannelsPerPixel)=0
 
virtual bool GetClip (PMRect &clipBounds, uint16 *fillColor, uint32 *numChannelsPerPixel) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

IReadDataImageStreamData This class is a data interface for the ReadDataImageStream, which is an implementation of IImageStream used by the ImageStreamManager as the first image stream segment in the pipeline to actually read untouched source data from disk or a database to pass to IImageStreamFormat implementations. Each page item boss that is associated with image data typically has an IID_IIMAGEREADDATA interface such that it can be asked to obtain the source data. The implementation of this IID_IIMAGEREADDATA is passed to the SetImageReadData method in this class.

See Also
IImageStreamManager.h, IImageReadData.h, IImageReadformat.h

Member Function Documentation

virtual bool IReadDataImageStreamData::GetClip (PMRectclipBounds,
uint16 * fillColor,
uint32 * numChannelsPerPixel 
) const
pure virtual

Get the values passed to SetClip.

Parameters
clipBounds[OUT]: rectangle most recently passed to SetClip. Ignore if return value is false.
fillColor[OUT]: optional. If non-nil and true is returned, then fillColor will contain the value passed for 'fillColor' to the most recent call to SetClip.
numChannelsPerPixel[OUT]: optional. if non-nil, will contain the number of source channels per pixel that was passed into SetClip.
Returns
true if SetClip has been called with a non-empty rectangle.
virtual IImageReadData* IReadDataImageStreamData::QueryImageReadData ()
pure virtual

Set method to specify which IImageReadData to use to obtain source image data from disk or embedded pub data, etc.

Returns
Pointer to the IImageReadData for this image. Note that the IImageReadData IS AddReferenced by this call.
virtual void IReadDataImageStreamData::SetClip (const PMRectclipBounds,
uint16 fillColor,
uint32 numChannelsPerPixel 
)
pure virtual

SetClip sets a clipping relative to the image, where (0,0) is the upper left, such that pixels outside of the clip will be have 'fillColor' assigned to each channel. By default, no clipping is applied. Using this method is optional.

Parameters
clipBounds[IN]: the clipping rect defined relative to upper left of image. Pass an empty rectangle to remove the clipping.
fillColor[IN]: value to assign to each channel of each pixel outside the clip. By filling the clipped out portion of the image with a solid color, compression algorithms can effectively eliminate the impact of the clipped data on the total size of the data.
numChannelsPerPixel[IN]: number of channels per pixel in the source data that is being read. This value is important in order to know how many bytes of data to fill with the fillColor if the 'clipBounds' clips out a portion of a scanline.
virtual void IReadDataImageStreamData::SetImageReadData (IImageReadDataiImageReadData)
pure virtual

Set method to specify which IImageReadData to use to obtain source image data from disk or embedded pub data, etc.

Parameters
iImageReadData- IN: Pointer to the IImageReadData for this image. Note that the iImageReadData is not AddReferenced by this call.