The default type handler for the MULTILINE_ELM type that corresponds to the MlineElm structure. More...
#include <MultilineHandler.h>
Inheritance diagram for MultilineHandler:
Static Public Member Functions | |
| static DGNPLATFORM_EXPORT BentleyStatus | CreateMultilineElement (EditElementHandleR eeh, ElementHandleCP templateEh, MultilineStyleCR mlineStyle, double styleScale, DVec3dCR normal, DPoint3dCP points, int numVerts, bool is3d, DgnModelRefR modelRef) |
| Create a new MULTILINE_ELM with the supplied parameters. More... | |
 Static Public Member Functions inherited from DisplayHandler | |
| static DisplayHandler & | GetInstance () |
| static void | InitializeBasis (EditElementHandleR eh, TransformCR transform, DRange3dCP range) |
| Initialize basis for an element - In most cases this should be done only once at creation. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from DisplayHandler | |
| void | GetPathDescription (ElementHandleCR el, WStringR string, DisplayPathCP path, WCharCP levelStr, WCharCP modelStr, WCharCP groupStr, WCharCP delimiterStr) |
| Return a full description of the path to be used to inform the user which element is under consideration. More... | |
| void | GetTransformOrigin (ElementHandleCR el, DPoint3dR origin) |
| Get the Transform Origin for this element. More... | |
| void | GetSnapOrigin (ElementHandleCR el, DPoint3dR origin) |
| Get the snap origin for this element. More... | |
| void | GetOrientation (ElementHandleCR el, RotMatrixR orientation) |
| Get an "orientation" RotMatrix for this element. More... | |
| bool | GetBasisTransform (ElementHandleCR eh, TransformR transform) |
| Get an "basis" Transform for this element. More... | |
| bool | GetBasisRange (ElementHandleCR eh, DRange3dR range) |
| Get an basis Range for this element. More... | |
| void | SetBasisRange (EditElementHandleR eh, DRange3dCR range) |
| Set an basis Range for this element. More... | |
| void | SetBasisTransform (EditElementHandleR eh, TransformCR transform) |
| Set an basis Transform for this element. More... | |
| bool | IsRenderable (ElementHandleCR el) |
| Determine whether this element is renderable (i.e., subject to lighting). More... | |
| bool | IsPlanar (ElementHandleCR el, DVec3dP normal, DPoint3dP point, DVec3dCP inputDefaultNormal) |
| Test whether this element is planar. More... | |
| bool | IsVisible (ElementHandleCR el, ViewContextR context, bool testRange, bool testLevel, bool testClass) |
| Determine whether this element is visible in the supplied context. More... | |
| StatusInt | Drop (ElementHandleCR eh, ElementAgendaR dropGeom, DropGeometryCR geometry) |
| Drop this element to a group of (simpler) primitive elements. More... | |
| Public Member Functions inherited from Handler | |
| void | GetDescription (ElementHandleCR el, WStringR string, UInt32 desiredLength) |
| Get a brief string describing the element. More... | |
| void | GetTypeName (WStringR string, UInt32 desiredLength) |
| Get the type name for this handler. More... | |
| DisplayHandlerP | GetDisplayHandler () |
| Use this method instead of dynamic_cast<DisplayHandlerP> (handler) More... | |
| ITransactionHandlerP | GetITransactionHandler () |
| Use this method instead of dynamic_cast<ITransactionHandlerP> (handler) More... | |
| IDependencyHandlerP | GetIDependencyHandler () |
| Use this method instead of dynamic_cast<IDependencyHandlerP> (handler) More... | |
| StatusInt | ApplyTransform (EditElementHandleR element, TransformInfoCR transform) |
| Transform the element. More... | |
| StatusInt | FenceStretch (EditElementHandleR element, TransformInfoCR transform, FenceParamsP fp, FenceStretchFlags options) |
| The handler is requested to "stretch" the specified element, that is, to transform the portions of the element that meet the clip criteria. More... | |
| StatusInt | FenceClip (ElementAgendaP inside, ElementAgendaP outside, ElementHandleCR element, FenceParamsP fp, FenceClipFlags options) |
| The handler is requested to clip the specified element, that is, to return the portions of the element that are inside/outside the clip criteria. More... | |
| void | ConvertTo3d (EditElementHandleR eeh, double elevation) |
| Convert a 2d element to it's 3d form. More... | |
| void | ConvertTo2d (EditElementHandleR eeh, TransformCR flattenTrans, DVec3dCR flattenDir) |
| Convert a 3d element to it's 2d form. More... | |
| void | QueryProperties (ElementHandleCR eh, PropertyContextR context) |
| Method for enummerating the common properties of elements such as color and level. More... | |
| void | EditProperties (EditElementHandleR eeh, PropertyContextR context) |
| Method for changing the common properties of elements such as color and level. More... | |
| bool | ExposeChildren (ElementHandleCR el, ExposeChildrenReason reason) |
| Determine whether the children of this element should be exposed to the caller for the intended purpose. More... | |
| Public Member Functions inherited from IMultilineEdit | |
| DGNPLATFORM_EXPORT BentleyStatus | ReplacePoint (EditElementHandleR element, DPoint3dCR newPoint, UInt32 pointNum, MlineModifyPoint options) |
| Replace point in the multiline definition. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | InsertPoint (EditElementHandleR element, DPoint3dCR newPoint, AssocPoint const *assocPointP, UInt32 pointNum) |
| Insert point in the multiline definition. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | DeletePoint (EditElementHandleR element, UInt32 pointNum) |
| Delete point in the multiline definition. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetOriginAngle (EditElementHandleR element, double angle) |
| Set the origin or start cap angle for the multiline. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetEndAngle (EditElementHandleR element, double angle) |
| Set the end cap angle for the multiline. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | InsertBreak (EditElementHandleR element, MultilineBreakCR mlbreak, UInt32 segment) |
| Replace a break in the multiline definition. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | DeleteBreak (EditElementHandleR element, UInt32 segment, UInt32 breakNo) |
| Delete a break from the multiline definition. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetZVector (EditElementHandleR element, DVec3dCR normal) |
| Set the z axis of a 3d multiline element. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetClosed (EditElementHandleR element, bool isClosed) |
| Set the closed property of a multiline element. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetOriginCap (EditElementHandleR element, MultilineSymbologyCR capSymbology) |
| Replace the symbology of the multiline origin cap geometry. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetEndCap (EditElementHandleR element, MultilineSymbologyCR capSymbology) |
| Replace the symbology of the multiline end cap geometry. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetMidCap (EditElementHandleR element, MultilineSymbologyCR capSymbology) |
| Replace the symbology of the multiline middle or joint cap geometry. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetProfile (EditElementHandleR element, UInt32 index, MultilineProfileCR profile) |
| Replace a multiline profile. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | ApplyStyle (EditElementHandleR element, MultilineStyleCR mlineStyle, double styleScale) |
| Apply a multiline style to a given multiline element. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetOffsetMode (EditElementHandleR element, MlineOffsetMode offsetMode) |
| Set the Offset Mode stored on the multi-line element. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | SetPlacementOffset (EditElementHandleR element, double placementOffset) |
| Set the offset distance stored on the multi-line element. More... | |
| Public Member Functions inherited from IMultilineQuery | |
| DGNPLATFORM_EXPORT bool | IsClosed (ElementHandleCR source) const |
| Query if the multiline element represents a closed path. More... | |
| DGNPLATFORM_EXPORT UInt32 | GetProfileCount (ElementHandleCR source) const |
| Query the number of profile lines in the multiline element. More... | |
| DGNPLATFORM_EXPORT MultilineProfilePtr | GetProfile (ElementHandleCR source, int index) const |
| Query a profile line definition. More... | |
| DGNPLATFORM_EXPORT MultilineSymbologyPtr | GetOriginCap (ElementHandleCR source) const |
| Query the symbology of the multiline origin cap. More... | |
| DGNPLATFORM_EXPORT MultilineSymbologyPtr | GetEndCap (ElementHandleCR source) const |
| Query the symbology of the multiline end cap. More... | |
| DGNPLATFORM_EXPORT MultilineSymbologyPtr | GetMidCap (ElementHandleCR source) const |
| Query the symbology of the multiline middle or joint cap. More... | |
| DGNPLATFORM_EXPORT double | GetOriginAngle (ElementHandleCR source) const |
| Get the origin or start cap angle for the multiline. More... | |
| DGNPLATFORM_EXPORT double | GetEndAngle (ElementHandleCR source) const |
| Get the end cap angle for the multiline. More... | |
| DGNPLATFORM_EXPORT MultilinePointPtr | GetPoint (ElementHandleCR source, UInt32 pointNumber) const |
| Get a pointer to the first MlinePoint definition. More... | |
| DGNPLATFORM_EXPORT UInt32 | GetPointCount (ElementHandleCR source) const |
| Query the number of points in the multiline element. More... | |
| DGNPLATFORM_EXPORT UInt32 | GetBreakCount (ElementHandleCR source) const |
| Get the number of breaks on a multline. More... | |
| DGNPLATFORM_EXPORT MultilineBreakPtr | GetBreak (ElementHandleCR source, UInt32 segmentNumber, UInt32 segBreakNumber) const |
| Get a pointer to a multiline break based on the segment of the multiline. More... | |
| DGNPLATFORM_EXPORT JointDef | ExtractJointDefinition (ElementHandleCR source, DPoint3dCP pts, int pointNo) const |
| Extract a multiline joint definition for a given segment of the multiline. More... | |
| DGNPLATFORM_EXPORT JointDef | ExtractCapJointDefinition (ElementHandleCR source, DPoint3dCP pts, int pointNo) const |
| Extract a multiline cap joint definition for a given segment of the multiline. More... | |
| DGNPLATFORM_EXPORT BentleyStatus | ExtractPoints (ElementHandleCR source, DPoint3dP pXYZBuffer, size_t &numPoints, size_t maxOut) const |
| Extract the array of points from a multi-line. More... | |
| DGNPLATFORM_EXPORT MultilineStylePtr | GetStyle (ElementHandleCR source, MultilineStyleCP seedStyle, UInt32 options) const |
| Get an object representing the style of a multiline element. More... | |
| DGNPLATFORM_EXPORT double | GetStyleScale (ElementHandleCR source) const |
| Get the style scale stored on the multi-line element. More... | |
| DGNPLATFORM_EXPORT MlineOffsetMode | GetOffsetMode (ElementHandleCR source) const |
| Get the Offset Mode stored on the multi-line element. More... | |
| DGNPLATFORM_EXPORT double | GetPlacementOffset (ElementHandleCR source) const |
| Get the Offset Distance stored on the multi-line element. More... | |
| Public Member Functions inherited from IAreaFillPropertiesEdit | |
| DGNPLATFORM_EXPORT bool | SetAreaType (EditElementHandleR eeh, bool isHole) |
| Change the current solid/hole status for the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | RemoveAreaFill (EditElementHandleR eeh) |
| Remove the current solid or gradient fill from the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | RemovePattern (EditElementHandleR eeh, int index) |
| Remove the current hatch or area pattern from the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | AddSolidFill (EditElementHandleR eeh, UInt32 *fillColorP=NULL, bool *alwaysFilledP=NULL) |
| Add solid fill to the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | AddGradientFill (EditElementHandleR eeh, GradientSymbCR symb) |
| Add gradient fill to the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | AddPattern (EditElementHandleR eeh, PatternParamsR params, DwgHatchDefLineP hatchDefLinesP, int index=0) |
| Add a hatch or area pattern to the supplied element. More... | |
| Public Member Functions inherited from IAreaFillPropertiesQuery | |
| DGNPLATFORM_EXPORT bool | GetAreaType (ElementHandleCR eh, bool *isHoleP) const |
| Query whether the area defined by a closed region represents a solid or hole. More... | |
| DGNPLATFORM_EXPORT bool | GetSolidFill (ElementHandleCR eh, UInt32 *fillColorP, bool *alwaysFilledP) const |
| Query the current solid fill information for the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | GetGradientFill (ElementHandleCR eh, GradientSymbPtr &symb) const |
| Query the current gradient fill information for the supplied element. More... | |
| DGNPLATFORM_EXPORT bool | GetPattern (ElementHandleCR eh, PatternParamsPtr ¶ms, bvector< DwgHatchDefLine > *hatchDefLinesP, DPoint3dP originP, int index) const |
| Query the current hatch or area pattern information for the supplied element. More... | |
Detailed Description
The default type handler for the MULTILINE_ELM type that corresponds to the MlineElm structure.
- Remarks
- Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Member Function Documentation
|
static |
Create a new MULTILINE_ELM with the supplied parameters.
- Parameters
-
[out] eeh The new element. [in] templateEh Template element used to set the header symbology [in] mlineStyle Multi-line style to apply to the element [in] styleScale Scale to use when applying the mline style [in] normal z axis of multiline element. [in] points input point buffer. [in] numVerts number of points. [in] is3d Initialize the 2d or 3d element structure, typically modelRef->Is3d (). [in] modelRef Model to associate this element with. Required to compute range.
- Returns
- SUCCESS if a valid element is created and range was sucessfully calculated.
The documentation for this struct was generated from the following file: