DWFToolkit::DWFImageResource Class Reference
[DWF Package API]

#include "dwf/package/GraphicResource.h"

List of all members.


Detailed Description

This class represents a persistent stream of image data.

Since:
7.0.1
Examples:

3DPublish/3DPublish_UTF8.cpp, GlobalSectionWriter/GlobalSectionWriter.cpp, SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

Definition at line 454 of file GraphicResource.h.

Public Member Functions

_DWFTK_API DWFImageResource (DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFImageResource (const DWFString &zTitle, const DWFString &zRole, const DWFString &zMIME, const DWFString &zAuthor=L"", const DWFString &zDescription=L"", const DWFString &zCreationTime=L"", const DWFString &zModificationTime=L"") throw ()
virtual _DWFTK_API ~DWFImageResource () throw ()
_DWFTK_API bool scanned () const throw ()
_DWFTK_API bool invertColors () const throw ()
_DWFTK_API unsigned char colorDepth () const throw ()
_DWFTK_API int scannedResolution () const throw ()
_DWFTK_API const double *const originalExtents () const throw ()
_DWFTK_API void configureImage (unsigned char nColorDepth, bool bInvertColors=false, bool bScannedImage=false, int nScannedResolution=0, const double *anOriginalExtents=NULL) throw ( DWFException )
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFImageResource::DWFImageResource DWFPackageReader pPackageReader  )  throw ()
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read resource content data from the DWF package.

Parameters:
pPackageReader Provides access to resource content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFImageResource::DWFImageResource const DWFString zTitle,
const DWFString zRole,
const DWFString zMIME,
const DWFString zAuthor = L"",
const DWFString zDescription = L"",
const DWFString zCreationTime = L"",
const DWFString zModificationTime = L""
throw ()
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read resource content data from the DWF package.

Parameters:
zTitle The friendly/display name of the resource.
zRole Describes how the resource participates in the visualization.
zMIME The data MIME type of the resource content.
zAuthor An optional field for the individual or application that created the original graphics data set.
zDescription An optional field for detailed information about the graphics.
zCreationTime An optional field for indicating the origin of the graphics data.
zModificationTime An optional field for indicating the last time the graphics data was changed (should be in GMT with timezone format.) prior to its inclusion in the DWF package (should be in GMT with timezone format.)
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFImageResource::~DWFImageResource  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API unsigned char DWFToolkit::DWFImageResource::colorDepth  )  const throw () [inline]
 

The number of bits per image pixel.

Returns:
The bits per pixel.
Exceptions:
None 

Definition at line 546 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFImageResource::configureImage unsigned char  nColorDepth,
bool  bInvertColors = false,
bool  bScannedImage = false,
int  nScannedResolution = 0,
const double *  anOriginalExtents = NULL
throw ( DWFException )
 

Sets the visualization parameters for the image data.

This method should be called in addition to configureGraphic().

Parameters:
nColorDepth The number of bits per image pixel.
bInvertColors Indicates that the color data should be inverted as appropriate for the image type.
bScannedImage Indicates that this image data was acquired from a scanner.
nScannedResolution The DPI at which the original document was scanned.
anOriginalExtents The extents of the original scanned document. These data will be copied.
Exceptions:
DWFException 
Examples:
3DPublish/3DPublish_UTF8.cpp, GlobalSectionWriter/GlobalSectionWriter.cpp, SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

_DWFTK_API bool DWFToolkit::DWFImageResource::invertColors  )  const throw () [inline]
 

Returns a flag indicating that the color data should be inverted as appropriate for the image type.

RGB data should be flipped to BGR. Bitonal data should be inverted Black to White or non-Black (depending on the imaging flags.)

Exceptions:
None 

Definition at line 533 of file GraphicResource.h.

_DWFTK_API const double* const DWFToolkit::DWFImageResource::originalExtents  )  const throw () [inline]
 

If applicable, this method returns the extents of the original document.

Returns:
An array of four (4) values. This pointer must not be deleted by the caller.
Exceptions:
None 

Definition at line 575 of file GraphicResource.h.

virtual _DWFTK_API void DWFToolkit::DWFImageResource::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

_DWFTK_API bool DWFToolkit::DWFImageResource::scanned  )  const throw () [inline]
 

Returns a flag indicating that this image data was acquired from a scanner.

Returns:
If true, this is scanned image data.
Exceptions:
None 

Definition at line 518 of file GraphicResource.h.

_DWFTK_API int DWFToolkit::DWFImageResource::scannedResolution  )  const throw () [inline]
 

If applicable, this method returns the resolution (in DPI) at which the original document was scanned in order to create this image resource.

Returns:
The scanner DPI.
Exceptions:
None 

Definition at line 561 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFImageResource::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException )
 


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