Mako 7.3.0 API
IDOMPSDImage Class Referenceabstract

IDOMPSDImage interface. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMPSDImage:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual int16 getLayerIndex () const =0
 Get the layer index of this image from the PSD. More...
 
- Public Member Functions inherited from IDOMImage
virtual IImageDecoderPtr createImageDecoder (IEDLClassFactory *factory, const IDOMImagePropertiesPtr &imageProperties)=0
 Creates a properly initialized image decoder object that reads from an inputstream that is specific to that image format. More...
 
virtual IImageFramePtr getImageFrame (IEDLClassFactory *factory)
 Fetch the image frame; convenience. More...
 
virtual IImageEncoderPtr createImageEncoder (const ISessionPtr &session, const IOutputStreamPtr &imageDest, const IDOMImagePropertiesPtr &imageProperties)=0
 Creates a properly initialized image encoder object that writes to an outputstream that is specific to that image format. More...
 
virtual IDOMImagePropertiesPtr getImageProperties ()=0
 Returns an object that stores the properties for this image object. The properties can then be inspected (or more added) by clients that need to manipulate the image resource. More...
 
virtual eDOMImageType getImageType ()=0
 Retrieves the image type. More...
 
virtual bool getIsRendered ()=0
 Determine if the image is as a result of rendering. This is indicated if the image type is eDITRendered or if the image explicitly notes this is the case (such as for IDOMPDFImage). More...
 
virtual IDOMImagePtr getImageWithSubstitutedColorSpace (IEDLClassFactory *factory, const IDOMColorSpacePtr &colorSpace)
 Obtain an image that is the same as this image, but with the colorspace substituted for another. More...
 
- Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr getStream () const =0
 Retrieves the resource stream. More...
 
virtual void setStream (const IInputStreamPtr &stream)=0
 Sets the resource stream for the node. More...
 
virtual uint64 getStreamLength () const =0
 Retrieves the stream length, if it is available. More...
 
virtual const EDLSysString & getUri () const =0
 Retrieves the resource URI. More...
 
virtual void setUri (const EDLSysString &uri)=0
 Sets the resource URI. More...
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
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. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- 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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 
- Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
 
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object. More...
 
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails. More...
 

Static Public Member Functions

static EDL_API IDOMPSDImagePtr create (IEDLClassFactory *pFactory, const IInputStreamPtr &stream, int16 layerIndex=0)
 Create a PSD Image resource with the given PSD stream. More...
 
static const CClassIDclassID ()
 Retrieves class id of IDOMPSDImage. More...
 

Additional Inherited Members

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

Detailed Description

IDOMPSDImage interface.

Member Function Documentation

◆ classID()

static const CClassID& IDOMPSDImage::classID ( )
inlinestatic

Retrieves class id of IDOMPSDImage.

Returns
CClassID Class id of the element

◆ create()

static EDL_API IDOMPSDImagePtr IDOMPSDImage::create ( IEDLClassFactory pFactory,
const IInputStreamPtr &  stream,
int16  layerIndex = 0 
)
static

Create a PSD Image resource with the given PSD stream.

Parameters
pFactoryThe EDL Class factory to use.
streamThe stream containing the PSD image.
layerIndexFor multi-layer PSD files, the index of the layer to use, with 0 being the composite image.
Returns
IDOMPSDImagePtr The new image.

◆ getLayerIndex()

virtual int16 IDOMPSDImage::getLayerIndex ( ) const
pure virtual

Get the layer index of this image from the PSD.

PSD files may contain multiple layers; this member returns the index (beginning at 0) of the layer that will be used from the PSD file. If 0 then this is the composite image composed of all layers.

Returns
int16 The layer index

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