DWFToolkit::DWFImage Interface Reference
[DWF Publisher API]

#include "dwf/publisher/Image.h"

Collaboration diagram for DWFToolkit::DWFImage:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a publishable image.

Since:
7.0.1
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 49 of file Image.h.

Public Types

enum  teResourceType

Public Member Functions

_DWFTK_API DWFImage (const DWFString &zMIMEType, teResourceType eType, unsigned char nBitsPerPixel, double nWidth, double nHeight, double *pClipRegion=NULL) throw ()
_DWFTK_API ~DWFImage () throw ()
_DWFTK_API void attach (DWFInputStream *pImageStream, bool bOwnStream) throw ( DWFException )
_DWFTK_API const DWFStringgetMIMEType () throw ()
_DWFTK_API DWFInputStreamgetInputStream () throw ( DWFException )
_DWFTK_API teResourceType type () const throw ()
_DWFTK_API unsigned char depth () const throw ()
_DWFTK_API double width () const throw ()
_DWFTK_API double height () const throw ()
_DWFTK_API double * clip () const throw ()


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFImage::DWFImage const DWFString zMIMEType,
teResourceType  eType,
unsigned char  nBitsPerPixel,
double  nWidth,
double  nHeight,
double *  pClipRegion = NULL
throw () [inline]
 

Constructor

Parameters:
zMIMEType The MIME type of the image data.
eType An enumeration describing the image role/type.
nBitsPerPixel The image pixel depth.
nWidth The horizontal extent of the image in pixels.
nHeight The veritical extent of the image in pixels.
pClipRegion An optional path against which the image should be clipped when shown. This pointer is not copied; the caller must delete this memory when no longer in use.
Exceptions:
None 
Todo:
The clipping data should be copied.

Definition at line 83 of file Image.h.

_DWFTK_API DWFToolkit::DWFImage::~DWFImage  )  throw () [inline]
 

Destructor

Exceptions:
None 

Definition at line 106 of file Image.h.


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFImage::attach DWFInputStream pImageStream,
bool  bOwnStream
throw ( DWFException ) [inline]
 

Binds a data source stream to the object.

Parameters:
pImageStream The data stream.
bOwnStream If true, this object will delete pImageStream on destruction; pImageStream must be allocated with DWFCORE_ALLOC_OBJECT.
Exceptions:
None 
Examples:
3DPublish/3DPublish_UTF8.cpp.

Definition at line 125 of file Image.h.

_DWFTK_API double* DWFToolkit::DWFImage::clip  )  const throw () [inline]
 

Returns the clipping path to apply to the image when shown.

Returns:
The clipping path (may be NULL.)
Exceptions:
None 

Definition at line 236 of file Image.h.

_DWFTK_API unsigned char DWFToolkit::DWFImage::depth  )  const throw () [inline]
 

Returns the image pixel depth.

Returns:
The bits per image pixel.
Exceptions:
None 

Definition at line 197 of file Image.h.

_DWFTK_API DWFInputStream* DWFToolkit::DWFImage::getInputStream  )  throw ( DWFException ) [inline]
 

Returns a stream from which the image data can be read.

Returns:
The data stream. The caller must delete the pointer with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 
Todo:
The original stream is wrapped in a buffer stream which prevents its deletion and allows another publisher to acquire its data. However, the original stream is never rewound or verified that such an operation is possible. Update this implementation to perform the expected behavior.

Definition at line 163 of file Image.h.

_DWFTK_API const DWFString& DWFToolkit::DWFImage::getMIMEType  )  throw () [inline]
 

Returns the MIME type of the image.

Returns:
The MIME type string.
Exceptions:
None 

Definition at line 145 of file Image.h.

_DWFTK_API double DWFToolkit::DWFImage::height  )  const throw () [inline]
 

Returns the vertical extent of the image in pixels.

Returns:
The image height.
Exceptions:
None 

Definition at line 223 of file Image.h.

_DWFTK_API teResourceType DWFToolkit::DWFImage::type  )  const throw () [inline]
 

Returns an enumeration describing the image role/type.

Returns:
The type enumeration.
Exceptions:
None 

Definition at line 184 of file Image.h.

_DWFTK_API double DWFToolkit::DWFImage::width  )  const throw () [inline]
 

Returns the horizontal extent of the image in pixels.

Returns:
The image width.
Exceptions:
None 

Definition at line 210 of file Image.h.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:40:44 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5