DWFToolkit::DWFPublishedObject Class Reference
[DWF Publisher API]

#include "dwf/publisher/PublishedObject.h"

Collaboration diagram for DWFToolkit::DWFPublishedObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to capture the relationship between a graphics element/node and some publishable structure and metadata.

Since:
7.0.1

Definition at line 68 of file PublishedObject.h.

Public Types

typedef long tKey
 Defines the data type used for object keys.
typedef int tIndex
 Defines the data type used for object indices.
typedef DWFToolkit::DWFPublishedObject::tReference tReference
 Data structure used for capturing cross-object references.
typedef DWFSkipList< tKey,
DWFPublishedObject * > 
tMap
 This type defines a mapped collection of DWFPublishedObject pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (tReference *) tReferenceList
 This type defines a list of tReference pointers.
typedef _DWFTK_STD_VECTOR (DWFPublishedObject *) tList
 This type defines a list of DWFPublishedObject pointers.
_DWFTK_API DWFPublishedObject (tKey nKey, const DWFString &zName) throw ()
_DWFTK_API DWFPublishedObject (DWFPublishedObject &rSource) throw ()
_DWFTK_API DWFPublishedObjectoperator= (DWFPublishedObject &rSource) throw ()
virtual _DWFTK_API ~DWFPublishedObject () throw ()
_DWFTK_API const DWFStringname () const throw ()
_DWFTK_API void path (DWFString &zPath) throw ()
_DWFTK_API tKey key () const throw ()
_DWFTK_API unsigned int instance () const throw ()
_DWFTK_API void setInstance (unsigned int nIID) throw ()
_DWFTK_API tIndex index () const throw ()
_DWFTK_API void setIndex (tIndex nIndex) throw ()
_DWFTK_API DWFPublishedObjectparent () const throw ()
_DWFTK_API void setParent (DWFPublishedObject *pParentObject) throw ()
_DWFTK_API void referenced () throw ()
_DWFTK_API bool isReferenced () const throw ()
virtual _DWFTK_API void addReference (DWFPublishedObject *pObject, DWFPublishedObject::tKey nKey, const DWFString *pzInstanceName=NULL, bool bPropertiesOnly=false) throw ( DWFException )
_DWFTK_API tReferenceList & references () throw ( DWFException )
virtual _DWFTK_API void accept (DWFPublishedObject::Visitor &rVisitor) throw ( DWFException )
virtual _DWFTK_API void accept (DWFPropertyVisitor &rVisitor) throw ( DWFException )
virtual _DWFTK_API bool setHideFromDefaultModel (DWFPublishedObject::tKey) throw ()
_DWFTK_API void setContentEntity (DWFEntity *, tKey, const DWFString *) throw ( DWFException )
virtual _DWFTK_API void setContentObject (DWFObject *, tKey) throw ( DWFException )
virtual _DWFTK_API DWFObjectgetContentObject () throw ()

Protected Attributes

bool _bRef
tKey _nKey
unsigned int _nIID
unsigned int _nIndex
DWFPublishedObject_pParent
tReferenceList _oReferenceList

Classes

class  _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE
class  _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE
struct  tReference
 Data structure used for capturing cross-object references. More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPublishedObject::DWFPublishedObject tKey  nKey,
const DWFString zName
throw ()
 

Constructor

Parameters:
nKey Unique identifier for the object.
zName Descriptive name for the object.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPublishedObject::DWFPublishedObject DWFPublishedObject rSource  )  throw ()
 

Copy Constructor

Parameters:
rSource The object to copy.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFPublishedObject::accept DWFPropertyVisitor rVisitor  )  throw ( DWFException ) [virtual]
 

Receives a property visitor and provides itself to its interface.

Parameters:
rVisitor The property visitor.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPublishedObject::accept DWFPublishedObject::Visitor &  rVisitor  )  throw ( DWFException ) [virtual]
 

Receives an object visitor and provides itself to its interface.

Parameters:
rVisitor The published object visitor.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPublishedObject::addReference DWFPublishedObject pObject,
DWFPublishedObject::tKey  nKey,
const DWFString pzInstanceName = NULL,
bool  bPropertiesOnly = false
throw ( DWFException ) [virtual]
 

Creates a reference to an existing object.

Parameters:
pObject The object to reference.
nKey The unique identifier of the object from which the association is being made.
pzInstanceName An optional name for the reference relationship.
bPropertiesOnly The reference is non-structural; only copy the properties to the referencing (this) object.
Exceptions:
DWFException 

virtual _DWFTK_API DWFObject* DWFToolkit::DWFPublishedObject::getContentObject  )  throw () [inline, virtual]
 

Get any content object associated through the published object. Implement in derived classes that supported content objects

See also:
DWFPublishedContentElement::getContentObject()
Returns:
A pointer to the DWFObject if it has been set. If a entity has been set this will return NULL.
Exceptions:
DWFException 
Since:
7.2.0

Definition at line 576 of file PublishedObject.h.

_DWFTK_API bool DWFToolkit::DWFPublishedObject::isReferenced  )  const throw () [inline]
 

