A simple transform for image encoding. Most useful for encoding abstract images such as IDOMRecombineImage, IDOMRawImage and IDOMFilteredImage as PNG, Tiff or Jpeg. Images may be color converted if they are not compatible with the desired image type. More...

#include <transforms.h>

Inheritance diagram for JawsMako::IImageEncoderTransform:

[legend]

Public Types
enum	eEncodeFormat { }
	Available target image formats. More...

Public Member Functions
virtual void	setReencodeAllImages (bool value)=0
	Sets whether or not all images should be reencoded. The default is false; that is, only image types other than JPEG, TIFF, HDPHOTO and PNG will be re-encoded.

virtual void	setEnableTIFFEncoding (bool value)=0
	Set whether or not TIFF should ever be allowed. The default value is true. This is needed as some output formats do not support TIFF. If a TIFF is seen it will be re-encoded as something else.

virtual void	setReencodeMultiImageTIFF (bool value)=0
	Set whether or not TIFF images that use any image other than the first image in the TIFF file should be re-encoded. The default is true. Ignored if setEnableTIFFEncoding() is true, in which case all TIFF images will be re-encoded.

virtual void	setPreferredFormat (eEncodeFormat format)=0
	Set the preferred format for all images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

virtual void	setPreferredMonoFormat (eEncodeFormat format)=0
	Set the preferred format for monochrome images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

virtual eEncodeFormat	getPreferredMonoFormat () const =0
	Get the preferred format for monochrome images.

virtual void	setPreferredGrayFormat (eEncodeFormat format)=0
	Set the preferred format for gray images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

virtual eEncodeFormat	getPreferredGrayFormat () const =0
	Get the preferred format for gray images.

virtual void	setPreferredColorFormat (eEncodeFormat format)=0
	Set the preferred format for color images. The default is eEFAuto.

virtual eEncodeFormat	getPreferredColorFormat () const =0
	Get the preferred format for color images.

virtual void	setJPEGQuality (uint8 quality)=0
	Set the JPEG encoding quality when JPEG encoding is used.

virtual uint8	getJPEGQuality () const =0
	Get the currently set JPEG encoding quality, where 1 being lowest quality and 5 being highest quality.

virtual void	setTIFFCompression (IDOMTIFFImage::eTIFFCompression scheme)=0
	Set the preferred TIFF compression when TIFF encoding is used.

virtual void	setMonoTIFFCompression (IDOMTIFFImage::eTIFFCompression scheme)=0
	Set the preferred TIFF compression when TIFF encoding is used for monochome images. Any compresion scheme may be used.

virtual void	setGrayTIFFCompression (IDOMTIFFImage::eTIFFCompression scheme)=0
	Set the preferred TIFF compression when TIFF encoding is used for gray images. Only PackBits, LZW or None may be used.

virtual void	setColorTIFFCompression (IDOMTIFFImage::eTIFFCompression scheme)=0
	Set the preferred TIFF compression when TIFF encoding is used for color images. Only PackBits, LZW or None may be used.

virtual void	setEncodeSolidColorMaskedBrushesAsSingleImage (bool encode)=0
	Set whether or not IDOMMaskedBrushes where the sub-brush is a solid color should be encoded as an image with an alpha channel, rather than encoding the image separately. The default is true.

Public Member Functions inherited from JawsMako::ITransform
virtual IDOMBrushPtr	transform (const IDOMBrushPtr &brush, eBrushUsage usage=eBUGeneral, const CTransformState &state=CTransformState())=0
	Apply the transform to the given brush, if applicable. These transforms are thread safe.

virtual IDOMImagePtr	transform (const IDOMImagePtr &image, const CTransformState &state=CTransformState())=0
	Apply the transform to the given image, if applicable. These transforms are thread safe.

virtual IDOMColorPtr	transform (const IDOMColorPtr &color, const CTransformState &state=CTransformState())=0
	Apply the transform to the given color, if applicable. These transforms are thread safe.

virtual IDOMColorSpacePtr	transform (const IDOMColorSpacePtr &colorSpace, const CTransformState &state=CTransformState())=0
	Apply the transform to the given colorspace, if applicable. These transforms are thread safe.

virtual IDOMNodePtr	transform (const IDOMNodePtr &node, bool &changed, bool transformChildren=true, const CTransformState &state=CTransformState())=0
	Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time.

virtual void	transformPage (const IPagePtr &page, bool transformContent=true, bool transformAnnotations=true)=0
	Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances.

virtual void	flushCaches ()=0
	Flush the caches used by the transform. Most transforms cache recently transformed results to improve the performance of repeated transformations of equivalent results. However, it is possible that some cached results may point to entities that no longer exist, such as content inside an XPS file that no longer exists. If you are deleting or replacing files where transforms have been used, it is advisable to invoke this routine to clear the caches.

