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

DWFToolkit::DWFIncludeSegment Class Reference
[3D Publisher API]

#include "dwf/publisher/model/IncludeSegment.h"

Inheritance diagram for DWFToolkit::DWFIncludeSegment:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A segment class for defining visual elements that can be referenced throughout the scene.
Since:
7.0.1.

An include segment is simply a "regular" segment that is defined in the include library rather than the scene graph. These segments are exactly like the scene segments except that they are not part of the scene directly. Rather they must be referenced, or included, in the scene via the DWFSegment::include() methods.

This class, as part of the 3D Publisher API also may contribute to the metadata of the DWF. Currently all include segments must be named; and this name is not arbitrary. The include segment name may be used as the object node in the DWF object structure. When a segment is included in another segment that is named (that is, a segment that itself is an object node), the included segment contributes its graphics to the scene but only the properties of the included object are applied to the referencing node. When a segment is included in another segment that is unnamed, the included segment creates a node in the object hierarchy.

Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 58 of file IncludeSegment.h.

Public Member Functions

_DWFTK_API DWFIncludeSegment (DWFSegmentHandlerBuilder &rSegmentBuilder, DWFGeometryHandlerBuilder &rGeometryBuilder, DWFFeatureHandlerBuilder &rFeatureBuilder, DWFAttributeHandlerBuilder &rAttributeBuilder, DWFPublishedObject::Factory &rObjectFactory) throw ()
_DWFTK_API DWFIncludeSegment (const DWFIncludeSegment &rSegment) throw ()
_DWFTK_API DWFIncludeSegmentoperator= (const DWFIncludeSegment &rSegment) throw ()
virtual _DWFTK_API ~DWFIncludeSegment () throw ()
_DWFTK_API void open (const DWFString *pName) throw ( DWFException )
_DWFTK_API void open (const DWFString &zName) throw ( DWFException )

Static Public Attributes

static const char *const kz_Include_Library
 The local include library for the scene graph.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFIncludeSegment::DWFIncludeSegment DWFSegmentHandlerBuilder rSegmentBuilder,
DWFGeometryHandlerBuilder rGeometryBuilder,
DWFFeatureHandlerBuilder rFeatureBuilder,
DWFAttributeHandlerBuilder rAttributeBuilder,
DWFPublishedObject::Factory rObjectFactory
throw ()
 

Constructor

Parameters:
rSegmentBuilder An interface for acquiring the segment-specific op-code handlers.
rGeometryBuilder An interface for acquiring the geometry-specific op-code handlers.
rFeatureBuilder An interface for acquiring the feature-specific op-code handlers.
rAttributeBuilder An interface for acquiring the attribute-specific op-code handlers.
rObjectFactory An interface for building published objects.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFIncludeSegment::DWFIncludeSegment const DWFIncludeSegment rSegment  )  throw ()
 

Copy Constructor

Parameters:
rSegment The segment to clone.
Exceptions:
DWFException 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFIncludeSegment::open const DWFString zName  )  throw ( DWFException )
 

Opens the segment for use.

The usage model for segments is:

  1. Create or obtain a segment object.
  2. Open the segment.
  3. Add geometry, attributes, sub-segments, etc.
  4. Close the segment.
  5. Repeat. (The same segment object can be reused.)

Parameters:
zName An optional name for the segment. If a segment is named it will be marked as a node and captured in the package metadata as a defined object and/or instance.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFIncludeSegment::open const DWFString pName  )  throw ( DWFException )
 

Opens the segment for use.

The usage model for segments is:

  1. Create or obtain a segment object.
  2. Open the segment.
  3. Add geometry, attributes, sub-segments, etc.
  4. Close the segment.
  5. Repeat. (The same segment object can be reused.)

Parameters:
pName An optional name for the segment. If a segment is named it will be marked as a node and captured in the package metadata as a defined object and/or instance.
Exceptions:
DWFException 
Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API DWFIncludeSegment& DWFToolkit::DWFIncludeSegment::operator= const DWFIncludeSegment rSegment  )  throw ()
 

Assignment Operator

Parameters:
rSegment The segment to clone.
Exceptions:
DWFException 


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