Mako 7.3.0 API
JawsMako::IOverprintSimulationTransform Class Referenceabstract

A transform that modifies DOM such that any overprint present in the DOM will be visible when written or rendered in an environment that does not support overprint. More...

#include <transforms.h>

Inheritance diagram for JawsMako::IOverprintSimulationTransform:

Public Member Functions

virtual void setResolution (uint32 resolution)=0
 Set the target resolution to use when any rendering must be performed. The default is 300dpi. The resolution must be supported by the IRendererTransform.
 
virtual void setSimulationColorSpace (const IDOMColorSpacePtr &simulationSpace)=0
 Set the simulation color space. More...
 
virtual void setSimulateBlackDeviceGrayTextOverprint (bool simulate)=0
 Set whether or not overprint simulation should be performed for 100% black DeviceGray text. More...
 
- 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
- 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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 

Static Public Member Functions

static JAWSMAKO_API IOverprintSimulationTransformPtr create (const IJawsMakoPtr &jawsMako, const IAbortPtr &abort=IAbortPtr())
 Create the transform. More...
 

Additional Inherited Members

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

Detailed Description

A transform that modifies DOM such that any overprint present in the DOM will be visible when written or rendered in an environment that does not support overprint.

This will usually involve rendering overprinted content and replacing with an image. The result is a simulation/approximation and may not exactly match the results achieved on a real world printing device where all spot colorants are available as real inks.

Note that in order to perform this operation, all colors will be converted to a CMYK simulation color space (DeviceCMYK by default). Use an IColorConverterTransform after this transform if a non-CMYK output color space is required.

Note that if the simulation CMYK color space is not DeviceCMYK, any DeviceCMYK colors will be treated as if they are using the simulation color space.

As transparency compositing may be affected by color conversion, all transparent content is flattened.

It can only operate on entire IDOMFixedPage or IPage nodes. Any attempt to apply this transform to an individual node or subtree will result in no changes being made. Does not apply to content in annotations.

Member Function Documentation

◆ create()

static JAWSMAKO_API IOverprintSimulationTransformPtr JawsMako::IOverprintSimulationTransform::create ( const IJawsMakoPtr &  jawsMako,
const IAbortPtr &  abort = IAbortPtr() 
)
static

Create the transform.

Parameters
jawsMakoThe JawsMako instance.
abortAn abort callback handler.
Returns
The new instance.

◆ setSimulateBlackDeviceGrayTextOverprint()

virtual void JawsMako::IOverprintSimulationTransform::setSimulateBlackDeviceGrayTextOverprint ( bool  simulate)
pure virtual

Set whether or not overprint simulation should be performed for 100% black DeviceGray text.

The default is true.

◆ setSimulationColorSpace()

virtual void JawsMako::IOverprintSimulationTransform::setSimulationColorSpace ( const IDOMColorSpacePtr &  simulationSpace)
pure virtual

Set the simulation color space.

   The default is DeviceCMYK. The color space that is set will also be used
   for DeviceCMYK for any color conversions that take place, ignoring any
   IColorManager DeviceCMYK intercept.

   The color space must be either DeviceCMYK, or a four-component ICC based
   color space.

   The default is DeviceCMYK

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