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

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

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

Inheritance diagram for DWFToolkit::DWFSegment:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Represents a unit in the scene to which geometry and/or attributes can be applied.
Since:
7.0.1.
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 64 of file Segment.h.

Public Types

typedef DWFPublishedObject::tKey tKey
 Defines the data type used for segment keys.

Public Member Functions

_DWFTK_API DWFSegment (DWFSegmentHandlerBuilder &rSegmentBuilder, DWFGeometryHandlerBuilder &rGeometryBuilder, DWFFeatureHandlerBuilder &rFeatureBuilder, DWFAttributeHandlerBuilder &rAttributeBuilder, DWFPublishedObject::Factory &rObjectFactory, DWFPublishedObject *pPublishedParent=NULL) throw ()
_DWFTK_API DWFSegment (const DWFSegment &rSegment) throw ( DWFException )
_DWFTK_API DWFSegmentoperator= (const DWFSegment &rSegment) throw ( DWFException )
virtual _DWFTK_API ~DWFSegment () throw ()
_DWFTK_API tKey key () const throw ()
virtual _DWFTK_API void open (const DWFString *pName=NULL, bool bPublishedEdges=false) throw ( DWFException )
virtual _DWFTK_API void open (const DWFString &zName, bool bPublishedEdges=false) throw ( DWFException )
_DWFTK_API void close () throw ( DWFException )
_DWFTK_API DWFSegment openSegment () throw ( DWFException )
_DWFTK_API void style (DWFStyleSegment &rSegment) throw ( DWFException )
virtual _DWFTK_API void include (DWFIncludeSegment &rSegment) throw ( DWFException )
_DWFTK_API void include (DWFIncludeSegment &rSegment, const DWFString &zInstanceName) throw ( DWFException )
virtual _DWFTK_API void include (tKey nSegmentKey) throw ( DWFException )
_DWFTK_API void include (tKey nSegmentKey, const DWFString &zInstanceName) throw ( DWFException )
virtual _DWFTK_API const DWFProperty
*const 
findProperty (const DWFString &zName, const DWFString &zCategory=L"") const throw ()
virtual _DWFTK_API DWFProperty::tMap::Iterator * getProperties (const DWFString &zCategory=L"") throw ()
virtual _DWFTK_API void addProperty (DWFProperty *pProperty, bool bOwnProperty=true) throw ( DWFException )
virtual _DWFTK_API void addProperty (const DWFProperty &rProperty) throw ( DWFException )
virtual _DWFTK_API void addPropertyContainer (DWFPropertyContainer *pContainer) throw ( DWFException )
virtual _DWFTK_API void referencePropertyContainer (const DWFPropertyContainer &rContainer) throw ( DWFException )
virtual _DWFTK_API void removeOwnedPropertyContainers (DWFPropertyContainer::tList &rContainerList, bool bMakeReferences=false) throw ( DWFException )
virtual _DWFTK_API void removeReferencedPropertyContainers (DWFPropertyContainer::tList &rContainerList) throw ( DWFException )
virtual _DWFTK_API void removeAllPropertyContainers (DWFPropertyContainer::tList &rContainerList) throw ( DWFException )
virtual _DWFTK_API void copyProperties (DWFPropertyContainer &rContainer, bool bRemoveOwnership=false, bool bMakeReferences=false) throw ( DWFException )
_DWFTK_API TK_Area_LightgetAreaLightHandler () throw ( DWFException )
_DWFTK_API TK_CirclegetCircleHandler () throw ( DWFException )
_DWFTK_API TK_CirclegetCircularArcHandler () throw ( DWFException )
_DWFTK_API TK_CirclegetCircularChordHandler () throw ( DWFException )
_DWFTK_API TK_CirclegetCircularWedgeHandler () throw ( DWFException )
_DWFTK_API TK_Cutting_PlanegetCuttingPlaneHandler () throw ( DWFException )
_DWFTK_API TK_PointgetDistantLightHandler () throw ( DWFException )
_DWFTK_API TK_EllipsegetEllipseHandler () throw ( DWFException )
_DWFTK_API TK_EllipsegetEllipticalArcHandler () throw ( DWFException )
_DWFTK_API TK_ImagegetImageHandler () throw ( DWFException )
_DWFTK_API TK_LinegetLineHandler () throw ( DWFException )
_DWFTK_API TK_PointgetLocalLightHandler () throw ( DWFException )
_DWFTK_API TK_NURBS_CurvegetNURBSCurveHandler () throw ( DWFException )
_DWFTK_API TK_NURBS_SurfacegetNURBSSurfaceHandler () throw ( DWFException )
_DWFTK_API TK_PolyCylindergetPolyCylinderHandler () throw ( DWFException )
_DWFTK_API TK_PolypointgetPolygonHandler () throw ( DWFException )
_DWFTK_API TK_PolypointgetPolylineHandler () throw ( DWFException )
_DWFTK_API TK_ShellgetShellHandler (bool bTriStripsOnly=false, bool bDisableOptimization=false) throw ( DWFException )
_DWFTK_API TK_Spot_LightgetSpotLightHandler () throw ( DWFException )
_DWFTK_API TK_TextgetTextHandler () throw ( DWFException )
_DWFTK_API TK_TextgetTextWithEncodingHandler () throw ( DWFException )
_DWFTK_API TK_TexturegetTextureHandler () throw ( DWFException )
_DWFTK_API TK_MatrixgetTextureMatrixHandler () throw ( DWFException )
_DWFTK_API TK_ColorgetColorHandler () throw ( DWFException )
_DWFTK_API TK_Color_MapgetColorMapHandler () throw ( DWFException )
_DWFTK_API TK_Color_RGBgetColorRGBHandler () throw ( DWFException )
_DWFTK_API TK_Linear_PatterngetEdgePatternHandler () throw ( DWFException )
_DWFTK_API TK_SizegetEdgeWeightHandler () throw ( DWFException )
_DWFTK_API TK_EnumeratedgetFacePatternHandler () throw ( DWFException )
_DWFTK_API TK_EnumeratedgetHandednessHandler () throw ( DWFException )
_DWFTK_API TK_HeuristicsgetHeuristicsHandler () throw ( DWFException )
_DWFTK_API TK_Linear_PatterngetLinePatternHandler () throw ( DWFException )
_DWFTK_API TK_SizegetLineWeightHandler () throw ( DWFException )
_DWFTK_API TK_SizegetMarkerSizeHandler () throw ( DWFException )
_DWFTK_API TK_EnumeratedgetMarkerSymbolHandler () throw ( DWFException )
_DWFTK_API TK_MatrixgetModellingMatrixHandler () throw ( DWFException )
_DWFTK_API TK_Rendering_OptionsgetRenderingOptionsHandler () throw ( DWFException )
_DWFTK_API TK_SelectabilitygetSelectabilityHandler () throw ( DWFException )
_DWFTK_API TK_EnumeratedgetTextAlignmentHandler () throw ( DWFException )
_DWFTK_API TK_Text_FontgetTextFontHandler () throw ( DWFException )
_DWFTK_API TK_PointgetTextPathHandler () throw ( DWFException )
_DWFTK_API TK_SizegetTextSpacingHandler () throw ( DWFException )
_DWFTK_API TK_User_OptionsgetUserOptionsHandler () throw ( DWFException )
_DWFTK_API TK_Unicode_OptionsgetUnicodeOptionsHandler () throw ( DWFException )
_DWFTK_API TK_VisibilitygetVisibilityHandler () throw ( DWFException )

Static Public Attributes

static const char *const kz_User_Options_Node
 Indicates the segment represents some object of interest that may have metadata and scope outside of the 3d graphic stream itself.
static const char *const kz_User_Options_Edges
 Indicates the segment contains explicitly defined feature geometry.
static const char *const kz_User_Options_Node_and_Edges
 Indicates the segment represents some object of interest that may have metadata and scope outside of the 3d graphic stream itself; and additionally contains explicitly defined feature edge geometry.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSegment::DWFSegment DWFSegmentHandlerBuilder rSegmentBuilder,
DWFGeometryHandlerBuilder rGeometryBuilder,
DWFFeatureHandlerBuilder rFeatureBuilder,
DWFAttributeHandlerBuilder rAttributeBuilder,
DWFPublishedObject::Factory rObjectFactory,
DWFPublishedObject pPublishedParent = NULL
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.
pPublishedParent An optional object defining a structural relationship between itself and the published object that will be created for this segment.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFSegment::DWFSegment const DWFSegment rSegment  )  throw ( DWFException )
 

Copy Constructor

Parameters:
rSegment The segment to clone.
Exceptions:
DWFException 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFSegment::addProperty const DWFProperty rProperty  )  throw ( DWFException ) [virtual]
 

Inserts a property to the container.

Parameters:
rProperty The property to add to the container.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFSegment::addProperty DWFProperty pProperty,
bool  bOwnProperty = true
throw ( DWFException ) [virtual]
 

