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 63 of file Segment.h.

Public Types

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

Public Member Functions

_DWFTK_API DWFSegment (DWFSegmentHandlerBuilder &rSegmentBuilder, DWFGeometryHandlerBuilder &rGeometryBuilder, DWFFeatureHandlerBuilder &rFeatureBuilder, DWFAttributeHandlerBuilder &rAttributeBuilder, DWFPublishedObject::Factory &rObjectFactory, DWFPublishedObject *pPublishedParent=NULL, bool bUseOldObjectModel=false) 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 *zName=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, bool bGenerateMetadata=true) throw ( DWFException )
_DWFTK_API void include (DWFIncludeSegment &rSegment, const DWFString &rInstanceName) throw ( DWFException )
virtual _DWFTK_API void include (tKey nSegmentKey, bool bGenerateMetadata=true) throw ( DWFException )
_DWFTK_API void include (tKey nSegmentKey, const DWFString &rInstanceName) throw ( DWFException )
_DWFTK_API void setVisibility (bool bVisible) throw ( DWFException )
virtual _DWFTK_API void setContentEntity (DWFEntity *pEntity, const DWFString *pzInstanceName=NULL) throw ( DWFException )
virtual _DWFTK_API void setContentObject (DWFObject *pObject) 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) throw ( DWFException )
virtual _DWFTK_API void addProperty (const DWFProperty &rProperty) throw ( DWFException )
virtual _DWFTK_API DWFPropertyaddProperty (const DWFString &zName, const DWFString &zValue, const DWFString &zCategory=L"", const DWFString &zType=L"", const DWFString &zUnits=L"") 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_Light & getAreaLightHandler () throw ( DWFException )
_DWFTK_API TK_Circle & getCircleHandler () throw ( DWFException )
_DWFTK_API TK_Circle & getCircularArcHandler () throw ( DWFException )
_DWFTK_API TK_Circle & getCircularChordHandler () throw ( DWFException )
_DWFTK_API TK_Circle & getCircularWedgeHandler () throw ( DWFException )
_DWFTK_API TK_Clip_Rectangle & getClipRectangleHandler () throw ( DWFException )
_DWFTK_API TK_Clip_Region & getClipRegionHandler () throw ( DWFException )
_DWFTK_API TK_Cutting_Plane & getCuttingPlaneHandler () throw ( DWFException )
_DWFTK_API TK_Cylinder & getCylinderHandler () throw ( DWFException )
_DWFTK_API TK_Point & getDistantLightHandler () throw ( DWFException )
_DWFTK_API TK_Ellipse & getEllipseHandler () throw ( DWFException )
_DWFTK_API TK_Ellipse & getEllipticalArcHandler () throw ( DWFException )
_DWFTK_API TK_Glyph_Definition & getGlyphDefinitionHandler () throw ( DWFException )
_DWFTK_API TK_Grid & getGridHandler () throw ( DWFException )
_DWFTK_API TK_Image & getImageHandler () throw ( DWFException )
_DWFTK_API TK_Line & getLineHandler () throw ( DWFException )
_DWFTK_API TK_Point & getLocalLightHandler () throw ( DWFException )
_DWFTK_API TK_Point & getMarkerHandler () throw ( DWFException )
_DWFTK_API TK_Mesh & getMeshHandler () throw ( DWFException )
_DWFTK_API TK_NURBS_Curve & getNURBSCurveHandler () throw ( DWFException )
_DWFTK_API TK_NURBS_Surface & getNURBSSurfaceHandler () throw ( DWFException )
_DWFTK_API TK_PolyCylinder & getPolyCylinderHandler () throw ( DWFException )
_DWFTK_API TK_Polypoint & getPolygonHandler () throw ( DWFException )
_DWFTK_API TK_Polypoint & getPolylineHandler () throw ( DWFException )
_DWFTK_API TK_Shell & getShellHandler (bool bTriStripsOnly=false, bool bDisableOptimization=false) throw ( DWFException )
_DWFTK_API TK_Sphere & getSphereHandler () throw ( DWFException )
_DWFTK_API TK_Spot_Light & getSpotLightHandler () throw ( DWFException )
_DWFTK_API TK_Text & getTextHandler () throw ( DWFException )
_DWFTK_API TK_Text & getTextWithEncodingHandler () throw ( DWFException )
_DWFTK_API TK_Texture & getTextureHandler () throw ( DWFException )
_DWFTK_API TK_Matrix & getTextureMatrixHandler () throw ( DWFException )
_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_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 )
_DWFTK_API void openLocalLightAttributes () throw ( DWFException )
_DWFTK_API void closeLocalLightAttributes () 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_Hidden
 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.
