Mako 7.5.0 API
Loading...
Searching...
No Matches
IDOMFilteredImage Class Referenceabstract

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:

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.
 
virtual uint32 getNumFilters () const =0
 Get the number of individual filters in the internal filter chain.
 
virtual IDOMImageFilterPtr getFilterAtIndex (uint32 index) const =0
 Get a filter from the filter chain at the given index.
 
virtual IDOMImagePtr getSourceImage () const =0
 Get the source image.
 
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 CClassIDgetClassID () 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 IDOMFilteredImagePtr create (IEDLClassFactory *pFactory, const IDOMImagePtr &sourceImage, const IDOMImageFilterPtr &filter)
 Simplified creator for a filtered image with a single filter.
 
static EDL_API IDOMFilteredImagePtr create (IEDLClassFactory *pFactory, const IDOMImagePtr &sourceImage, const CDOMImageFilterVect &filters)
 Simplified creator for a filtered image with a vector of filters.
 
static const CClassIDclassID ()
 Retrieves class id of IDOMFilteredImage.
 

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
pFactoryThe EDL Class Factory
sourceImageThe source image.
filtersThe 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
pFactoryThe EDL Class Factory
sourceImageThe source image.
filterThe 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
indexIndex 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
streamA 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
filterA 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
streamA smart pointer to the stream

Implements IDOMResource.


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