DWFToolkit::DWFModelSceneChangeHandler Class Reference

#include "dwf/presentation/ModelScene.h"

Inheritance diagram for DWFToolkit::DWFModelSceneChangeHandler:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Since:
7.2

Definition at line 67 of file ModelScene.h.

Public Types

enum  teChangeType { eSceneLevel, eInstanceLevel }
 Enumeration values that define the various attributes that can be changed on a model scene. More...

Public Member Functions

virtual _DWFTK_API ~DWFModelSceneChangeHandler () throw ()
virtual DWFModelSceneChangeHandlerclone () const =0 throw ()
virtual teChangeType changeType () const =0 throw ()
virtual _DWFTK_API void addUserAttribute (const DWFString &zName, const DWFString &zValue, const DWFString &zNamespace) throw ( DWFException )
virtual UserAttribute::tList::IteratorgetUserAttributes () throw ()
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Public Attributes

UserAttribute::tList _oUserAttributes

Classes

class  UserAttribute
 This class holds user attributes that can be specified with any model scene change handler. More...


Member Enumeration Documentation

enum DWFToolkit::DWFModelSceneChangeHandler::teChangeType
 

Enumeration values that define the various attributes that can be changed on a model scene.

Enumerator:
eSceneLevel  Change that applies to the entire scene
eInstanceLevel  Change that applies to all instances

Definition at line 150 of file ModelScene.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFModelSceneChangeHandler::addUserAttribute const DWFString zName,
const DWFString zValue,
const DWFString zNamespace
throw ( DWFException ) [virtual]
 

Adds a user attribute for this change

User attributes can be added to any change handler. All user attributes must be contained in a user specified namespace.

Parameters:
zName The name of the attribute.
zValue The value of the attribute.
zNamespace The namespace to add to the attribute.
Exceptions:
DWFException 

virtual teChangeType DWFToolkit::DWFModelSceneChangeHandler::changeType  )  const throw () [pure virtual]
 

The change type.

Returns:
The type indicating whether this is a scene level of instance level change.
Exceptions:
none 

Implemented in DWFToolkit::DWFModelScene::_W3DInstance, DWFToolkit::DWFModelScene::_W3DInstanceOptions, DWFToolkit::DWFModelScene::_W3DAttributeLock, DWFToolkit::DWFModelScene::_W3DCamera, DWFToolkit::DWFModelScene::_W3DColor, DWFToolkit::DWFModelScene::_W3DCuttingPlanes, DWFToolkit::DWFModelScene::_W3DTransform, DWFToolkit::DWFModelScene::_W3DVisibility, and DWFToolkit::DWFModelScene::_W3DDisplayMode.

virtual DWFModelSceneChangeHandler* DWFToolkit::DWFModelSceneChangeHandler::clone  )  const throw () [pure virtual]
 

clone

Returns:
A type specific clone
Exceptions:
none 

Implemented in DWFToolkit::DWFModelScene::_W3DInstance, DWFToolkit::DWFModelScene::_W3DInstanceOptions, DWFToolkit::DWFModelScene::_W3DAttributeLock, DWFToolkit::DWFModelScene::_W3DCamera, DWFToolkit::DWFModelScene::_W3DColor, DWFToolkit::DWFModelScene::_W3DCuttingPlanes, DWFToolkit::DWFModelScene::_W3DTransform, DWFToolkit::DWFModelScene::_W3DVisibility, and DWFToolkit::DWFModelScene::_W3DDisplayMode.

virtual UserAttribute::tList::Iterator* DWFToolkit::DWFModelSceneChangeHandler::getUserAttributes  )  throw () [inline, virtual]
 

Gets all user attributes associates with this change handler.

Returns:
A pointer to an iterator for enumerating the user attributes (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. User attributes returned from the iterator are owned by the change handler and must not be deleted by the caller.
Exceptions:
none 

Definition at line 218 of file ModelScene.h.

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

Implements DWFCore::DWFXMLSerializableBase.

Reimplemented in DWFToolkit::DWFModelScene::_W3DInstance, DWFToolkit::DWFModelScene::_W3DInstanceOptions, DWFToolkit::DWFModelScene::_W3DAttributeLock, DWFToolkit::DWFModelScene::_W3DCamera, DWFToolkit::DWFModelScene::_W3DColor, DWFToolkit::DWFModelScene::_W3DCuttingPlanes, DWFToolkit::DWFModelScene::_W3DTransform, DWFToolkit::DWFModelScene::_W3DVisibility, and DWFToolkit::DWFModelScene::_W3DDisplayMode.


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