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

#include <AGMImageAccessor.h>

Public Member Functions

virtual ~AGMImageAccessor ()
 
virtual uint32 GetPMColorFamily (void) const =0
 
virtual uint16 GetAGMColorFamily (void) const =0
 
virtual const uint8 * GetBaseAddr (void) const =0
 
virtual uint16 GetRowBytes (void) const =0
 
virtual uint16 GetBitsPerPixel (void) const =0
 
virtual Int32Rect GetBounds (void) const =0
 
virtual uint32 GetColorMap (uint8 **colors) const =0
 
virtual void GetDecodeArray (const float **decodeArray) const =0
 
virtual const _t_AGMImageRecord * GetAGMImageRecord (void) const =0
 
virtual const CAGMImage & GetCAGMImage (void) const =0
 

Detailed Description

The purpose of an AGMImageAccessor is simply to wrap an AGM Image such that 3rd parties can at least know the properties of the image without knowing specifics of the internals.

Constructor & Destructor Documentation

virtual AGMImageAccessor::~AGMImageAccessor ()
virtual

Destructor

Member Function Documentation

virtual uint16 AGMImageAccessor::GetAGMColorFamily (void ) const
pure virtual

Get the AGM color space family. Possible values include kAGMCsCMYK, kAGMCsRGB, kAGMCsGray, and kAGMCsLab.

virtual const _t_AGMImageRecord* AGMImageAccessor::GetAGMImageRecord (void ) const
pure virtual

GetAGMImageRecord() really should not be called any more as of InDesign 3.0. Calling this routine will cause the construction of an AGMImageRecord based on a CAGMImage.

virtual const uint8* AGMImageAccessor::GetBaseAddr (void ) const
pure virtual

Get a pointer to the pixel buffer. If the image is a virtual image, then nil will be returned.

virtual uint16 AGMImageAccessor::GetBitsPerPixel (void ) const
pure virtual

Get the number of bits per pixel

virtual Int32Rect AGMImageAccessor::GetBounds (void ) const
pure virtual

Get the bounds of the image

virtual const CAGMImage& AGMImageAccessor::GetCAGMImage (void ) const
pure virtual

GetCAGMImage will return the underlying CAGMImage.

virtual uint32 AGMImageAccessor::GetColorMap (uint8 ** colors) const
pure virtual

If the image is colormapped, fill in the provided buffer with the colors in the map.

Parameters
colors- IN/OUT - out return, will be filled with the colors in the map.
Returns
the number of colors in the table
virtual void AGMImageAccessor::GetDecodeArray (const float ** decodeArray) const
pure virtual

Fills in the provided decodeArray paramater with the values of the decode array if one exists.

Parameters
decodeArray- IN/OUT
virtual uint32 AGMImageAccessor::GetPMColorFamily (void ) const
pure virtual

Get the InDesign color space family. Possible values include kPMRGBColorSpace, kPMCMYKColorSpace, kPMGrayColorSpace, and kPMICCLabColorSpace.

virtual uint16 AGMImageAccessor::GetRowBytes (void ) const
pure virtual

Get the number of bytes per row.