Mako 7.5.0 API
Loading...
Searching...
No Matches
JawsMako::ISeparator Class Referenceabstract

An instance of the JawsMako Separator class. More...

#include <separator.h>

Inheritance diagram for JawsMako::ISeparator:

Public Member Functions

virtual void separate (const IDOMFixedPagePtr &content)=0
 Separate a fixed page.
 
virtual void getSeparation (uint32 index, IDOMFixedPagePtr &content, U8String &name) const =0
 Retrieve a separated page.
 
virtual void getSeparation (uint32 index, IDOMFixedPagePtr &content)
 Retrieve a separated page.
 
virtual uint32 getNumSeparations () const =0
 Return the number of separations. Returns the number of available separated pages generated with separate().
 
virtual void setTransformSpots (bool transformSpots)=0
 Set whether or not spot colors should be transformed to the target color space when separating. The default is set when creating the separator instance with create().
 
virtual void setEnableVectorMode (bool enableVectorMode)=0
 Enable "vector" flattening mode.
 
virtual void setRasterFallbackThreshold (uint32 rasterFallbackThreshold)=0
 For cases where the vector mode is used, set the threshold at which to fall back to raster mode for a particular renderable area.
 
- 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 ISeparatorPtr create (const IJawsMakoPtr &jawsMako, bool transformSpots=false, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
 Create a separator instance.
 

Additional Inherited Members

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

Detailed Description

An instance of the JawsMako Separator class.

Member Function Documentation

◆ create()

static JAWSMAKO_API ISeparatorPtr JawsMako::ISeparator::create ( const IJawsMakoPtr & jawsMako,
bool transformSpots = false,
const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )
static

Create a separator instance.

Parameters
jawsMakoThe JawsMako instance.
transformSpotsWhether spot colors should be transformed to the target color space. The default is false.
progressMonitorThe progress monitor which allows aborting an operation or registering a progress callback.
Returns
ISeparatorPtr The new separator instance.

◆ getNumSeparations()

virtual uint32 JawsMako::ISeparator::getNumSeparations ( ) const
pure virtual

Return the number of separations. Returns the number of available separated pages generated with separate().

Returns
uint32 The number of separations.

◆ getSeparation() [1/2]

virtual void JawsMako::ISeparator::getSeparation ( uint32 index,
IDOMFixedPagePtr & content )
inlinevirtual

Retrieve a separated page.

Parameters
indexThe index of the separated fixed page to retreive. Will throw an exception if there is no separated page at the given index.
contentThe separated fixed page.

◆ getSeparation() [2/2]

virtual void JawsMako::ISeparator::getSeparation ( uint32 index,
IDOMFixedPagePtr & content,
U8String & name ) const
pure virtual

Retrieve a separated page.

Parameters
indexThe index of the separated fixed page to retreive. Will throw an exception if there is no separated page at the given index.
contentThe separated fixed page.
nameReference to receive the colorant name of the separated page.

◆ separate()

virtual void JawsMako::ISeparator::separate ( const IDOMFixedPagePtr & content)
pure virtual

Separate a fixed page.

Parameters
contentThe input fixed page to separate. Use getSeparation() to get the separated pages.

◆ setEnableVectorMode()

virtual void JawsMako::ISeparator::setEnableVectorMode ( bool enableVectorMode)
pure virtual

Enable "vector" flattening mode.

    NOTE: This is functionality is beta quality only at this time.

    When flattening transparency with this mode set, the renderer
    transform used by ISeparator will attempt to maintain vector
    and textual information as much as possible in its results,
    and may not need to render some objects at all.

    However, for very complicated cases this may result in a large
    amount of output geometry that could result in larger output
    files or files that process more slowly than an equivalent
    raster render.

    The default is false.

◆ setRasterFallbackThreshold()

virtual void JawsMako::ISeparator::setRasterFallbackThreshold ( uint32 rasterFallbackThreshold)
pure virtual

For cases where the vector mode is used, set the threshold at which to fall back to raster mode for a particular renderable area.

The threshold is specified in terms of rendered objects per square inch. If a rendererable area would result in more generated objects than this threshold, the renderer will fall back to a pure raster.

The default value is 100.

A value of 0 will cause the transform to always use a vector approach.

This value is ignored if setEnableVectorMode() is false.


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