IDOMRecombineImage Class Reference

Interface to a class representing a image made up of separate single channel images (each with the same bps, dimensions and resolution) each representing a single component of the entire image, or a mask channel. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMRecombineImage:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual bool	getStream (IInputStreamPtr &stream) const
	This image type does not allow direct access to the underlying streams.
virtual void	setStream (const IInputStreamPtr &stream)
	This image type does not allow direct access to the underlying streams.
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.
virtual IImageFramePtr	getImageFrame (IEDLClassFactory *factory)
	Fetch the image frame; convenience.
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.
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.
virtual eDOMImageType	getImageType ()=0
	Retrieves the image type.
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).
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.
Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream.
virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available.
virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI.
virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI.
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 IDOMRecombineImagePtr	create (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &colorSpace, const CEDLVector< IDOMImagePtr > &componentImages, const IDOMImagePtr &extraChannel=IDOMImagePtr(), bool extraChannelIsMask=false)
	Convenience creator for a recombine image.
static const CClassID &	classID ()
	Retrieves class id of IDOMRecombineImage.

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

Detailed Description

Interface to a class representing a image made up of separate single channel images (each with the same bps, dimensions and resolution) each representing a single component of the entire image, or a mask channel.

Member Function Documentation

classID()

static const CClassID & IDOMRecombineImage::classID ( )

inlinestatic

Retrieves class id of IDOMRecombineImage.

Returns

CClassID Class id of the element

create()

static EDL_API IDOMRecombineImagePtr IDOMRecombineImage::create ( IEDLClassFactory * pFactory, const IDOMColorSpacePtr & colorSpace, const CEDLVector< IDOMImagePtr > & componentImages, const IDOMImagePtr & extraChannel = IDOMImagePtr(), bool extraChannelIsMask = false )

static

Convenience creator for a recombine image.

Parameters

pFactory	The class factory to use
colorSpace	The color space that describes the color channels
componentImages	A vector of images each providing a single color channel
extraChannel	The image to be used as an alpha channel or mask, if required
extraChannelIsMask	If true, the extraChannel is treated as a mask channel, not an alpha channel

Returns

IDOMRecombineImagePtr The recombined image

getStream()

virtual bool IDOMRecombineImage::getStream ( IInputStreamPtr & stream ) const

inlinevirtual

This image type does not allow direct access to the underlying streams.

Parameters

stream

A smart pointer to the stream

Returns

bool Always false

setStream()

virtual void IDOMRecombineImage::setStream ( const IInputStreamPtr & stream )

inlinevirtual

This image type does not allow direct access to the underlying streams.

Parameters

stream

A smart pointer to the stream

Implements IDOMResource.

---

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

• idomimageresource.h