Inserts a property to the container.

Parameters:
pProperty The property to add to the container (must not be NULL).
bOwnProperty If true, the container will claim ownership of the property and delete it using the DWFCORE_FREE_OBJECT macro upon destruction of this container if it is still owned.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

Examples:
3DPublish/3DPublish_UTF8.cpp.

virtual _DWFTK_API void DWFToolkit::DWFSegment::addPropertyContainer DWFPropertyContainer pContainer  )  throw ( DWFException ) [virtual]
 

Inserts another property container directly into the container.

Use this method to create sets of properties within a larger property [container] context. Inner containers will be serialized as inner sets. To publish set references, use the referencePropertyContainer() method.

Parameters:
pContainer The container to add to this container (must not be NULL). This pointer will be owned by this container and deleted using the DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API void DWFToolkit::DWFSegment::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 
Examples:
3DPublish/3DPublish_UTF8.cpp.

virtual _DWFTK_API void DWFToolkit::DWFSegment::copyProperties DWFPropertyContainer rContainer,
bool  bRemoveOwnership = false,
bool  bMakeReferences = false
throw ( DWFException ) [virtual]
 

Copies all properties and inner containers from another container.

Parameters:
rContainer The container from which to copy properties and property containers.
bRemoveOwnership If true, this container will assume ownership of all of the the containers owned by rContainer by calling it's removeOwnedPropertyContainers() method. If false, this container will reference all of the containers owned by rContainer. Irrespective of this flag, all inner containers referenced by rContainer will be again referenced by this container.
bMakeReferences If bRemoveOwnership is true, this flag will be passed to the removeOwnedPropertyContainers() method of rContainer.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFPropertyContainer.

virtual _DWFTK_API const DWFProperty* const DWFToolkit::DWFSegment::findProperty const DWFString zName,
const DWFString zCategory = L""
const throw () [virtual]
 

Locates a property in the container.

Parameters:
zName The name of the property to look up (required.)
zCategory The category of the property to look up (optional.)
Returns:
A pointer to the property (may be NULL). This object is owned by the container by default and must not be deleted by the caller without first explicitly claiming ownership.
Exceptions:
None 

_DWFTK_API TK_Area_Light& DWFToolkit::DWFSegment::getAreaLightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for area light geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircleHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for circle geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularArcHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for circular arc geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularChordHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for circular chord geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularWedgeHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for circular wedge geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Color& DWFToolkit::DWFSegment::getColorHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the color attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Color_Map& DWFToolkit::DWFSegment::getColorMapHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the color map attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Color_RGB& DWFToolkit::DWFSegment::getColorRGBHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the RGB color attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Cutting_Plane& DWFToolkit::DWFSegment::getCuttingPlaneHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for cutting plane geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getDistantLightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for distant light geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Linear_Pattern& DWFToolkit::DWFSegment::getEdgePatternHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the edge pattern attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Size& DWFToolkit::DWFSegment::getEdgeWeightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the edge weight attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Ellipse& DWFToolkit::DWFSegment::getEllipseHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for ellipse geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Ellipse& DWFToolkit::DWFSegment::getEllipticalArcHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for elliptical arc geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Enumerated& DWFToolkit::DWFSegment::getFacePatternHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the face pattern attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Enumerated& DWFToolkit::DWFSegment::getHandednessHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the polygon handedness attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Heuristics& DWFToolkit::DWFSegment::getHeuristicsHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the scene heuristics attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Image& DWFToolkit::DWFSegment::getImageHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for image geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Line& DWFToolkit::DWFSegment::getLineHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for line geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Linear_Pattern& DWFToolkit::DWFSegment::getLinePatternHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the line pattern attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Size& DWFToolkit::DWFSegment::getLineWeightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the line weight attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getLocalLightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for local light geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Size& DWFToolkit::DWFSegment::getMarkerSizeHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the marker size attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Enumerated& DWFToolkit::DWFSegment::getMarkerSymbolHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the marker symbol attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Matrix& DWFToolkit::DWFSegment::getModellingMatrixHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the modelling matrix (transform) attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_NURBS_Curve& DWFToolkit::DWFSegment::getNURBSCurveHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for NURBS curve geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_NURBS_Surface& DWFToolkit::DWFSegment::getNURBSSurfaceHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for NURBS surface geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_PolyCylinder& DWFToolkit::DWFSegment::getPolyCylinderHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for polycylinder geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Polypoint& DWFToolkit::DWFSegment::getPolygonHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for polygon geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Polypoint& DWFToolkit::DWFSegment::getPolylineHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for polyline geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