static const char *const kz_User_Options_Transparent
static const char *const kz_User_Options_Hidden_Node
static const char *const kz_User_Options_Transparent_Node
static const char *const kz_User_Options_Node_and_Edges
static const char *const kz_User_Options_Hidden_Node_and_Edges
static const char *const kz_User_Options_Transparent_Node_and_Edges

Protected Attributes

DWFSegmentHandlerBuilder_rSegmentBuilder
DWFGeometryHandlerBuilder_rGeometryBuilder
DWFFeatureHandlerBuilder_rFeatureBuilder
DWFAttributeHandlerBuilder_rAttributeBuilder
DWFPublishedObject::Factory & _rObjectFactory
DWFPublishedObject_pPublishedObject
DWFPublishedObject_pPublishedParent
DWFString_pLibrary


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSegment::DWFSegment DWFSegmentHandlerBuilder rSegmentBuilder,
DWFGeometryHandlerBuilder rGeometryBuilder,
DWFFeatureHandlerBuilder rFeatureBuilder,
DWFAttributeHandlerBuilder rAttributeBuilder,
DWFPublishedObject::Factory &  rObjectFactory,
DWFPublishedObject pPublishedParent = NULL,
bool  bUseOldObjectModel = false
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.
bUseOldObjectModel If true, rules corresponding to the old object definition model will be applied to test for validity during the model creation process.
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 DWFProperty* DWFToolkit::DWFSegment::addProperty const DWFString zName,
const DWFString zValue,
const DWFString zCategory = L"",
const DWFString zType = L"",
const DWFString zUnits = L""
throw ( DWFException ) [virtual]
 

Insert a property into the container, by directly specifying the property elements. The property will be owned.

Parameters:
zName Identifies the property within its zCategory.
zValue The data associated with the property.
zCategory An optional grouping of properties.
zType An optional type defining the data.
zUnits An optional type defining the data.
Returns:
A pointer to the property created.
Exceptions:
DWFException 

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  )  throw ( DWFException ) [virtual]
 

Inserts a property to the container.

Parameters:
pProperty The property to add to the container (must not be NULL).
Exceptions:
DWFException 
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 
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.

_DWFTK_API void DWFToolkit::DWFSegment::closeLocalLightAttributes  )  throw ( DWFException )
 

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 its 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 

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 )
 

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

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircleHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularArcHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularChordHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Circle& DWFToolkit::DWFSegment::getCircularWedgeHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Clip_Rectangle& DWFToolkit::DWFSegment::getClipRectangleHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Clip_Region& DWFToolkit::DWFSegment::getClipRegionHandler  )  throw ( DWFException )
 

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

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

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Cutting_Plane& DWFToolkit::DWFSegment::getCuttingPlaneHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Cylinder& DWFToolkit::DWFSegment::getCylinderHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getDistantLightHandler  )  throw ( DWFException )
 

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Ellipse& DWFToolkit::DWFSegment::getEllipseHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Ellipse& DWFToolkit::DWFSegment::getEllipticalArcHandler  )  throw ( DWFException )
 

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Glyph_Definition& DWFToolkit::DWFSegment::getGlyphDefinitionHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Grid& DWFToolkit::DWFSegment::getGridHandler  )  throw ( DWFException )
 

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

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

_DWFTK_API TK_Image& DWFToolkit::DWFSegment::getImageHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Line& DWFToolkit::DWFSegment::getLineHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

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

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

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

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getLocalLightHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Point& DWFToolkit::DWFSegment::getMarkerHandler  )  throw ( DWFException )
 

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

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

_DWFTK_API TK_Mesh& DWFToolkit::DWFSegment::getMeshHandler  )  throw ( DWFException )
 

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_NURBS_Curve& DWFToolkit::DWFSegment::getNURBSCurveHandler  )  throw ( DWFException )
 

_DWFTK_API TK_NURBS_Surface& DWFToolkit::DWFSegment::getNURBSSurfaceHandler  )  throw ( DWFException )
 

