Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFGraphicResource Class Reference
[DWF Package API]

#include "dwf/package/GraphicResource.h"

Inheritance diagram for DWFToolkit::DWFGraphicResource:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFGraphicResource:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a persistent stream of visualization data.
Since:
7.0.1.

A graphic resource encapsulates visual vector or raster data.

Examples:

SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and SimpleW3DStreamProcessor/SimpleW3DStreamProcessor.cpp.

Definition at line 44 of file GraphicResource.h.

Public Types

enum  teOrientation

Public Member Functions

_DWFTK_API DWFGraphicResource (DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFGraphicResource (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 ~DWFGraphicResource () throw ()
_DWFTK_API bool show () const throw ()
_DWFTK_API int zOrder () const throw ()
_DWFTK_API const double *const clip () const throw ()
_DWFTK_API const double *const extents () const throw ()
_DWFTK_API const double *const transform () const throw ()
_DWFTK_API int effectiveResolution () const throw ()
_DWFTK_API const DWFStringauthor () const throw ()
_DWFTK_API const DWFStringdescription () const throw ()
_DWFTK_API const DWFStringcreationTime () const throw ()
_DWFTK_API const DWFStringmodificationTime () const throw ()
_DWFTK_API teOrientation orientation () const throw ()
_DWFTK_API void configureGraphic (const double *anTransform, const double *anExtents=NULL, const double *anClip=NULL, bool bShow=true, int nZOrder=0, int nEffectiveResolution=0, teOrientation eOrientation=eNotSpecified) throw ( DWFException )
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Member Enumeration Documentation

enum DWFToolkit::DWFGraphicResource::teOrientation
 

???

Definition at line 52 of file GraphicResource.h.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFGraphicResource::DWFGraphicResource 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::DWFGraphicResource::DWFGraphicResource 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::DWFGraphicResource::~DWFGraphicResource  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::DWFGraphicResource::author  )  const throw () [inline]
 

Returns the optional field the individual or application that created the original graphics data set.

Returns:
The author.
Exceptions:
None 

Definition at line 200 of file GraphicResource.h.

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

Returns the path by which the graphic data should be clipped.

Returns:
The clipping path. This pointer should not be deleted by the caller.
Exceptions:
None 

Definition at line 150 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFGraphicResource::configureGraphic const double *  anTransform,
const double *  anExtents = NULL,
const double *  anClip = NULL,
bool  bShow = true,
int  nZOrder = 0,
int  nEffectiveResolution = 0,
teOrientation  eOrientation = eNotSpecified
throw ( DWFException )
 

Sets the visualization parameters for the graphic data.

Parameters:
anTransform The 4x4 matrix used to translate the data into a section-specific target space (paper, units, etc.) These data will be copied.
anExtents The geometric bounds of the graphics data. These data will be copied.
anClip The path by which the graphic data should be clipped. These data will be copied.
bShow A flag indicating whether or not this graphic data should be displayed or rendered by default.
nZOrder The relative z-ordering (display priority) for the graphic data.
nEffectiveResolution ???
eOrientation An enumeration indicating the desired orientation of the graphic on the target.
Exceptions:
DWFException 
Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp, and SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

_DWFTK_API const DWFString& DWFToolkit::DWFGraphicResource::creationTime  )  const throw () [inline]
 

Returns the optional field indicating the origin of the graphics data.

Returns:
The creation time.
Exceptions:
None 

Definition at line 226 of file GraphicResource.h.

_DWFTK_API const DWFString& DWFToolkit::DWFGraphicResource::description  )  const throw () [inline]
 

Returns the optional field detailed information about the graphics.

Returns:
The description.
Exceptions:
None 

Definition at line 213 of file GraphicResource.h.

_DWFTK_API int DWFToolkit::DWFGraphicResource::effectiveResolution  )  const throw () [inline]
 

???

Definition at line 187 of file GraphicResource.h.

_DWFTK_API const double* const DWFToolkit::DWFGraphicResource::extents  )  const throw () [inline]
 

Returns the geometric bounds of the graphics data.

Returns:
The bounding geometry. This pointer should not be deleted by the caller.
Exceptions:
None 

Definition at line 163 of file GraphicResource.h.

_DWFTK_API const DWFString& DWFToolkit::DWFGraphicResource::modificationTime  )  const throw () [inline]
 

Returns the optional field indicating the last modification of the graphics data.

Returns:
The last modification time.
Exceptions:
None 

Definition at line 239 of file GraphicResource.h.

_DWFTK_API teOrientation DWFToolkit::DWFGraphicResource::orientation  )  const throw () [inline]
 

Returns an enumeration indicating the desired orientation of the graphic on the target.

Returns:
The orientation enumeration.
Exceptions:
None 

Definition at line 252 of file GraphicResource.h.

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

Receives and processes an attribute list from the parser; using it to initialize class members.

Example:

                 size_t iAttrib = 0;
       
                 for(; ppAttributeList[iAttrib]; iAttrib += 2)
                 {
                    //
                    // dump attribute 
                    //
                    cout << "Attribute Name: " << ppAttributeList[iAttrib] << " ";
                    cout << "Attribute Value: " << ppAttributeList[iAttrib+1] << endl;
                }

Parameters:
ppAttributeList An array of null-terminated atribute name, value string pairs. The array itself is zero-terminated.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFResource.

Reimplemented in DWFToolkit::DWFImageResource.

virtual _DWFTK_API void DWFToolkit::DWFGraphicResource::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

Writes an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
nFlags An implementation-defined set of options for altering the serialization process of this object.

Reimplemented from DWFToolkit::DWFResource.

Reimplemented in DWFToolkit::DWFImageResource.

_DWFTK_API bool DWFToolkit::DWFGraphicResource::show  )  const throw () [inline]
 

Returns a flag indicating whether or not this graphic data should be displayed or rendered by default.

Returns:
If true, the graphical content should be displayed by default.
Exceptions:
None 

Definition at line 124 of file GraphicResource.h.

_DWFTK_API const double* const DWFToolkit::DWFGraphicResource::transform  )  const throw () [inline]
 

Returns the 4x4 matrix used to translate the data into a section-specific target space (paper, units, etc.)

Returns:
The 4x4 transformation matrix. This pointer should not be deleted by the caller.
Exceptions:
None 

Definition at line 177 of file GraphicResource.h.

_DWFTK_API int DWFToolkit::DWFGraphicResource::zOrder  )  const throw () [inline]
 

Returns the relative z-ordering (display priority) for the graphic data.

Returns:
The z-order index.
Exceptions:
None 

Definition at line 137 of file GraphicResource.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:00 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1