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

Represents a color space described by an ICC profile. More...

#include <idomcolorspace.h>

Inheritance diagram for IDOMColorSpaceICCBased:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual IDOMICCProfilePtr getICCProfile ()=0
 Retrieve the ICC profile for this color space. As a profile is required and should have been available at initialisation time, an exception of type IEDLError is thrown on failure.
 
virtual void setICCProfile (const IDOMICCProfilePtr &profile)=0
 Set the ICC profile for the color space.
 
virtual IDOMColorSpacePtr getAlternateColorSpace ()=0
 Gets the PDF alternate color space for this ICC-based color space. Useful for PDF input filter context.
 
virtual bool getIsLabColorSpace ()=0
 Determine if this ICC space represents a LAB color space.
 
- 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 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 EDL_API IDOMColorSpaceICCBasedPtr create (IEDLClassFactory *pFactory, const IDOMICCProfilePtr &profile, const IDOMColorSpacePtr &alternate=IDOMColorSpacePtr())
 Creation function for an IDOMColorspaceICCBased color space. Throws an IEDLError exception on failure.
 
static const CClassIDclassID ()
 Retrieves class id of IDOMColorSpaceICCBased.
 

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

Represents a color space described by an ICC profile.

Member Function Documentation

◆ classID()

static const CClassID & IDOMColorSpaceICCBased::classID ( )
inlinestatic

Retrieves class id of IDOMColorSpaceICCBased.

Returns
CClassID Class id of the element

◆ create()

static EDL_API IDOMColorSpaceICCBasedPtr IDOMColorSpaceICCBased::create ( IEDLClassFactory * pFactory,
const IDOMICCProfilePtr & profile,
const IDOMColorSpacePtr & alternate = IDOMColorSpacePtr() )
static

Creation function for an IDOMColorspaceICCBased color space. Throws an IEDLError exception on failure.

Parameters
pFactoryThe class factory.
profileThe profile to use
alternateThe alternate color space, if any. If not supplied and the profile has 1, 3, or 4 components, a Device color space alternate will be created.
Returns
IDOMColorSpaceICCBasedPtr The new color space.

◆ getAlternateColorSpace()

virtual IDOMColorSpacePtr IDOMColorSpaceICCBased::getAlternateColorSpace ( )
pure virtual

Gets the PDF alternate color space for this ICC-based color space. Useful for PDF input filter context.

Returns
IDOMColorSpacePtr The alternate space, or NULL if no present.

◆ getICCProfile()

virtual IDOMICCProfilePtr IDOMColorSpaceICCBased::getICCProfile ( )
pure virtual

Retrieve the ICC profile for this color space. As a profile is required and should have been available at initialisation time, an exception of type IEDLError is thrown on failure.

Returns
IDOMICCProfilePtr The profile.

◆ getIsLabColorSpace()

virtual bool IDOMColorSpaceICCBased::getIsLabColorSpace ( )
pure virtual

Determine if this ICC space represents a LAB color space.

Returns
bool true if the ICC profile represents a LAB color space, false otherwise.

◆ setICCProfile()

virtual void IDOMColorSpaceICCBased::setICCProfile ( const IDOMICCProfilePtr & profile)
pure virtual

Set the ICC profile for the color space.

Parameters
profileA reference to the new ICC profile.

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