Mako 7.4.0 API
Loading...
Searching...
No Matches
IDOMDeviceNColorant Class Referenceabstract

This class enables the specification of colorant information for PDF style NChannel variants of DeviceN color spaces. More...

#include <idomcolorspace.h>

Inheritance diagram for IDOMDeviceNColorant:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual const EDLRawString & getName ()=0
 Get the name of the colorant, which must be present. An exception of type IEDLError will be thrown if it is missing.
 
virtual bool getSolidity (float &solidity)=0
 Get the solidity of the colorant.
 
virtual IDOMFunctionPtr getTintTransform ()=0
 Get the function that maps the colorant to component(s) of the alternate color space. Optional.
 
virtual IDOMFunctionPtr getDotGainFunction ()=0
 Get the function that describes the dot gain of the colorant on the intended output device. Optional.
 
virtual IDOMColorSpacePtr getAlternateColorSpace ()=0
 Get the alternate color space for this colorant. Optional.
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () 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 const CClassIDclassID ()
 Retrieves class id fo IDOMDeviceNColorant.
 

Additional Inherited Members

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

Detailed Description

This class enables the specification of colorant information for PDF style NChannel variants of DeviceN color spaces.

Member Function Documentation

◆ classID()

static const CClassID & IDOMDeviceNColorant::classID ( )
inlinestatic

Retrieves class id fo IDOMDeviceNColorant.

Returns
CClassID Class id of the element

◆ getAlternateColorSpace()

virtual IDOMColorSpacePtr IDOMDeviceNColorant::getAlternateColorSpace ( )
pure virtual

Get the alternate color space for this colorant. Optional.

Returns
IDOMColorSpacePtr The alternate space if present, NULL otherwise.

◆ getDotGainFunction()

virtual IDOMFunctionPtr IDOMDeviceNColorant::getDotGainFunction ( )
pure virtual

Get the function that describes the dot gain of the colorant on the intended output device. Optional.

Returns
IDOMFunctionPtr The function if present, NULL otherwise.

◆ getName()

virtual const EDLRawString & IDOMDeviceNColorant::getName ( )
pure virtual

Get the name of the colorant, which must be present. An exception of type IEDLError will be thrown if it is missing.

Returns
EDLRawString The name of the colorant.

◆ getSolidity()

virtual bool IDOMDeviceNColorant::getSolidity ( float & solidity)
pure virtual

Get the solidity of the colorant.

Parameters
solidityReference to receive the solidity
Returns
bool Returns true on success, false if the colorant has no solidity specified.

◆ getTintTransform()

virtual IDOMFunctionPtr IDOMDeviceNColorant::getTintTransform ( )
pure virtual

Get the function that maps the colorant to component(s) of the alternate color space. Optional.

Returns
IDOMFunctionPtr The function if present, NULL otherwise.

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