DWFToolkit::DWFGraphicResource Class Reference
[DWF Package API]

#include "dwf/package/GraphicResource.h"

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, SimpleW3DStreamProcessor/SimpleW3DStreamProcessor.cpp, and WriteContent/WriteContent.cpp.

Definition at line 45 of file GraphicResource.h.

Public Types

typedef DWFOrderedVector<
DWFGraphicResource * > 
tList
 This type defines a list of DWFGraphicResource pointers.
typedef DWFIterator< DWFGraphicResource * > tIterator
 This type defines a basic iterator on a collection of DWFGraphicResource pointers.
typedef DWFConstIterator<
DWFGraphicResource * > 
tConstIterator
 This type defines a basic const iterator on a collection of DWFGraphicResource pointers.
typedef DWFCachingIterator<
DWFGraphicResource * > 
tCachingIterator
 This type defines a caching iterator on a collection of DWFGraphicResource pointers.
typedef enum DWFToolkit::DWFGraphicResource::teOrientation teOrientation
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 void setAuthor (const DWFString &zAuthor) throw ()
_DWFTK_API const DWFStringdescription () const throw ()
_DWFTK_API void setDescription (const DWFString &zDescription) throw ()
_DWFTK_API const DWFStringcreationTime () const throw ()
_DWFTK_API void setCreationTime (const DWFString &zCreationTime) throw ()
_DWFTK_API const DWFStringmodificationTime () const throw ()
_DWFTK_API void setModificationTime (const DWFString &zModificationTime) throw ()
_DWFTK_API void addCoordinateSystem (DWFCoordinateSystem *pCS) throw ()
virtual _DWFTK_API DWFCoordinateSystem::tList::IteratorgetCoordinateSystems () throw ()
virtual _DWFTK_API void removeCoordinateSystem (DWFCoordinateSystem *pCS, bool bDelete) throw ( DWFException )
_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 )

Protected Attributes

bool _bShow
int _nZOrder
double _anClip [4]
double _anExtents [4]
double _anTransform [4][4]
int _nEffectiveResolution
DWFString _zAuthor
DWFString _zDescription
DWFString _zCreationTime
DWFString _zModificationTime
teOrientation _eOrientation
DWFCoordinateSystem::tList _oCSs


Member Typedef Documentation

typedef enum DWFToolkit::DWFGraphicResource::teOrientation DWFToolkit::DWFGraphicResource::teOrientation
 

Indicates how the graphics should track with the paper's landscape/portrait orientation.


Member Enumeration Documentation

enum DWFToolkit::DWFGraphicResource::teOrientation
 

Indicates how the graphics should track with the paper's landscape/portrait orientation.

Definition at line 71 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 void DWFToolkit::DWFGraphicResource::addCoordinateSystem DWFCoordinateSystem pCS  )  throw () [inline]
 

Adds a coordinate system to be used with this graphic resource

Parameters:
pCS The coordinate system to be added to this graphic resource (must not be NULL). This pointer is now owned by the this resource and will be released with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 

Definition at line 322 of file GraphicResource.h.

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

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

Returns:
The author.
Exceptions:
None 

Definition at line 219 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 169 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:
SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

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

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

Returns:
The creation time.
Exceptions:
None 

Definition at line 269 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 244 of file GraphicResource.h.

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

???

Definition at line 206 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 182 of file GraphicResource.h.

virtual _DWFTK_API DWFCoordinateSystem::tList::Iterator* DWFToolkit::DWFGraphicResource::getCoordinateSystems  )  throw () [inline, virtual]
 

Locates all coordinate systems in this graphic resource

Returns:
A pointer to an iterator for enumerating the coordinate systems (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Coordinate systems returned from the iterator are owned by the graphic resource and must not be deleted by the caller.
Exceptions:
None 

Definition at line 339 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 294 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 373 of file GraphicResource.h.

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

virtual _DWFTK_API void DWFToolkit::DWFGraphicResource::removeCoordinateSystem DWFCoordinateSystem pCS,
bool  bDelete
throw ( DWFException ) [inline, virtual]
 

Clears the coordinate system from the graphic resource.

Parameters:
pCS The coordinate system object to remove from this container.
bDelete If true the coordinate system object will be deleted; otherwise, the object must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Definition at line 354 of file GraphicResource.h.

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

_DWFTK_API void DWFToolkit::DWFGraphicResource::setAuthor const DWFString zAuthor  )  throw () [inline]
 

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

Exceptions:
None 

Definition at line 231 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFGraphicResource::setCreationTime const DWFString zCreationTime  )  throw () [inline]
 

Sets the optional field indicating the origin time of the graphics data.

Exceptions:
None 

Definition at line 281 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFGraphicResource::setDescription const DWFString zDescription  )  throw () [inline]
 

Sets the optional field indicating detailed information about the graphics.

Exceptions:
None 

Definition at line 256 of file GraphicResource.h.

_DWFTK_API void DWFToolkit::DWFGraphicResource::setModificationTime const DWFString zModificationTime  )  throw () [inline]
 

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

Exceptions:
None 

Definition at line 306 of file GraphicResource.h.

_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 143 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 196 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 156 of file GraphicResource.h.


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