DWFToolkit::DWFPublishedContentElement::Visitor Class Reference
[DWF Publisher API]

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

Collaboration diagram for DWFToolkit::DWFPublishedContentElement::Visitor:

Collaboration graph
[legend]
List of all members.

Detailed Description

An implementation of the published object visitor to support content element generation.

Since:
7.2.0
This is an implementation of the DWFPublisheObject::Visitor base class for creating DWF content from the DWFPublishedObjects created by the 3D Publishing API.

Definition at line 258 of file PublishedContentElement.h.

Public Member Functions

_DWFTK_API Visitor () throw ( DWFException )
virtual _DWFTK_API ~Visitor () throw ()
_DWFTK_API void setContent (DWFContent *pContent) throw ()
_DWFTK_API DWFContentgetContent () const throw ()
_DWFTK_API void setContentResource (DWFSectionContentResource *pResource) throw ()
_DWFTK_API DWFSectionContentResourcegetContentResource () const throw ()
_DWFTK_API void visitPublishedObject (DWFPublishedObject &rObject) throw ( DWFException )
_DWFTK_API void setNotificationSink (DWFPublishedContentElement::NotificationSink *pSink) throw ()
_DWFTK_API void removeNotificationSink (DWFPublishedContentElement::NotificationSink *pSink) throw ()
_DWFTK_API DWFSortedVector<
DWFInstance * > & 
instancesExcludedFromModel () throw ()
_DWFTK_API void reset () throw ()


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPublishedContentElement::Visitor::Visitor  )  throw ( DWFException )
 

Constructor

Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFPublishedContentElement::Visitor::~Visitor  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 278 of file PublishedContentElement.h.


Member Function Documentation

_DWFTK_API DWFContent* DWFToolkit::DWFPublishedContentElement::Visitor::getContent  )  const throw () [inline]
 

Get the content library that creates, stores and manages the content elements.

Returns:
Pointer to the content library.
Exceptions:
None 

Definition at line 304 of file PublishedContentElement.h.

_DWFTK_API DWFSectionContentResource* DWFToolkit::DWFPublishedContentElement::Visitor::getContentResource  )  const throw () [inline]
 

Get the resource used to generate the instances.

Returns:
Pointer to the content resource used to generate instances.
Exceptions:
None 

Definition at line 329 of file PublishedContentElement.h.

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::removeNotificationSink DWFPublishedContentElement::NotificationSink *  pSink  )  throw ()
 

Remove a specific notification sink.

Parameters:
pSink The sink to remove.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::reset  )  throw ()
 

Clear out the map and sinks. This should be called before reusing the visitor for a new model.

Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::setContent DWFContent pContent  )  throw () [inline]
 

Set the content library that creates, stores and manages the content elements.

Parameters:
pContent Pointer to the content library.
Exceptions:
None 

Definition at line 290 of file PublishedContentElement.h.

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::setContentResource DWFSectionContentResource pResource  )  throw ()
 

This sets the resource the is associated with the instances that the visitor generates. The visitor does not own the resource and hence will not delete it.

Parameters:
pResource The resource.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::setNotificationSink DWFPublishedContentElement::NotificationSink *  pSink  )  throw ()
 

To get notifications when an DWFInstance, DWFObject or DWFEntity is created during the visitation, use this method to set a notification sink. This will not take ownership of the sink - only use it.

Parameters:
pSink A DWFPublishedContentElement derived class
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedContentElement::Visitor::visitPublishedObject DWFPublishedObject rObject  )  throw ( DWFException )
 


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