virtual _DWFTK_API DWFProperty::tMap::Iterator* DWFToolkit::DWFSegment::getProperties const DWFString zCategory = L""  )  throw () [virtual]
 

Locates all properties in the container that share a category.

Parameters:
zCategory The property category to search by.
Returns:
A pointer an iterator for enumerating the properties (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Properties returned from the iterator are owned by the container by default and must not be deleted by the caller without first explicitly claiming ownership.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFPropertyContainer.

_DWFTK_API TK_Rendering_Options& DWFToolkit::DWFSegment::getRenderingOptionsHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the rendering options attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Selectability& DWFToolkit::DWFSegment::getSelectabilityHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the object selectability attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Shell& DWFToolkit::DWFSegment::getShellHandler bool  bTriStripsOnly = false,
bool  bDisableOptimization = false
throw ( DWFException ) [virtual]
 

Returns a handler for shell geometry.

Parameters:
bTriStripsOnly The shell is assumed to contain triangles only and may not contain holes, and the "faces" are actually the way that vertices are connected into triangle strips. Start with the length of the strip, followed by the vertex indices to be connected. The first 3 vertices form a triangle, and every additional vertex is combined with the two previous ones to define one additional triangle. Exactly as with OpenGL's GL_TRIANGLE_STRIP primitive, the orientation of every even triangle is reversed, beginning with the second. IMPORTANT: Setting this flag to true when your data is not in tristrips will produce garbage results.
bDisableOptimization Disable vertex and face optimization algorithm normally applied before stream serialization. This optimization is on by default, it's tolerance parameters may be tuned by calling optimize() (this method can also be used to disable the process).
Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Spot_Light& DWFToolkit::DWFSegment::getSpotLightHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for spot light geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Enumerated& DWFToolkit::DWFSegment::getTextAlignmentHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the text alignment attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Text_Font& DWFToolkit::DWFSegment::getTextFontHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the text font attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Text& DWFToolkit::DWFSegment::getTextHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for text geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getTextPathHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the text path attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Size& DWFToolkit::DWFSegment::getTextSpacingHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the text spacing attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Texture& DWFToolkit::DWFSegment::getTextureHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the texture feature.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFFeatureHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Matrix& DWFToolkit::DWFSegment::getTextureMatrixHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the texture matrix feature.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFFeatureHandlerBuilder.

_DWFTK_API TK_Text& DWFToolkit::DWFSegment::getTextWithEncodingHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for encoded text geometry.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFGeometryHandlerBuilder.

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Unicode_Options& DWFToolkit::DWFSegment::getUnicodeOptionsHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the Unicode options attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_User_Options& DWFToolkit::DWFSegment::getUserOptionsHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the user options attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API TK_Visibility& DWFToolkit::DWFSegment::getVisibilityHandler  )  throw ( DWFException ) [virtual]
 

Returns a handler for the visibility attribute.

Returns:
A reference to a op-code handler.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFAttributeHandlerBuilder.

_DWFTK_API void DWFToolkit::DWFSegment::include tKey  nSegmentKey,
const DWFString zInstanceName
throw ( DWFException )
 

Capture a reference to a segment from the include library.

Use this method for reusing geometry and instancing objects and composites.

Since all segments in the include library currently must be named, including such a segment will create parent-child relationship in the meta-structure if this segment is unnamed. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
nSegmentKey The key of the segment to include.
zInstanceName Changes the name of the relationship in the meta-structure (from the name of the include segment.)
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFSegment::include tKey  nSegmentKey  )  throw ( DWFException ) [virtual]
 

