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

DWFToolkit::DWFPackagePublisher Class Reference
[DWF Publisher API]

#include "dwf/publisher/impl/DWFPackagePublisher.h"

Inheritance diagram for DWFToolkit::DWFPackagePublisher:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

An publisher implementation for producing DWF package files.
Since:
7.0.1.

This is a reference implementation of the DWFPublisher base class for creating DWF packages. This implementation was developed as part of the 3D Publishing API and, as such, produces only 3D DWF 6.01 packages.

Due to the composite nature of the the visitors, even this class can be used to extract additional data to other output pipes during the creation of the DWF package.

Todo:
Implement a full version for composite DWF packages.
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 63 of file DWFPackagePublisher.h.

Public Member Functions

_DWFTK_API DWFPackagePublisher (const DWFFile &rDWFFile, const DWFString &zPassword=L"", const DWFString &zSourceProductVendor=L"", const DWFString &zSourceProductName=L"", const DWFString &zSourceProductVersion=L"", const DWFString &zPublisherProductVendor=L"", const DWFString &zPublisherProductVersion=L"") throw ()
virtual _DWFTK_API ~DWFPackagePublisher () throw ()
_DWFTK_API void publish () throw ( DWFException )
_DWFTK_API DWFPublishedObject::VisitorgetPublishedObjectVisitor () throw ( DWFException )
_DWFTK_API DWFPropertyVisitorgetPropertyVisitor () throw ( DWFException )
_DWFTK_API DWFEmbeddedFontVisitorgetEmbeddedFontVisitor () throw ( DWFException )
_DWFTK_API void visitPublishedObject (DWFPublishedObject &rObject) throw ( DWFException )
_DWFTK_API void visitProperty (DWFProperty &rProperty) throw ( DWFException )
_DWFTK_API void visitPropertyContainer (DWFPropertyContainer &rPropertyContainer) throw ( DWFException )
_DWFTK_API void visitEmbeddedFont (const DWFEmbeddedFont &rFont) throw ( DWFException )
_DWFTK_API void preprocess (DWFPublishable *pPublishable) throw ( DWFException )
_DWFTK_API void postprocess (DWFPublishable *pPublishable) throw ( DWFException )

Static Public Attributes

static const wchar_t *const kz_NamedView_Default
 The name of the default model view (see DWFModel::createView).
static const wchar_t *const kz_PropName_PolygonHandedness
 The name of the DWFProperty that captures the handedness heuristic (see DWFModel::getPolygonHandedness).
static const wchar_t *const kz_PropName_UseDefaultLighting
 The name of the DWFProperty that captures the lighting preference (see DWFModel::useModelLighting).
static const wchar_t *const kz_PropName_UseSilhouetteEdges
 The name of the DWFProperty that captures the feature edge preference (see DWFModel::useSilhouetteEdges).
static const wchar_t *const kz_PropName_EdgeColor
 The name of the DWFProperty that captures the edge color preference (see DWFModel::getEdgeColor).
static const wchar_t *const kz_PropSetName_DefaultView
 The name of the DWFPropertyContainer that bundles the default (initial) model view.
static const wchar_t *const kz_PropName_CameraProjection
 The name of the DWFProperty that decribes the default camera projection.
static const wchar_t *const kz_PropName_CameraPosition
 The name of the DWFProperty that decribes the default camera position.
static const wchar_t *const kz_PropName_CameraTarget
 The name of the DWFProperty that decribes the default camera target.
static const wchar_t *const kz_PropName_CameraUpVector
 The name of the DWFProperty that decribes the default camera up vector.
static const wchar_t *const kz_PropName_CameraField
 The name of the DWFProperty that decribes the default camera field.
static const wchar_t *const kz_PropName_Published_Object
 The name of the DWFProperty that identifies an object.
static const wchar_t *const kz_PropCategory_Hidden
 The DWFProperty category that marks it as hidden.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPackagePublisher::DWFPackagePublisher const DWFFile rDWFFile,
const DWFString zPassword = L"",
const DWFString zSourceProductVendor = L"",
const DWFString zSourceProductName = L"",
const DWFString zSourceProductVersion = L"",
const DWFString zPublisherProductVendor = L"",
const DWFString zPublisherProductVersion = L""
throw ()
 

Constructor

This documentation has been copied from DWFPackageWriter::write():

