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

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

Collaboration diagram for DWFToolkit::DWFStyleSegment:

Collaboration graph
[legend]
List of all members.

Detailed Description

Represents a special segment that contains one or more attributes that can be applied as a whole, to other scene segments.

Since:
7.0.1

Definition at line 50 of file StyleSegment.h.

Public Member Functions

_DWFTK_API DWFStyleSegment (DWFSegmentHandlerBuilder &rSegmentBuilder, DWFAttributeHandlerBuilder &rAttributeBuilder, unsigned int nID) throw ()
_DWFTK_API DWFStyleSegment (const DWFStyleSegment &) throw ()
_DWFTK_API DWFStyleSegmentoperator= (const DWFStyleSegment &) throw ()
virtual _DWFTK_API ~DWFStyleSegment () throw ()
_DWFTK_API void open () throw ( DWFException )
_DWFTK_API void close () throw ( DWFException )
_DWFTK_API const DWFStringname () const throw ()
_DWFTK_API TK_Camera & getCameraHandler () throw ( DWFException )
_DWFTK_API TK_Color & getColorHandler () throw ( DWFException )
_DWFTK_API TK_Color_Map & getColorMapHandler () throw ( DWFException )
_DWFTK_API TK_Color_RGB & getColorRGBHandler () throw ( DWFException )
_DWFTK_API TK_Named & getEdgePatternHandler () throw ( DWFException )
_DWFTK_API TK_Size & getEdgeWeightHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getFacePatternHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getHandednessHandler () throw ( DWFException )
_DWFTK_API TK_Heuristics & getHeuristicsHandler () throw ( DWFException )
_DWFTK_API TK_Named & getLinePatternHandler () throw ( DWFException )
_DWFTK_API TK_Line_Style & getLineStyleHandler () throw ( DWFException )
_DWFTK_API TK_Size & getLineWeightHandler () throw ( DWFException )
_DWFTK_API TK_Size & getMarkerSizeHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getMarkerSymbolHandler () throw ( DWFException )
_DWFTK_API TK_Matrix & getModellingMatrixHandler () throw ( DWFException )
_DWFTK_API TK_Rendering_Options & getRenderingOptionsHandler () throw ( DWFException )
_DWFTK_API TK_Selectability & getSelectabilityHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getTextAlignmentHandler () throw ( DWFException )
_DWFTK_API TK_Text_Font & getTextFontHandler () throw ( DWFException )
_DWFTK_API TK_Point & getTextPathHandler () throw ( DWFException )
_DWFTK_API TK_Size & getTextSpacingHandler () throw ( DWFException )
_DWFTK_API TK_User_Options & getUserOptionsHandler () throw ( DWFException )
_DWFTK_API TK_Unicode_Options & getUnicodeOptionsHandler () throw ( DWFException )
_DWFTK_API TK_Visibility & getVisibilityHandler () throw ( DWFException )
_DWFTK_API TK_Window & getWindowHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getWindowFrameHandler () throw ( DWFException )
_DWFTK_API TK_Enumerated & getWindowPatternHandler () throw ( DWFException )

Static Public Attributes

static const char *const kz_Style_Library
 The local style library for the scene graph.
static const char *const kz_StyleSegment_PublishedEdges
 The name of the predefined segment for stylizing feature edge segments.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFStyleSegment::DWFStyleSegment DWFSegmentHandlerBuilder rSegmentBuilder,
DWFAttributeHandlerBuilder rAttributeBuilder,
unsigned int  nID
throw ()
 

Constructor

Parameters:
rSegmentBuilder An interface for acquiring the segment-specific op-code handlers.
rAttributeBuilder An interface for acquiring the attribute-specific op-code handlers.
nID A unique identifier for the segment. Style segments are not explicitly named.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFStyleSegment::DWFStyleSegment const DWFStyleSegment  )  throw ()
 

Copy Constructor

Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFStyleSegment::close  )  throw ( DWFException )
 

Closes the segment completely and serializes any remaining data and op-codes into the W3D stream.

This segment object will be completely cleaned out and is available for reuse after this method returns.

Exceptions:
DWFException 

_DWFTK_API TK_Camera& DWFToolkit::DWFStyleSegment::getCameraHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Color& DWFToolkit::DWFStyleSegment::getColorHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Color_Map& DWFToolkit::DWFStyleSegment::getColorMapHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Color_RGB& DWFToolkit::DWFStyleSegment::getColorRGBHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Named& DWFToolkit::DWFStyleSegment::getEdgePatternHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Size& DWFToolkit::DWFStyleSegment::getEdgeWeightHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getFacePatternHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getHandednessHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Heuristics& DWFToolkit::DWFStyleSegment::getHeuristicsHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Named& DWFToolkit::DWFStyleSegment::getLinePatternHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Line_Style& DWFToolkit::DWFStyleSegment::getLineStyleHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Size& DWFToolkit::DWFStyleSegment::getLineWeightHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Size& DWFToolkit::DWFStyleSegment::getMarkerSizeHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getMarkerSymbolHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Matrix& DWFToolkit::DWFStyleSegment::getModellingMatrixHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Rendering_Options& DWFToolkit::DWFStyleSegment::getRenderingOptionsHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Selectability& DWFToolkit::DWFStyleSegment::getSelectabilityHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getTextAlignmentHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Text_Font& DWFToolkit::DWFStyleSegment::getTextFontHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Point& DWFToolkit::DWFStyleSegment::getTextPathHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Size& DWFToolkit::DWFStyleSegment::getTextSpacingHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Unicode_Options& DWFToolkit::DWFStyleSegment::getUnicodeOptionsHandler  )  throw ( DWFException )
 

_DWFTK_API TK_User_Options& DWFToolkit::DWFStyleSegment::getUserOptionsHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Visibility& DWFToolkit::DWFStyleSegment::getVisibilityHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getWindowFrameHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Window& DWFToolkit::DWFStyleSegment::getWindowHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Enumerated& DWFToolkit::DWFStyleSegment::getWindowPatternHandler  )  throw ( DWFException )
 

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

Returns the internal segment name.

This name is actually the path to the segment in the include library.

Returns:
The internal segment name.
Exceptions:
None 

Definition at line 139 of file StyleSegment.h.

_DWFTK_API void DWFToolkit::DWFStyleSegment::open  )  throw ( DWFException )
 

Opens the segment for use.

The usage model for segments is:

  1. Create or obtain a style segment object.
  2. Open the segment.
  3. Add attributes.
  4. Close the segment.
  5. Repeat. (The same segment object can be reused.)

Exceptions:
DWFException 

_DWFTK_API DWFStyleSegment& DWFToolkit::DWFStyleSegment::operator= const DWFStyleSegment  )  throw ()
 

Assignment Operator

Exceptions:
None 


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