Mako 8.3.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
JawsMako::IShadingPatternNoiserTransform Class Referenceabstract

A transform that applies noise to Type 2 (axial) shading patterns, which can reduce the appearance of banding on real print devices. The affected shading patterns are converted to images and (optionally) compressed. More...

#include <jawsmako/transforms.h>

Inheritance diagram for JawsMako::IShadingPatternNoiserTransform:
[legend]

Public Member Functions

virtual void setNoiseMagnitude (uint8 magnitude)=0
 Set the magnitude of the noise to add, in bits. The default is 2.
virtual void setResolution (double xRes, double yRes=0.0)=0
 Set the resolution(s) to use when converting affected shading patterns to images. The default is 300 for both x and y.
virtual void setCompress (bool compress)=0
 Set whether or not the output should be compressed (flate). This can improve performance significantly if the result is to be written to PDF. The default is true.
Public Member Functions inherited from JawsMako::ITransform
virtual ~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 color space, 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 IShadingPatternNoiserTransformPtr create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
 Create the transform.

Additional Inherited Members

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

Detailed Description

A transform that applies noise to Type 2 (axial) shading patterns, which can reduce the appearance of banding on real print devices. The affected shading patterns are converted to images and (optionally) compressed.

Please note that if transform(IDOMBrush) is used, the transform will not apply denoising unless the input state provides clip bounds (state.hasClipBounds == true).

Member Function Documentation

◆ create()

JAWSMAKO_API IShadingPatternNoiserTransformPtr JawsMako::IShadingPatternNoiserTransform::create ( const IJawsMakoPtr & jawsMako,
const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )
static

Create the transform.

Parameters
jawsMakoThe JawsMako instance.
progressMonitorA progress monitor for cancelling, and monitoring the job progress.
Returns
IShadingPatternNoiserTransformPtr The new instance.

◆ setCompress()

virtual void JawsMako::IShadingPatternNoiserTransform::setCompress ( bool compress)
pure virtual

Set whether or not the output should be compressed (flate). This can improve performance significantly if the result is to be written to PDF. The default is true.

Parameters
compressTrue if the images should be compressed. False otherwise.

◆ setNoiseMagnitude()

virtual void JawsMako::IShadingPatternNoiserTransform::setNoiseMagnitude ( uint8 magnitude)
pure virtual

Set the magnitude of the noise to add, in bits. The default is 2.

Parameters
magnitudeThe noise magnitude in the maximum number of bits. Must be less than 8.

◆ setResolution()

virtual void JawsMako::IShadingPatternNoiserTransform::setResolution ( double xRes,
double yRes = 0.0 )
pure virtual

Set the resolution(s) to use when converting affected shading patterns to images. The default is 300 for both x and y.

Parameters
xResThe desired x resolution.
yResThe desired y resolution. If 0, the x resolution will be used.

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