JawsMako::IImageMergerTransform Class Reference

A simple transform that looks for nearby images and attempts to glom them together in a single image. Some producers can break images up into images consisting of a single scanline; this transform attempts to put them back together again. This transform can handle images with a mask channel, but does not attempt to merge images with an alpha channel. More...

#include <transforms.h>

Inheritance diagram for JawsMako::IImageMergerTransform:

Public Member Functions
virtual void	setAllowMaskedResults (bool allowMasked)=0
	Sets whether or a mask channel is allowed in the merged result.
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 IImageMergerTransformPtr	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 that looks for nearby images and attempts to glom them together in a single image. Some producers can break images up into images consisting of a single scanline; this transform attempts to put them back together again. This transform can handle images with a mask channel, but does not attempt to merge images with an alpha channel.

Member Function Documentation

create()

static JAWSMAKO_API IImageMergerTransformPtr JawsMako::IImageMergerTransform::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.

setAllowMaskedResults()

virtual void JawsMako::IImageMergerTransform::setAllowMaskedResults ( bool allowMasked )

pure virtual

Sets whether or a mask channel is allowed in the merged result.

    The merger deals with images that do not exactly abut alone a single
    edge by producing a mask channel that describes the area of the
    resulting image that contains merged image data. If set to false this
    transform will not produce masked images, and as a result will not
    be able to merge some images. The default is true.

---

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

• transforms.h