IDOMFilteredImage interface. Provides a method for filtering of an underlying image without requiring converted image data to be stored. It maintains a list of filters that are successively applied. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMFilteredImage:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual void	pushFilter (const IDOMImageFilterPtr &filter)=0
	Push a filter onto the end of the internal filter chain. More...

virtual uint32	getNumFilters () const =0
	Get the number of individual filters in the internal filter chain. More...

virtual IDOMImageFilterPtr	getFilterAtIndex (uint32 index) const =0
	Get a filter from the filter chain at the given index. More...

virtual IDOMImagePtr	getSourceImage () const =0
	Get the source image. 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 IDOMFilteredImagePtr	create (IEDLClassFactory *pFactory, const IDOMImagePtr &sourceImage, const IDOMImageFilterPtr &filter)
	Simplified creator for a filtered image with a single filter. More...

static EDL_API IDOMFilteredImagePtr	create (IEDLClassFactory *pFactory, const IDOMImagePtr &sourceImage, const CDOMImageFilterVect &filters)
	Simplified creator for a filtered image with a vector of filters. More...

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

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

Detailed Description

IDOMFilteredImage interface. Provides a method for filtering of an underlying image without requiring converted image data to be stored. It maintains a list of filters that are successively applied.

Member Function Documentation

◆ classID()

static const CClassID& IDOMFilteredImage::classID ( )

inlinestatic

Retrieves class id of IDOMFilteredImage.

Returns: CClassID Class id of the element

◆ create() [1/2]

static EDL_API IDOMFilteredImagePtr IDOMFilteredImage::create	(	IEDLClassFactory *	pFactory,
		const IDOMImagePtr &	sourceImage,
		const CDOMImageFilterVect &	filters
	)

static

Simplified creator for a filtered image with a vector of filters.

Parameters

pFactory	The EDL Class Factory
sourceImage	The source image.
filters	The vector of filters to instantiate with.

Returns: IDOMFilteredImagePtr The filtered image.

◆ create() [2/2]

static EDL_API IDOMFilteredImagePtr IDOMFilteredImage::create	(	IEDLClassFactory *	pFactory,
		const IDOMImagePtr &	sourceImage,
		const IDOMImageFilterPtr &	filter
	)

static

Simplified creator for a filtered image with a single filter.

Parameters

pFactory	The EDL Class Factory
sourceImage	The source image.
filter	The filter to use.

Returns: IDOMFilteredImagePtr The filtered image.

◆ getFilterAtIndex()

virtual IDOMImageFilterPtr IDOMFilteredImage::getFilterAtIndex ( uint32 index ) const

pure virtual

Get a filter from the filter chain at the given index.

Parameters

index Index of the desired filter in the chain (beginning at 0)

Returns: IDOMImageFilterPtr The filter

◆ getNumFilters()

virtual uint32 IDOMFilteredImage::getNumFilters ( ) const

pure virtual

Get the number of individual filters in the internal filter chain.

Returns: uint32 The number of filters.

◆ getSourceImage()

virtual IDOMImagePtr IDOMFilteredImage::getSourceImage ( ) const

pure virtual

Get the source image.

Returns: IDOMImagePtr Smart pointer to the source image.

◆ getStream()

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

◆ pushFilter()

virtual void IDOMFilteredImage::pushFilter ( const IDOMImageFilterPtr & filter )

pure virtual

Push a filter onto the end of the internal filter chain.

Parameters

filter A pointer to the image filter to be added.

◆ setStream()

virtual void IDOMFilteredImage::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() [1/2]

◆ create() [2/2]

◆ getFilterAtIndex()

◆ getNumFilters()

◆ getSourceImage()

◆ getStream()

◆ pushFilter()

◆ setStream()