_DWFTK_API TK_PolyCylinder& DWFToolkit::DWFSegment::getPolyCylinderHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Polypoint& DWFToolkit::DWFSegment::getPolygonHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Polypoint& DWFToolkit::DWFSegment::getPolylineHandler  )  throw ( DWFException )
 

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 to 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. This will only return properties directly owned by the container, not in any of the subcontainers or referenced containers.
Exceptions:
None 

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

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

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Sphere& DWFToolkit::DWFSegment::getSphereHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Spot_Light& DWFToolkit::DWFSegment::getSpotLightHandler  )  throw ( DWFException )
 

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

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Text& DWFToolkit::DWFSegment::getTextHandler  )  throw ( DWFException )
 

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

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

_DWFTK_API TK_Texture& DWFToolkit::DWFSegment::getTextureHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API TK_Matrix& DWFToolkit::DWFSegment::getTextureMatrixHandler  )  throw ( DWFException )
 

_DWFTK_API TK_Text& DWFToolkit::DWFSegment::getTextWithEncodingHandler  )  throw ( DWFException )
 

Examples:
3DPublish/3DPublish_UTF8.cpp.

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

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

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

Examples:
3DPublish/3DPublish_UTF8.cpp.

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

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

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

_DWFTK_API void DWFToolkit::DWFSegment::include tKey  nSegmentKey,
const DWFString rInstanceName
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.
rInstanceName 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,
bool  bGenerateMetadata = true
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 and the metadata is set to be generated. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
nSegmentKey The key of the segment to include.
bGenerateMetadata If true, the associated metadata, e.g., objects and entities will be generated. Otherwise only the geometry will be included.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFSegment::include DWFIncludeSegment rSegment,
const DWFString rInstanceName
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.
rInstanceName 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,
bool  bGenerateMetadata = true
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 and the metadata is set to be generated. See DWFIncludeSegment and 3D Publisher API page for more details.

Parameters:
rSegment The segment to include.
bGenerateMetadata If true, the associated metadata, e.g., objects and entities will be generated. Otherwise only the geometry will be included.
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 zName = 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:
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 
Examples:
3DPublish/3DPublish_UTF8.cpp.

_DWFTK_API void DWFToolkit::DWFSegment::openLocalLightAttributes  )  throw ( DWFException )
 

_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 
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 

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 

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 

virtual _DWFTK_API void DWFToolkit::DWFSegment::setContentEntity DWFEntity pEntity,
const DWFString pzInstanceName = NULL
throw ( DWFException ) [virtual]
 

When generating an object for this segment, set the object's entity to the one provided, instead of generating one. This call is useful if you directly create an entity directly in the content, or if you want to assign an entity generated in an earlier model, to the current segment.

Note: Any of the following scenarios will throw an exception. 1) This is called after include has be called on this segment. 2) This is called after setEntity has already been called on this segment. 3) This is called after setObject has been called on this segment. 4) include is called after calling this ( the exception is thrown by include ). 5) setObject is called after calling this ( the exception is thrown by setObject ).

Essentially the calls include, setObject and setEntity are mutually exclusive.

Parameters:
pEntity The DWFEntity which will be associated with this segment.
pzInstanceName An optional name for the generated content object. Maybe NULL.
Exceptions:
DWFException 
Since:
7.2.0

virtual _DWFTK_API void DWFToolkit::DWFSegment::setContentObject DWFObject pObject  )  throw ( DWFException ) [virtual]
 

Instead of generating an object for this segment, set the provided object as the content object associated with the segment. This call is useful if you directly create an object in the content, or if you want to assign an object generated in an earlier model to the current segment. This is very important if you want to have an object model that spans multiple graphical renditions of the model.

Settting this on a named segment will cause the name of the segment to be ignored. It will replaced by the object name.

Note: Any of the following scenarios will throw an exception: 1) If the parent segment of this segment has an associated object that is not the parent of the provided object. 2) This is called after include has be called on this segment. 3) This is called after setEntity has been called on this segment. 4) This is called after setObject has been already called on this segment. 5) include is called after calling this ( the exception is thrown by include ). 6) setEntity is called after calling this ( the exception is thrown by setEntity ).

Essentially the calls include, setObject and setEntity are mutually exclusive.

Parameters:
pObject The DWFObject which will be associated with this segment.
Exceptions:
DWFException 
Since:
7.2.0

_DWFTK_API void DWFToolkit::DWFSegment::setVisibility bool  bVisible  )  throw ( DWFException )
 

Sets the visibility for this segment

This sets the visibility for this segmnt and all of its subsegments unless overriden by a subsegment.

All segments are visible by default

Parameters:
bVisible The visibility of this segment
Exceptions:
DWFException 
Since:
7.2.0

_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 Jan 6 22:40:46 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5