Interface to a class that when overlayed over an image will cache portions of its output. Useful for cases where images are repeatedly and are relatively expensive to process, and where the source image is certain to never change. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMCachedImage:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IDOMImagePtr	getSourceImage () const =0
	Retrieves the source image that is cached by this instance. More...

virtual bool	getStream (IInputStreamPtr &stream) const
	This image type does not allow direct access to the underlying streams. More...

virtual void	setStream (const IInputStreamPtr &stream)
	This image type does not allow direct access to the underlying streams. 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 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 CClassID &	getClassID () 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 IDOMCachedImagePtr	create (IEDLClassFactory *pFactory, const IDOMImagePtr &sourceImage, bool cacheSamples, bool alwaysCache=false)
	Simplified creator for a IDOMCachedImage. More...

static const CClassID &	classID ()
	Retrieves class id of IDOMCachedImage. More...

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

Detailed Description

Interface to a class that when overlayed over an image will cache portions of its output. Useful for cases where images are repeatedly and are relatively expensive to process, and where the source image is certain to never change.

Member Function Documentation

◆ classID()

static const CClassID& IDOMCachedImage::classID ( )

inlinestatic

Retrieves class id of IDOMCachedImage.

Returns: CClassID Class id of the element

◆ create()

static EDL_API IDOMCachedImagePtr IDOMCachedImage::create	(	IEDLClassFactory *	pFactory,
		const IDOMImagePtr &	sourceImage,
		bool	cacheSamples,
		bool	alwaysCache = `false`
	)

static

Simplified creator for a IDOMCachedImage.

Parameters

pFactory	The EDL Class Factory.
sourceImage	The image to use.
cacheSamples	Set to true if image samples should be cached in addition to metadata. Note that unless forceCache is also set, the samples may not always be actually cached, and may be cached only if the image samples are repeatedly requested. Also note that samples are never cached if the image is too large to be effectively cached.
alwaysCache	Set this (and cacheSamples) to true if samples should always be cached, subject to cache size limits. Consulted only if alwaysCache is true.

Returns: IDOMCachedImage The combined result.

◆ getSourceImage()

virtual IDOMImagePtr IDOMCachedImage::getSourceImage ( ) const

pure virtual

Retrieves the source image that is cached by this instance.

Returns: IDOMImagePtr The source image.

◆ getStream()

virtual bool IDOMCachedImage::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 IDOMCachedImage::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

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getSourceImage()

◆ getStream()

◆ setStream()