Returns a flag indicating whether or not this is a reference object.

Returns:
A flag indicating whether or not this is a reference object.
Exceptions:
None 

Definition at line 452 of file PublishedObject.h.

_DWFTK_API tKey DWFToolkit::DWFPublishedObject::key  )  const throw () [inline]
 

Returns the object's unique key.

The key is used to bind the object to a data structure that itself defines the graphic element or entry point to it. This data structure then provides the index of (the association to) the actual graphics.

Returns:
The unique object identifier.
Exceptions:
None 

Definition at line 345 of file PublishedObject.h.

_DWFTK_API const DWFString& DWFToolkit::DWFPublishedObject::name  )  const throw () [inline]
 

Returns the object's name

Objects may exist in a hierachy and the full path of one branch may be expressed as a concatenation of object names. Names are not necessarily unique among all objects in the same set.

Returns:
The descriptive name.
Exceptions:
None 

Definition at line 314 of file PublishedObject.h.

_DWFTK_API DWFPublishedObject& DWFToolkit::DWFPublishedObject::operator= DWFPublishedObject rSource  )  throw ()
 

Assignment Operator

Parameters:
rSource The object to copy.
Exceptions:
None 

_DWFTK_API DWFPublishedObject* DWFToolkit::DWFPublishedObject::parent  )  const throw () [inline]
 

Returns the object's parent (if applicable.)

Returns:
A pointer to the parent. This pointer must not be deleted by the caller.
Exceptions:
None 

Definition at line 401 of file PublishedObject.h.

_DWFTK_API void DWFToolkit::DWFPublishedObject::path DWFString zPath  )  throw ()
 

Returns the full path of the object expressed as a concatenation of hierachical object names (including its own) and some separation character.

Parameters:
zPath A string object to receive the path.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFPublishedObject::referenced  )  throw () [inline]
 

Indicates that this object is a reference object.

A reference object is one that indicates reuse of graphics in the scene and has additional considerations when visited for reporting its metadata [structure].

For example, in the 3D model (DWFModel), published objects refer to "interesting" segments in the scene graph that the publisher wishes to identify as navigable entities and defined object instances (DWFDefinedObjectInstance) from which to hang object properties (DWFProperty). The 3D API allows for graphics to be defined once and applied many times in the scene resulting in smaller files. These are DWFIncludeSegment classes.

Exceptions:
None 

Definition at line 439 of file PublishedObject.h.

_DWFTK_API tReferenceList& DWFToolkit::DWFPublishedObject::references  )  throw ( DWFException )
 

Returns the list of objects that this object makes reference to.

Returns:
A reference to the internal list of object references.
Exceptions:
DWFException 
Todo:
Don't return the internal collection. Use a DWFIterator instead.

_DWFTK_API void DWFToolkit::DWFPublishedObject::setContentEntity DWFEntity ,
tKey  ,
const DWFString
throw ( DWFException ) [inline]
 

Set a content entity to associate with the segment. Implement in derived classes that supported content entities

See also:
DWFPublishedContentElement::setContentEntity()
Parameters:
pEntity The content entity to associate.
nKey The unique identifier of the object from which the association is being made.
pzInstanceName An optional name for the generated content object. Maybe NULL
Exceptions:
DWFException 
Since:
7.2.0

Definition at line 541 of file PublishedObject.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishedObject::setContentObject DWFObject ,
tKey 
throw ( DWFException ) [inline, virtual]
 

Set an content object to associate with the segment. Implement in derived classes that supported content objects

See also:
DWFPublishedContentElement::setContentObject()
Parameters:
pObject The content object to associate.
nKey The unique identifier of the object from which the association is being made.
Exceptions:
DWFException 
Since:
7.2.0

Definition at line 559 of file PublishedObject.h.

virtual _DWFTK_API bool DWFToolkit::DWFPublishedObject::setHideFromDefaultModel DWFPublishedObject::tKey   )  throw () [inline, virtual]
 

Prevent the published object from publishing the object in the default model presentation. If the provided key is the same the key of this object, then this object is set to be hidden. If not, the references are searched to match the key value, and the flag is set on that reference.

Parameters:
nKey Key of the published object to hide from the model.
Returns:
False if the given key not found.
Exceptions:
None 
Since:
7.2.0

Definition at line 522 of file PublishedObject.h.

_DWFTK_API void DWFToolkit::DWFPublishedObject::setIndex tIndex  nIndex  )  throw () [inline]
 

Assigns an graphic index to the object.

Parameters:
nIndex An indentifier that associates this object with the graphic node or element.
Exceptions:
None 

Definition at line 388 of file PublishedObject.h.

_DWFTK_API void DWFToolkit::DWFPublishedObject::setParent DWFPublishedObject pParentObject  )  throw () [inline]
 

Assigns another as this object's parent.

Parameters:
pParentObject A pointer to another object. This pointer remains the responsibility of the caller to delete.
Exceptions:
None 

Definition at line 415 of file PublishedObject.h.


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