This method exposes the standard DWF package properties directly. It is highly recommended that at DWF publishers set these correctly with as much detail as possible.

Setting standard DWF package properties:

                Autodesk DWF Writer is a printer driver DLL that is used to generate DWF packages
                through the Windows printing system, it is a component that another application
                would use (indirectly) to publish the DWF.  The following is an example of how
                it might populate these properties when printing from Microsoft Word:
       
                zSourceProductVendor    = L"Microsoft Corporation"          <--- from Word 2003
                zSourceProductName      = L"Microsoft Office 2003"          <--- from Word 2003
                zSourceProductVersion   = L"11.0.5604"                      <--- from Word 2003
                zDWFProductVendor       = L"Autodesk, Inc."                 <--- from DWF Writer 2
                zDWFProductVersion      = L"2.0.4.0"                        <--- from DWF Writer 2

Parameters:
rDWFFile The destination DWF package file name.
zPassword An optional password to protect the DWF package.
zSourceProductVendor A standard property detailing the vendor of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zSourceProductName A standard property detailing the name of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zSourceProductVersion A standard property detailing the version of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zPublisherProductVendor A standard property that details the vendor of the software component that was used by the source product to publish the DWF package.
zPublisherProductVersion A standard property that details the version of the software component that was used by the source product to publish the DWF package.
Exceptions:
DWFException 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFEmbeddedFontVisitor* DWFToolkit::DWFPackagePublisher::getEmbeddedFontVisitor  )  throw ( DWFException ) [inline, virtual]
 

Returns a visitor that can process a font.

Returns:
A font visitor. This pointer must not be deleted by the caller.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

Definition at line 222 of file DWFPackagePublisher.h.

_DWFTK_API DWFPropertyVisitor* DWFToolkit::DWFPackagePublisher::getPropertyVisitor  )  throw ( DWFException ) [inline, virtual]
 

Returns a visitor that can process a property and/or property container.

Returns:
A property visitor. This pointer must not be deleted by the caller.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

Definition at line 212 of file DWFPackagePublisher.h.

_DWFTK_API DWFPublishedObject::Visitor* DWFToolkit::DWFPackagePublisher::getPublishedObjectVisitor  )  throw ( DWFException ) [inline, virtual]
 

Returns a visitor that can process published objects in order to retrieve or characterize their structure.

Returns:
A published object visitor. This pointer must not be deleted by the caller.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

Definition at line 202 of file DWFPackagePublisher.h.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::postprocess DWFPublishable pPublishable  )  throw ( DWFException ) [virtual]
 

This callback should be invoked by pPublishable when it has completed it's publish() processing passing itself back as the parameter.

Parameters:
pPublishable The object being published.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::preprocess DWFPublishable pPublishable  )  throw ( DWFException ) [virtual]
 

This callback should be invoked by pPublishable as soon as it starts it's publish() processing passing itself back as the parameter.

Parameters:
pPublishable The object being published.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::publish  )  throw ( DWFException ) [virtual]
 

Compose all of the publishable section content and graphics data provided to this object and publish a DWF package file.

Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPublisher.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::visitEmbeddedFont const DWFEmbeddedFont rFont  )  throw ( DWFException ) [virtual]
 

Default visitation implementation. Specializations should invoke this base method to ensure any composed visitors are called.

Parameters:
rFont An embedded font from the publishable source.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFEmbeddedFontVisitor.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::visitProperty DWFProperty rProperty  )  throw ( DWFException ) [virtual]
 

Default visitation implementation. Specializations should invoke this base method to ensure any composed visitors are called.

Parameters:
rProperty A property from the publishable source.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyVisitor.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::visitPropertyContainer DWFPropertyContainer rPropertyContainer  )  throw ( DWFException ) [virtual]
 

Default visitation implementation. Specializations should invoke this base method to ensure any composed visitors are called.

Parameters:
rPropertyContainer The property container from the publishable source.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyVisitor.

_DWFTK_API void DWFToolkit::DWFPackagePublisher::visitPublishedObject DWFPublishedObject rObject  )  throw ( DWFException ) [virtual]
 

Default visitation implementation. Specializations should invoke this base method to ensure any composed visitors are called.

Parameters:
rObject An object from the publishable source.
Exceptions:
DWFException _DWFTK_API

Reimplemented from DWFToolkit::DWFPublishedObject::Visitor.


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