Public Member Functions | List of all members
IMultilineQuery Struct Referenceabstract

Query an element for multi-line specific properties. More...

#include <MultilineHandler.h>

Inheritance diagram for IMultilineQuery:
IMultilineEdit MultilineHandler

Public Member Functions

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

Query an element for multi-line specific properties.

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

Member Function Documentation

DGNPLATFORM_EXPORT JointDef ExtractCapJointDefinition ( ElementHandleCR  source,
DPoint3dCP  pts,
int  pointNo 
) const

Extract a multiline cap joint definition for a given segment of the multiline.

Parameters
[in]sourcesource element
[in]ptsstart and end points of line segment.
[in]pointNocap joint, 0 for org and 1 for end.
Returns
A joint definition
DGNPLATFORM_EXPORT JointDef ExtractJointDefinition ( ElementHandleCR  source,
DPoint3dCP  pts,
int  pointNo 
) const

Extract a multiline joint definition for a given segment of the multiline.

Parameters
[in]sourcesource element
[in]ptsbase point array from ExtractPoints.
[in]pointNoindex of first point.
Returns
A joint definition
DGNPLATFORM_EXPORT BentleyStatus ExtractPoints ( ElementHandleCR  source,
DPoint3dP  pXYZBuffer,
size_t &  numPoints,
size_t  maxOut 
) const

Extract the array of points from a multi-line.

These represent the workline of the multi-line, and may not correspond to anything displayed.

Parameters
[in]sourcesource element
[out]pXYZBuffer(optional) buffer for points.
[out]numPointsnumber of points
[in]maxOutbuffer size. If numPoints is larger, the large number is returned but only maxOut are copied.
Returns
SUCCESS if the element is a multiline.
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.

Parameters
[in]sourcesource element
[in]segmentNumberSegment to find break
[in]segBreakNumberWhich break on that segment
Returns
A pointer to the a copy of the break. Be sure to check isValid() on the return in case the break doesn't exist.
DGNPLATFORM_EXPORT UInt32 GetBreakCount ( ElementHandleCR  source) const

Get the number of breaks on a multline.

Parameters
[in]sourcesource element
Returns
The number of breaks
DGNPLATFORM_EXPORT double GetEndAngle ( ElementHandleCR  source) const

Get the end cap angle for the multiline.

Parameters
[in]sourcesource element
Returns
The angle in radians

Query the symbology of the multiline end cap.

Parameters
[in]sourcesource element
Returns
A copy of the cap symbology

Query the symbology of the multiline middle or joint cap.

Parameters
[in]sourcesource element
Returns
A copy of the cap symbology
DGNPLATFORM_EXPORT MlineOffsetMode GetOffsetMode ( ElementHandleCR  source) const

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

Parameters
[in]sourcemultiline element
Returns
multiline offset mode
DGNPLATFORM_EXPORT double GetOriginAngle ( ElementHandleCR  source) const

Get the origin or start cap angle for the multiline.

Parameters
[in]sourcesource element
Returns
The angle in radians

Query the symbology of the multiline origin cap.

Parameters
[in]sourcesource element
Returns
A copy of the cap symbology
DGNPLATFORM_EXPORT double GetPlacementOffset ( ElementHandleCR  source) const

Get the Offset Distance stored on the multi-line element.

Note that this is only valid for a Offset Mode of MlineOffsetMode::Custom.

Parameters
[in]sourcemultiline element
Returns
multiline offset distance
DGNPLATFORM_EXPORT MultilinePointPtr GetPoint ( ElementHandleCR  source,
UInt32  pointNumber 
) const

Get a pointer to the first MlinePoint definition.

Parameters
[in]sourcesource element
[in]pointNumberpoint index to return
Returns
A pointer to the first MlinePoint definition
DGNPLATFORM_EXPORT UInt32 GetPointCount ( ElementHandleCR  source) const

Query the number of points in the multiline element.

Parameters
[in]sourcesource element
Returns
multiline point count
DGNPLATFORM_EXPORT MultilineProfilePtr GetProfile ( ElementHandleCR  source,
int  index 
) const

Query a profile line definition.

The profile definition defines the offset from the base profile line as well as the symbology of the profile line.

Parameters
[in]sourcesource element
[in]indexnumber of profile line to extract
Returns
A pointer to the MlineProfile definition.
DGNPLATFORM_EXPORT UInt32 GetProfileCount ( ElementHandleCR  source) const

Query the number of profile lines in the multiline element.

Parameters
[in]sourcesource element
Returns
multiline profile count
DGNPLATFORM_EXPORT MultilineStylePtr GetStyle ( ElementHandleCR  source,
MultilineStyleCP  seedStyle,
UInt32  options 
) const

Get an object representing the style of a multiline element.

In general, the properties of the returned style object may differ from the file's version of the same style.

Parameters
[in]sourcemultiline element
[in]seedStylemultiline style to use as a seed. This is copied into the new style, and then all salient properties from the multi-line are applied on top. For example if the multi-line doesn't use a color for profile 1 but there is a color in the seed style, then that color will appear in the resulting style.
[in]optionsmultiline style options - currently 0 or MLINE_MATCH_ENDCAPS.
Returns
multiline style
DGNPLATFORM_EXPORT double GetStyleScale ( ElementHandleCR  source) const

Get the style scale stored on the multi-line element.

Parameters
[in]sourcemultiline element
Returns
multiline style scale
DGNPLATFORM_EXPORT bool IsClosed ( ElementHandleCR  source) const

Query if the multiline element represents a closed path.

Parameters
[in]sourcesource element
Returns
true for a closed multiline

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

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