DWFToolkit::DWFPlot Class Reference
[2D Publisher API]

#include "dwf/publisher/plot/Plot.h"

Collaboration diagram for DWFToolkit::DWFPlot:

Collaboration graph
[legend]
List of all members.

Detailed Description

A publishable object that represents a single EPlot DWF section.

Since:
7.1.0
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 49 of file Plot.h.

Public Member Functions

_DWFTK_API DWFPlot (const DWFString &zPlotTitle="", const DWFString &zPlotSource="", const DWFString &zPlotSourceID="", const DWFString &zPlotSourceHRef="", const DWFString &zPlotLabel="") throw ()
_DWFTK_API ~DWFPlot () throw ()
_DWFTK_API void open (const DWFPaper &rPaper, const double *pTransform=NULL, const double *pExtents=NULL, const double *pClip=NULL) throw ( DWFException )
_DWFTK_API void close () throw ( DWFException )
_DWFTK_API void attach (DWFInputStream *pW2DStream, bool bOwnStream) throw ( DWFException )
_DWFTK_API void publish (DWFPublisher &rPublisher) throw ( DWFException )
_DWFTK_API DWFPapergetPaper () throw ()
_DWFTK_API void getTransform (double *pTransform) const throw ()
_DWFTK_API void getPlotExtents (tDoubleList &rExtents) const throw ()
_DWFTK_API void getPlotClip (tDoubleList &rClip) const throw ()
virtual _DWFTK_API double getVersion () const throw ()
_DWFTK_API const DWFStringgetMIMEType () throw ( DWFException )
_DWFTK_API DWFInputStreamgetInputStream () throw ( DWFException )
_DWFTK_API void embedFont (DWFEmbeddedFont *pFont) throw ( DWFException )
_DWFTK_API void addResource (DWFPublishableResource *pResource) throw ( DWFException )
_DWFTK_API DWFIterator< DWFPublishableResource * > * getResources () throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPlot::DWFPlot const DWFString zPlotTitle = "",
const DWFString zPlotSource = "",
const DWFString zPlotSourceID = "",
const DWFString zPlotSourceHRef = "",
const DWFString zPlotLabel = ""
throw ()
 

Constructor

Use this constructor to manage the graphics stream manually.

Parameters:
zPlotTitle Corresponds to the EPlot section title.
zPlotSource Describes the source (application, component, etc.) of the plot data.
zPlotSourceID Uniquely identifies the source (document, file, database, etc.) of the plot data.
zPlotSourceHRef A locator for more information about (or the actual location of) the original document.
zPlotLabel A label for the plot data.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPlot::~DWFPlot  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFPlot::addResource DWFPublishableResource pResource  )  throw ( DWFException )
 

Request that the resource be added to the section.

Use this method for adding thumbnails, previews, etc.

Parameters:
pResource The resource to add. This object will assume ownership of pResource and will delete it with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::attach DWFInputStream pW2DStream,
bool  bOwnStream
throw ( DWFException )
 

Binds a W2D data stream to the object

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::close  )  throw ( DWFException )
 

Completes the plot.

This method should be paired with open() to scope the model's usage.

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::embedFont DWFEmbeddedFont pFont  )  throw ( DWFException )
 

Request the provided font be embedded in the section.

Parameters:
pFont The font data object to embed. This object will assume ownership of pFont and will delete it with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

_DWFTK_API DWFInputStream* DWFToolkit::DWFPlot::getInputStream  )  throw ( DWFException )
 

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

Returns:
The data stream. The caller must release the stream with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

_DWFTK_API const DWFString& DWFToolkit::DWFPlot::getMIMEType  )  throw ( DWFException )
 

Returns the MIME type of the publishable data.

Returns:
The MIME type.
Exceptions:
DWFException 

_DWFTK_API DWFPaper* DWFToolkit::DWFPlot::getPaper  )  throw ()
 

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::getPlotClip tDoubleList &  rClip  )  const throw ()
 

Returns the plot clip

Returns:
TODO
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPlot::getPlotExtents tDoubleList &  rExtents  )  const throw ()
 

Returns the plot extents

Returns:
TODO
Exceptions:
None 

_DWFTK_API DWFIterator<DWFPublishableResource*>* DWFToolkit::DWFPlot::getResources  )  throw ( DWFException )
 

Returns the list of resources added to this section.

Returns:
A pointer to an iterator than will provide the resources. This pointer must be deleted by the caller with DWFCORE_FREE_OBJECT but the resource pointers themselves should not be.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::getTransform double *  pTransform  )  const throw ()
 

Returns the plot to paper transform.

Returns:
TODO
Exceptions:
None 

virtual _DWFTK_API double DWFToolkit::DWFPlot::getVersion  )  const throw () [inline, virtual]
 

Returns the version of this section type/descriptor.

Returns:
The version of this section type/descriptor.
Exceptions:
None 

Definition at line 193 of file Plot.h.

_DWFTK_API void DWFToolkit::DWFPlot::open const DWFPaper rPaper,
const double *  pTransform = NULL,
const double *  pExtents = NULL,
const double *  pClip = NULL
throw ( DWFException )
 

Prepares the plot for first use.

Parameters:
rPaper Defines the virtual paper onto which the 2D section graphics will be placed.
pTransform TODO
pExtents TODO
pClip TODO
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFPlot::publish DWFPublisher rPublisher  )  throw ( DWFException )
 

Use the publisher to extract the plot structure.

Parameters:
rPublisher The publisher.
Exceptions:
DWFException 


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