This color space is analogous to the PostScript/PDF DeviceN/Separation color spaces. More...

#include <idomcolorspace.h>

Inheritance diagram for IDOMColorSpaceDeviceN:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual bool	getIsNChannel () const =0
	Get if the color space represents an NChannel color space.

virtual IDOMColorSpacePtr	getAlternateColorSpace () const =0
	Get the alternate color space for this color space, which must be present. An exception of type IEDLError is thrown if it is missing.

virtual bool	getHasRealColorant () const =0
	Determine if this DeviceN color space contains only the special "None" colorant (or the strange case where there are multiple colorants all with the name "None"). Such color spaces will never render or mark a page.

virtual IDOMFunctionPtr	getTintTransform () const =0
	Get the function that maps components of this space to component(s) of the alternate color space. Must be present. An exception of type IEDLError is thrown if it is missing.

virtual IDOMDeviceNColorantPtr	getColorant (uint8 component) const =0
	Get the colorant information for a component at the given index. An exception of type IEDLError is thrown on failure.

virtual IDOMColorSpacePtr	getProcessColorSpace () const =0
	Get the Process color space associated with this DeviceN space. (See Table 4.22 of the PDF 1.7 Reference). Optional.

virtual const CEDLRawStringVect &	getProcessComponentNames () const =0
	Get the vector of Process component names to those in the associated process color space (see Table 4.22 of the PDF 1.7 reference). An exception of IEDLError is thrown on failure, which should not happen.

virtual const CEDLRawStringVect &	getPrintingOrder () const =0
	Get the list of component names describing the printing order of the device N colorants. An exception of IEDLError is thrown on failure, which should not happen.

virtual CColorantInfoVect	getColorantInfo (IEDLClassFactory *factory, const IDOMColorSpacePtr &colorantSpace=IDOMColorSpacePtr()) const =0
	Convenience method to populate a CColorantInfoVect from the DeviceN colorspace.

Public Member Functions inherited from IDOMColorSpace
virtual eColorSpaceType	getColorSpaceType ()=0
	Retrieves the color space type.

virtual uint8	getNumComponents ()=0
	Retrieves the number of components that are in colors in this color space.

virtual bool	getComponentsHaveSameRange ()=0
	Checks if this color space has the same range for all its components. Some color spaces (such as Lab and ICC) may not have the same range for all its components. If a color space does have the same range for all its components, you only need to call getComponentRange() once to find the range for all components.

virtual bool	getComponentRange (int component, float &low, float &high)=0
	Retrieves the expected range of component values for a given channel, if applicable.

virtual eRenderingIntent	getDefaultRenderingIntent ()=0
	Retrieves the default rendering intent for this color space.

virtual EDLRawString	getColorantName (uint8 component) const =0
	Determine the colorant name for a colorant index. If a colorant name cannot be determined, an IEDLError with type EDL_ERR_NO_COLOR_NAME will be thrown. Cannot be called on Indexed or LAB color spaces. For device spaces and simple ICC color spaces, the basic process color name will be returned (ie one of Gray, Red, Green, Blue, Cyan, Magenta, Yellow, Black as appropriate).

virtual bool	equals (const IDOMColorSpacePtr &colorSpace, bool exact=false)=0
	Determines if the given color space is equivalent to this color space.

virtual bool	similar (const IDOMColorSpacePtr &colorSpace, eRenderingIntent intent, eBlackPointCompensation bpc)=0
	Determines if the given color space is very similar to this color space for the given rendering intent. Color spaces are tested via selective sampling and are considered similar if the samples show the same results to a 10 bit accuracy. This can be an expensive operation for complicated color spaces.

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.

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.

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static EDL_API IDOMColorSpaceDeviceNPtr	create (IEDLClassFactory *pFactory, const CEDLRawStringVect &colorants, const IDOMColorSpacePtr &alternate, const IDOMFunctionPtr &tintTransform, const IDOMColorSpacePtr &processColorSpace=IDOMColorSpacePtr())
	Create a simple DeviceN Color Space. Throws an IEDLError on failure.