Capture a reference to a segment from the include library.

Use this method for reusing geometry and instancing objects and composites.

Since all segments in the include library currently must be named, including such a segment will create parent-child relationship in the meta-structure if this segment is unnamed. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
nSegmentKey The key of the segment to include.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFSegment::include DWFIncludeSegment rSegment,
const DWFString zInstanceName
throw ( DWFException )
 

Capture a reference to a segment from the include library.

Use this method for reusing geometry and instancing objects and composites.

Since all segments in the include library currently must be named, including such a segment will create parent-child relationship in the meta-structure if this segment is unnamed. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
rSegment The segment to include.
zInstanceName Changes the name of the relationship in the meta-structure (from the name of the include segment.)
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFSegment::include DWFIncludeSegment rSegment  )  throw ( DWFException ) [virtual]
 

Capture a reference to a segment from the include library.

Use this method for reusing geometry and instancing objects and composites.

Since all segments in the include library currently must be named, including such a segment will create parent-child relationship in the meta-structure if this segment is unnamed. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
rSegment The segment to include.
Exceptions:
DWFException 
Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API tKey DWFToolkit::DWFSegment::key  )  const throw ()
 

Returns a unique identifier for the segment.

Returns:
The segment key.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFSegment::open const DWFString zName,
bool  bPublishedEdges = false
throw ( DWFException ) [virtual]
 

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.
bPublishedEdges Set this flag to true if feature edge geometry will be added to this segment.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFSegment::open const DWFString pName = NULL,
bool  bPublishedEdges = false
throw ( DWFException ) [virtual]
 

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.
bPublishedEdges Set this flag to true if feature edge geometry will be added to this segment.
Exceptions:
DWFException 
Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API DWFSegment DWFToolkit::DWFSegment::openSegment  )  throw ( DWFException )
 

Creates a subsegment in the scene.

Despite this method name, the subsegment object must still be explicitly opened as it follows the general workflow detailed in open().

Exceptions:
DWFException 
Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API DWFSegment& DWFToolkit::DWFSegment::operator= const DWFSegment rSegment  )  throw ( DWFException )
 

Assignment Operator

Parameters:
rSegment The segment to clone.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFSegment::referencePropertyContainer const DWFPropertyContainer rContainer  )  throw ( DWFException ) [virtual]
 

Inserts another property container by reference into the container.

Use this method to create references to other sets of properties within a larger property [container] context. Inner containers will be serialized as reference IDs. To publish inlined inner sets, use the addPropertyContainer() method.

Parameters:
rContainer The container to add to this container as a reference.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

Examples:
3DPublish/3DPublish_UTF8.cpp.

virtual _DWFTK_API void DWFToolkit::DWFSegment::removeAllPropertyContainers DWFPropertyContainer::tList rContainerList  )  throw ( DWFException ) [virtual]
 

Removes from the container and returns in a list, all inner containers.

Parameters:
rContainerList A list to which the container pointers are to be added.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

virtual _DWFTK_API void DWFToolkit::DWFSegment::removeOwnedPropertyContainers DWFPropertyContainer::tList rContainerList,
bool  bMakeReferences = false
throw ( DWFException ) [virtual]
 

Removes from the container and returns in a list, those property containers that have been directly added with the addPropertyContainer() method.

These inner containers are considered as owned by this object.

Parameters:
rContainerList A list to which the container pointers are to be added. These pointers are now the responsibility of the caller and must be deleted with the DWFCORE_FREE_OBJECT macro.
bMakeReferences If true, the inner containers removed by this method will be add to the referenced inner container list.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

virtual _DWFTK_API void DWFToolkit::DWFSegment::removeReferencedPropertyContainers DWFPropertyContainer::tList rContainerList  )  throw ( DWFException ) [virtual]
 

Removes from the container and returns in a list, those property containers that have been added as references with the referencePropertyContainer() method.

Parameters:
rContainerList A list to which the container pointers are to be added. These pointers must not be deleted by the caller.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFPropertyContainer.

_DWFTK_API void DWFToolkit::DWFSegment::style DWFStyleSegment rSegment  )  throw ( DWFException )
 

Applies a style (via a styling segment).

Styling segments are bundles of attributes that can be applied as a whole in the scene to affect visualization.

Parameters:
rSegment The style to apply.
Exceptions:
DWFException 


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