virtual void	setProgressMonitor (const IProgressMonitorPtr &progressMonitor)=0
	Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform.

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IImageEncoderTransformPtr	create (const IJawsMakoPtr &jawsMako, const IAbortPtr &abort=IAbortPtr())
	Create the transform.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

A simple transform for image encoding. Most useful for encoding abstract images such as IDOMRecombineImage, IDOMRawImage and IDOMFilteredImage as PNG, Tiff or Jpeg. Images may be color converted if they are not compatible with the desired image type.

Member Enumeration Documentation

◆ eEncodeFormat

enum JawsMako::IImageEncoderTransform::eEncodeFormat

Available target image formats.

Enumerator
eEFJPEG	Attempt to choose an appropriate format for each image.

Member Function Documentation

◆ create()

static JAWSMAKO_API IImageEncoderTransformPtr JawsMako::IImageEncoderTransform::create	(	const IJawsMakoPtr &	jawsMako,
		const IAbortPtr &	abort = IAbortPtr() )

static

Create the transform.

Parameters

jawsMako	The JawsMako instance.
abort	An abort callback handler.

Returns: The new instance.

◆ setColorTIFFCompression()

virtual void JawsMako::IImageEncoderTransform::setColorTIFFCompression ( IDOMTIFFImage::eTIFFCompression scheme )

pure virtual

Set the preferred TIFF compression when TIFF encoding is used for color images. Only PackBits, LZW or None may be used.

Parameters

scheme The preferred TIFF compression scheme. May not always be used as not all compression types can be used for all types.

◆ setGrayTIFFCompression()

virtual void JawsMako::IImageEncoderTransform::setGrayTIFFCompression ( IDOMTIFFImage::eTIFFCompression scheme )

pure virtual

Set the preferred TIFF compression when TIFF encoding is used for gray images. Only PackBits, LZW or None may be used.

Parameters

scheme The preferred TIFF compression scheme. May not always be used as not all compression types can be used for all types.

◆ setJPEGQuality()

virtual void JawsMako::IImageEncoderTransform::setJPEGQuality ( uint8 quality )

pure virtual

Set the JPEG encoding quality when JPEG encoding is used.

Parameters

quality The desired quality level, with 1 being lowest quality and 5 being highest quality.

◆ setMonoTIFFCompression()

virtual void JawsMako::IImageEncoderTransform::setMonoTIFFCompression ( IDOMTIFFImage::eTIFFCompression scheme )

pure virtual

Set the preferred TIFF compression when TIFF encoding is used for monochome images. Any compresion scheme may be used.

Parameters

scheme The preferred TIFF compression scheme. May not always be used as not all compression types can be used for all types.

◆ setPreferredColorFormat()

virtual void JawsMako::IImageEncoderTransform::setPreferredColorFormat ( eEncodeFormat format )

pure virtual

Set the preferred format for color images. The default is eEFAuto.

Parameters

format The preferred format.

◆ setPreferredFormat()

virtual void JawsMako::IImageEncoderTransform::setPreferredFormat ( eEncodeFormat format )

pure virtual

Set the preferred format for all images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

Parameters

format The preferred format.

◆ setPreferredGrayFormat()

virtual void JawsMako::IImageEncoderTransform::setPreferredGrayFormat ( eEncodeFormat format )

pure virtual

Set the preferred format for gray images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

Parameters

format The preferred format.

◆ setPreferredMonoFormat()

virtual void JawsMako::IImageEncoderTransform::setPreferredMonoFormat ( eEncodeFormat format )

pure virtual

Set the preferred format for monochrome images. This is only a preference and may not be honoured in all cases. The default is eEFAuto.

Parameters

format The preferred format.

◆ setTIFFCompression()

virtual void JawsMako::IImageEncoderTransform::setTIFFCompression ( IDOMTIFFImage::eTIFFCompression scheme )

pure virtual

Set the preferred TIFF compression when TIFF encoding is used.

Parameters

scheme The preferred TIFF compression scheme. May not always be used as not all compression types can be used for all types.

The documentation for this class was generated from the following file:

transforms.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ eEncodeFormat

Member Function Documentation

◆ create()

◆ setColorTIFFCompression()

◆ setGrayTIFFCompression()

◆ setJPEGQuality()

◆ setMonoTIFFCompression()

◆ setPreferredColorFormat()

◆ setPreferredFormat()

◆ setPreferredGrayFormat()

◆ setPreferredMonoFormat()

◆ setTIFFCompression()