static EDL_API IDOMColorSpaceDeviceNPtr	create (IEDLClassFactory *pFactory, const CDeviceNColorantVect &colorants, const IDOMColorSpacePtr &alternate, const IDOMFunctionPtr &tintTransform, const IDOMColorSpacePtr &processColorSpace=IDOMColorSpacePtr(), const CEDLRawStringVect &processComponents=CEDLRawStringVect(), const CEDLRawStringVect &printingOrder=CEDLRawStringVect(), bool isNChannel=false)
	Create a DeviceN Color Space. Throws an IEDLError on failure.

static EDL_API IDOMColorSpaceDeviceNPtr	create (IEDLClassFactory *pFactory, const CColorantInfoVect &colorants, const IDOMColorSpacePtr &alternate, const IDOMColorSpacePtr &processColorSpace=IDOMColorSpacePtr())
	Create a simple DeviceN Color Space, with automatic generation of the tint transform function. Throws an IEDLError on failure.

static const CClassID &	classID ()
	Retrieves class id of IDOMColorSpaceDeviceN.

Additional Inherited Members
Public Types inherited from IDOMColorSpace
enum	eColorSpaceType { eDeviceRGB , eDeviceGray , eDeviceCMYK , esRGB , esGray , escRGB , eICCBased , eIndexed , eDeviceN , eLAB , eDeviceCMY , eNumColorSpaceTypes = 11 }
	Color spaces type enumeration. More...

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

Detailed Description

This color space is analogous to the PostScript/PDF DeviceN/Separation color spaces.

   See section 4.5.5 of the PDF Reference, version 1.7

Member Function Documentation

◆ classID()

static const CClassID & IDOMColorSpaceDeviceN::classID ( )

inlinestatic

Retrieves class id of IDOMColorSpaceDeviceN.

Returns: CClassID Class id of the element

◆ create() [1/3]

static EDL_API IDOMColorSpaceDeviceNPtr IDOMColorSpaceDeviceN::create	(	IEDLClassFactory *	pFactory,
		const CColorantInfoVect &	colorants,
		const IDOMColorSpacePtr &	alternate,
		const IDOMColorSpacePtr &	processColorSpace = IDOMColorSpacePtr() )

static

Create a simple DeviceN Color Space, with automatic generation of the tint transform function. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
colorants	A vector of CColorantInfo classes, specifying the name of each colorant, the color components of that colorant in its alternate color space, and (optionally) an alternate color space for that particular colorant. If the alternate color space is not provided for a given colorant then the components are interpreted using the DeviceN alternate.
alternate	The alternate color space.
processColorSpace	The PDF process color space associated with this DeviceN color space. Optional.

Returns: IDOMColorSpaceDeviceN The new color space.

◆ create() [2/3]

static EDL_API IDOMColorSpaceDeviceNPtr IDOMColorSpaceDeviceN::create	(	IEDLClassFactory *	pFactory,
		const CDeviceNColorantVect &	colorants,
		const IDOMColorSpacePtr &	alternate,
		const IDOMFunctionPtr &	tintTransform,
		const IDOMColorSpacePtr &	processColorSpace = IDOMColorSpacePtr(),
		const CEDLRawStringVect &	processComponents = CEDLRawStringVect(),
		const CEDLRawStringVect &	printingOrder = CEDLRawStringVect(),
		bool	isNChannel = false )

static

Create a DeviceN Color Space. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
colorants	A vector of smart pointers to IDOMDeviceNColorant objects
alternate	The alternate color space.
tintTransform	A function that maps colors in the space to the alternate color space.
processColorSpace	The PDF process color space associated with this DeviceN color space. Optional.
processComponents	A vector containing a list of process components. Optional
printingOrder	A vector containing a list defining the printing order. Optional
isNChannel	Specifies if the new color space is NChannel. Optional

Returns: IDOMColorSpaceDeviceN The new color space.

◆ create() [3/3]

