Public Member Functions | List of all members
IMultilineEdit Struct Referenceabstract

Set specific properties on a multi-line. More...

#include <MultilineHandler.h>

Inheritance diagram for IMultilineEdit:
IMultilineQuery MultilineHandler

Public Member Functions

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

Detailed Description

Set specific properties on a multi-line.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Function Documentation

DGNPLATFORM_EXPORT BentleyStatus ApplyStyle ( EditElementHandleR  element,
MultilineStyleCR  mlineStyle,
double  styleScale 
)

Apply a multiline style to a given multiline element.

Parameters
[out]elementThe element to update.
[in]mlineStyleThe style to apply
[in]styleScaleThe scale for the style. Scale applies to the multi-line profile offsets.
Returns
true if eeh is the correct type and the element was updated.
Note
To query the multiline element's Z bvector use DisplayHandler::IsPlanar
DGNPLATFORM_EXPORT BentleyStatus DeleteBreak ( EditElementHandleR  element,
UInt32  segment,
UInt32  breakNo 
)

Delete a break from the multiline definition.

Parameters
[in]elementsource element
[in]segmentwhich segment the break is on
[in]breakNowhich break on the segment it is
Returns
SUCCESS if the element is a multiline and the break currently exists.
DGNPLATFORM_EXPORT BentleyStatus DeletePoint ( EditElementHandleR  element,
UInt32  pointNum 
)

Delete point in the multiline definition.

Parameters
[in]elementsource element
[in]pointNumindex to delete point.
Returns
SUCCESS if the element is a multiline and the point was deleted.
DGNPLATFORM_EXPORT BentleyStatus InsertBreak ( EditElementHandleR  element,
MultilineBreakCR  mlbreak,
UInt32  segment 
)

Replace a break in the multiline definition.

Parameters
[in]elementsource element
[in]mlbreakbreak to replace
[in]segmentwhich segment the break is on
Returns
SUCCESS if the element is a multiline and the break currently exists.
DGNPLATFORM_EXPORT BentleyStatus InsertPoint ( EditElementHandleR  element,
DPoint3dCR  newPoint,
AssocPoint const *  assocPointP,
UInt32  pointNum 
)

Insert point in the multiline definition.

Parameters
[in]elementsource element
[in]newPointpoint to add
[in]assocPointPassociative point for this mline point. NULL to use a normal point from newPoint.
[in]pointNumindex to insert point. -1 means at the end.
Returns
SUCCESS if the element is a multiline and the point was inserted.
DGNPLATFORM_EXPORT BentleyStatus ReplacePoint ( EditElementHandleR  element,
DPoint3dCR  newPoint,
UInt32  pointNum,
MlineModifyPoint  options 
)

Replace point in the multiline definition.

If you want to replace a point and drop Association, then specify the MlineModifyPoint::RemoveAssociations option; otherwise you cannot replace an Associative Point. To make a point Associative, use DeletePoint followed by InsertPoint.

Parameters
[in]elementsource element
[in]newPointpoint to replace
[in]pointNumindex to replace
[in]optionsreplace option flags - see enum MlineModifyPoint
Returns
SUCCESS if the element is a multiline and the point currently exists.
DGNPLATFORM_EXPORT BentleyStatus SetClosed ( EditElementHandleR  element,
bool  isClosed 
)

Set the closed property of a multiline element.

Parameters
[out]elementThe element to update.
[in]isClosednew closure status.
Returns
SUCCESS if element's closure status was updated.
DGNPLATFORM_EXPORT BentleyStatus SetEndAngle ( EditElementHandleR  element,
double  angle 
)

Set the end cap angle for the multiline.

PI/2 is perpindicular.

Parameters
[in]elementsource element
[in]angleNew angle in radians
Returns
SUCCESS if the element is a multiline.
DGNPLATFORM_EXPORT BentleyStatus SetEndCap ( EditElementHandleR  element,
MultilineSymbologyCR  capSymbology 
)

Replace the symbology of the multiline end cap geometry.

Parameters
[out]elementThe element to update.
[in]capSymbologyThe new symbology
Returns
SUCCESS if element is the correct type and the element was updated.
DGNPLATFORM_EXPORT BentleyStatus SetMidCap ( EditElementHandleR  element,
MultilineSymbologyCR  capSymbology 
)

Replace the symbology of the multiline middle or joint cap geometry.

Parameters
[out]elementThe element to update.
[in]capSymbologyThe new symbology
Returns
SUCCESS if element is the correct type and the element was updated.
DGNPLATFORM_EXPORT BentleyStatus SetOffsetMode ( EditElementHandleR  element,
MlineOffsetMode  offsetMode 
)

Set the Offset Mode stored on the multi-line element.

This mode will be used if the style is reapplied. Note that this does not modify the current profile locations.

Parameters
[in]elementmultiline element
[in]offsetModefor multiline
DGNPLATFORM_EXPORT BentleyStatus SetOriginAngle ( EditElementHandleR  element,
double  angle 
)

Set the origin or start cap angle for the multiline.

PI/2 is perpindicular.

Parameters
[in]elementsource element
[in]angleNew angle in radians
Returns
SUCCESS if the element is a multiline.
DGNPLATFORM_EXPORT BentleyStatus SetOriginCap ( EditElementHandleR  element,
MultilineSymbologyCR  capSymbology 
)

Replace the symbology of the multiline origin cap geometry.

Parameters
[out]elementThe element to update.
[in]capSymbologyThe new symbology
Returns
SUCCESS if element is the correct type and the element was updated.
DGNPLATFORM_EXPORT BentleyStatus SetPlacementOffset ( EditElementHandleR  element,
double  placementOffset 
)

Set the offset distance stored on the multi-line element.

It represents the distance between the Work Line (profile offset of zero) and the line that the user drew to place the multi-line. This value is only used if the Offset Mode is MlineOffsetMode::Custom. This distance will be used if the style is reapplied; it does not modify the current profile locations.

Parameters
[in]elementmultiline element
[in]placementOffsetdistance for multiline
DGNPLATFORM_EXPORT BentleyStatus SetProfile ( EditElementHandleR  element,
UInt32  index,
MultilineProfileCR  profile 
)

Replace a multiline profile.

Parameters
[out]elementThe element to update.
[in]indexThe index of the profile to replace. The multiline must already have a profile at this index.
[in]profileThe new profile
Returns
SUCCESS if element is the correct type, the profile index is within range, and the element was updated.
DGNPLATFORM_EXPORT BentleyStatus SetZVector ( EditElementHandleR  element,
DVec3dCR  normal 
)

Set the z axis of a 3d multiline element.

The element is planar, and this bvector defines that plane.

Parameters
[out]elementThe element to update.
[in]normalnew z axis of multiline element.
Returns
SUCCESS if element is the correct type and the element was updated.
Note
To query the multiline element's Z bvector use DisplayHandler::IsPlanar

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.