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

This color space is analogous to the PostScript/PDF Indexed color space. More...

#include <idomcolorspace.h>

Inheritance diagram for IDOMColorSpaceIndexed:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual IDOMColorSpacePtr getUnderlyingColorSpace ()=0
 Get the underlying color space for this color space, which must be present. Throws an exception of type IEDLError on failure.
 
virtual IDOMFunctionPtr getMappingFunction ()=0
 Get the function that maps an index value to component(s) in the underlying color space. Must always be present. An exception of type IEDLError is thrown if it is missing.
 
- 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 IDOMColorSpaceIndexedPtr create (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &underlying, const IDOMFunctionPtr &mappingFunction)
 Create an Indexed Color Space. Throws an IEDLError on failure.
 
static EDL_API IDOMColorSpaceIndexedPtr create (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &underlying, const CEDLVector< uint8 > &table)
 Create an Indexed Color Space from an 8bpc table. Throws an IEDLError 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

This color space is analogous to the PostScript/PDF Indexed color space.

Instances of this type represent a mapping from an integral component value to components of an underlying color space using a Function.

  • Indexed color spaces cannot be used as the underlying space.
  • See section 4.8.4 of the PostScript Language Reference, 3rd Edition, and section 4.5.5 of the PDF Reference, version 1.7

Member Function Documentation

◆ classID()

static const CClassID & IDOMColorSpaceIndexed::classID ( )
inlinestatic

Retrieves class id of IDOMColorSpaceICCBased.

Returns
CClassID Class id of the element

◆ create() [1/2]

static EDL_API IDOMColorSpaceIndexedPtr IDOMColorSpaceIndexed::create ( IEDLClassFactory * pFactory,
const IDOMColorSpacePtr & underlying,
const CEDLVector< uint8 > & table )
static

Create an Indexed Color Space from an 8bpc table. Throws an IEDLError on failure.

Parameters
pFactoryThe EDL Class factory to use.
underlyingThe underlying color space.
tableAn 8-bit lookup table consisting of a color values for each index. For example, for an RGB underlying color space, the values are packed as [ <R for index 0>, <G for index 0>, <B for index 0>, <R for index 1>, <G for index 1> ... ]
Returns
IDOMColorSpaceIndexedPtr The new color space.

◆ create() [2/2]

static EDL_API IDOMColorSpaceIndexedPtr IDOMColorSpaceIndexed::create ( IEDLClassFactory * pFactory,
const IDOMColorSpacePtr & underlying,
const IDOMFunctionPtr & mappingFunction )
static

Create an Indexed Color Space. Throws an IEDLError on failure.

Parameters
pFactoryThe EDL Class factory to use.
underlyingThe underlying color space.
mappingFunctionA function that maps indexes to colors in the underlying color space.
Returns
IDOMColorSpaceIndexedPtr The new color space.

◆ getMappingFunction()

virtual IDOMFunctionPtr IDOMColorSpaceIndexed::getMappingFunction ( )
pure virtual

Get the function that maps an index value to component(s) in the underlying color space. Must always be present. An exception of type IEDLError is thrown if it is missing.

Returns
IDOMFunctionPtr The mapping function.

◆ getUnderlyingColorSpace()

virtual IDOMColorSpacePtr IDOMColorSpaceIndexed::getUnderlyingColorSpace ( )
pure virtual

Get the underlying color space for this color space, which must be present. Throws an exception of type IEDLError on failure.

Returns
IDOMColorSpacePtr The underlying color space.

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