IDOMImage Class Reference

The base class describing an image. This class is subclassed to create a number of more specific image types. Instances of these objects may throw IEDLError exceptions on failure. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMImage:

Classes
class	Data
	Initialization data. More...

Public Member Functions
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 void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node.
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.

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

Detailed Description

The base class describing an image. This class is subclassed to create a number of more specific image types. Instances of these objects may throw IEDLError exceptions on failure.

Member Function Documentation

createImageDecoder()

virtual IImageDecoderPtr IDOMImage::createImageDecoder ( IEDLClassFactory * factory, const IDOMImagePropertiesPtr & imageProperties )

pure virtual

Creates a properly initialized image decoder object that reads from an inputstream that is specific to that image format.

Parameters

factory	Pointer to the EDL class factory
imageProperties	Smart pointer to the DOM image properties interface, or NULL if there are no relevant properties to provide

Returns

IImageDecoderPtr The image decoder

createImageEncoder()

virtual IImageEncoderPtr IDOMImage::createImageEncoder ( const ISessionPtr & session, const IOutputStreamPtr & imageDest, const IDOMImagePropertiesPtr & imageProperties )

pure virtual

Creates a properly initialized image encoder object that writes to an outputstream that is specific to that image format.

Parameters

session	Pointer to the EDL session
imageDest	Smart pointer to the output stream
imageProperties	Smart pointer to the DOM image properties interface, or NULL if there are no relevant properties to provide

Returns

IImageEncoderPtr The encoder

getImageFrame()

virtual IImageFramePtr IDOMImage::getImageFrame ( IEDLClassFactory * factory )

virtual

Fetch the image frame; convenience.

Parameters

factory

Pointer to the EDL class factory

Returns

IImageFramePtr The frame.

getImageProperties()

virtual IDOMImagePropertiesPtr IDOMImage::getImageProperties ( )

pure virtual

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.

Returns

IDOMImagePropertiesPtr The image properties

getImageType()

virtual eDOMImageType IDOMImage::getImageType ( )

pure virtual

Retrieves the image type.

Returns

eDOMImageType The image type

getImageWithSubstitutedColorSpace()

virtual IDOMImagePtr IDOMImage::getImageWithSubstitutedColorSpace ( IEDLClassFactory * factory, const IDOMColorSpacePtr & colorSpace )

virtual

Obtain an image that is the same as this image, but with the colorspace substituted for another.

While this can be achieved by overlaying an IDOMFilteredImage with IDOMImageColorSpaceSubstitutionFilter, for some image types this can be done in a simpler manner by overriding the existing color space. internally.

If the operation would make no changes, then the existing image is returned. Otherwise a modified clone will be made.

Parameters

factory	Pointer to the EDL class factory
colorSpace	The colorspace to substitute

Returns

IDOMImagePtr The new image with substituted space, or the existing image if no changes were required.

getIsRendered()

virtual bool IDOMImage::getIsRendered ( )

pure virtual

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).

Returns

bool Whether or not this is a rendered image

---

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

• idomimageresource.h