static EDL_API IDOMColorSpaceDeviceNPtr IDOMColorSpaceDeviceN::create	(	IEDLClassFactory *	pFactory,
		const CEDLRawStringVect &	colorants,
		const IDOMColorSpacePtr &	alternate,
		const IDOMFunctionPtr &	tintTransform,
		const IDOMColorSpacePtr &	processColorSpace = IDOMColorSpacePtr() )

static

Create a simple DeviceN Color Space. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
colorants	A vector of colorant names for the device inks
alternate	The alternate color space.
tintTransform	A function that maps colors in the space to the alternate color space.
processColorSpace	The PDF process color space associated with this DeviceN color space. Optional.

Returns: IDOMColorSpaceDeviceN The new color space.

◆ getAlternateColorSpace()

virtual IDOMColorSpacePtr IDOMColorSpaceDeviceN::getAlternateColorSpace ( ) const

pure virtual

Get the alternate color space for this color space, which must be present. An exception of type IEDLError is thrown if it is missing.

Returns: IDOMColorSpacePtr The alternate space.

◆ getColorant()

virtual IDOMDeviceNColorantPtr IDOMColorSpaceDeviceN::getColorant ( uint8 component ) const

pure virtual

Get the colorant information for a component at the given index. An exception of type IEDLError is thrown on failure.

Parameters

component The 0 base component index of the desired colorant

Returns: IDOMDeviceNColorantPtr The colorant information.

◆ getColorantInfo()

virtual CColorantInfoVect IDOMColorSpaceDeviceN::getColorantInfo	(	IEDLClassFactory *	factory,
		const IDOMColorSpacePtr &	colorantSpace = IDOMColorSpacePtr() ) const

pure virtual

Convenience method to populate a CColorantInfoVect from the DeviceN colorspace.

Parameters

factory	The EDL Class factory to use.
colorantSpace	The target color space for the components. If not provided, the alternate color space will be used.

◆ getHasRealColorant()

virtual bool IDOMColorSpaceDeviceN::getHasRealColorant ( ) const

pure virtual

Determine if this DeviceN color space contains only the special "None" colorant (or the strange case where there are multiple colorants all with the name "None"). Such color spaces will never render or mark a page.

Returns: bool Returns true if there is at least one none "None" colorant present, false otherwise.

◆ getIsNChannel()

virtual bool IDOMColorSpaceDeviceN::getIsNChannel ( ) const

pure virtual

Get if the color space represents an NChannel color space.

Returns: bool True if an NChannel color space

◆ getPrintingOrder()

virtual const CEDLRawStringVect & IDOMColorSpaceDeviceN::getPrintingOrder ( ) const

pure virtual

Get the list of component names describing the printing order of the device N colorants. An exception of IEDLError is thrown on failure, which should not happen.

Returns: CEDLRawStringVect The printing order component names vector.

◆ getProcessColorSpace()

virtual IDOMColorSpacePtr IDOMColorSpaceDeviceN::getProcessColorSpace ( ) const

pure virtual

Get the Process color space associated with this DeviceN space. (See Table 4.22 of the PDF 1.7 Reference). Optional.

Returns: IDOMColorSpacePtr The process color space if present, NULL otherwise.

◆ getProcessComponentNames()

virtual const CEDLRawStringVect & IDOMColorSpaceDeviceN::getProcessComponentNames ( ) const

pure virtual

Get the vector of Process component names to those in the associated process color space (see Table 4.22 of the PDF 1.7 reference). An exception of IEDLError is thrown on failure, which should not happen.

Returns: CEDLRawStringVect The component names vector.

◆ getTintTransform()

virtual IDOMFunctionPtr IDOMColorSpaceDeviceN::getTintTransform ( ) const

pure virtual

Get the function that maps components of this space to component(s) of the alternate color space. Must be present. An exception of type IEDLError is thrown if it is missing.

Returns: IDOMFunctionPtr The function.

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

idomcolorspace.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ getAlternateColorSpace()

◆ getColorant()

◆ getColorantInfo()

◆ getHasRealColorant()

◆ getIsNChannel()

◆ getPrintingOrder()

◆ getProcessColorSpace()

◆ getProcessComponentNames()

◆ getTintTransform()