Public Member Functions | List of all members
IDimensionEdit Struct Referenceabstract

Modify and Query dimension specific properties of an element. More...

#include <DimensionHandler.h>

Inheritance diagram for IDimensionEdit:
IDimensionQuery DimensionHandler

Public Member Functions

DGNPLATFORM_EXPORT void ApplyDimensionStyle (EditElementHandleR eeh, DimensionStyleCR dimStyle, bool retainOverrides)
 Modify the properties of a dimension element to conform to the provided dimension style object. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetPoint (EditElementHandleR eeh, DPoint3dCP point, AssocPoint const *assocPt, int iPoint)
 Insert a new point into a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus InsertPoint (EditElementHandleR eeh, DPoint3dCP point, AssocPoint const *assocPt, DimensionStyleCR dimStyle, int iPoint)
 Insert a new point into a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetHeight (EditElementHandleR eeh, double height)
 Modify the height of a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetJustification (EditElementHandleR eeh, int segmentNo, DimStyleProp_Text_Justification just)
 Modify the justification of a segment in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetWitnessVisibility (EditElementHandleR eeh, int pointNo, bool value)
 Modify the visibility of a witness line in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetWitnessUseAltSymbology (EditElementHandleR eh, int pointNo, bool value)
 Modify whether the witness line uses an alternate symbology. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetRotationMatrix (EditElementHandleR eeh, RotMatrixCR rmatrix)
 Modify the rotation matrix of a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus DeletePoint (EditElementHandleR dim, int pointNo)
 Deletes the vertex at pointNo from a dimension element. More...
 
DGNPLATFORM_EXPORT
DgnHandlersStatus 
SetProxyCell (EditElementHandleR dimElement, DgnPlatform::ElementId const &proxyCellId, DPoint3dCR origin, RotMatrixCR rotMatrix)
 Set the proxy cell element used in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetTextOffset (EditElementHandleR dimElement, int segmentNo, DPoint2dCR offset)
 Set text offset in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetViewRotation (EditElementHandleR dimElement, RotMatrixCR rMatrix)
 Set view rotation stored in a dimension element. More...
 
DGNPLATFORM_EXPORT void SetAngularDimensionClockWiseSweep (EditElementHandleR dimElement, bool value)
 Set the clockwise sweep flag stored in an angular dimension. More...
 
DGNPLATFORM_EXPORT BentleyStatus SetPointsForLabelLine (EditElementHandleR eeh, DSegment3dCP segment, HitPathP hitPath, double offset, RotMatrixCR viewRMatrix, DimensionStyleCR dimStyle)
 Insert a new point into a dimension element. More...
 
- Public Member Functions inherited from IDimensionQuery
DGNPLATFORM_EXPORT DimensionType GetDimensionType (ElementHandleCR eh) const
 Query the type of a dimension element. More...
 
DGNPLATFORM_EXPORT
DimensionStylePtr 
GetDimensionStyle (ElementHandleCR eh) const
 Get an object representing the style of a dimension element. More...
 
DGNPLATFORM_EXPORT
DimStylePropMaskPtr 
GetOverrideFlags (ElementHandleCR eh) const
 Query the local overrides from the dimension's style. More...
 
DGNPLATFORM_EXPORT int GetNumPoints (ElementHandleCR eh) const
 Query the number of points in dimension element. More...
 
DGNPLATFORM_EXPORT int GetNumSegments (ElementHandleCR eh) const
 Query the number of segements present in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus ExtractPoint (ElementHandleCR eh, DPoint3dR point, int iPoint) const
 Query a point from a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetHeight (ElementHandleCR eh, double &height) const
 Query the height of a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetJustification (ElementHandleCR eh, int segmentNo, DimStyleProp_Text_Justification &just) const
 Query the justification of a text in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetWitnessVisibility (ElementHandleCR eh, int pointNo, bool &value) const
 Query the visibility of a witness line in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetWitnessUseAltSymbology (ElementHandleCR eh, int pointNo, bool &value) const
 Query whether the witness line uses an alternate symbology. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetRotationMatrix (ElementHandleCR eh, RotMatrixR rmatrix) const
 Query for the rotation matrix of a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetProxyCell (ElementHandleCR dimElement, DgnPlatform::ElementId &proxyCellId, DPoint3dP origin, RotMatrixP rotMatrix) const
 Query for existence of a proxy cell element used in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetTextOffset (ElementHandleCR dimElement, int segmentNo, DPoint2dR offset) const
 Query for the text offset in a dimension element. More...
 
DGNPLATFORM_EXPORT BentleyStatus GetViewRotation (ElementHandleCR dimElement, RotMatrixR rmatrix) const
 Query for the view rotation stored in a dimension element. More...
 
DGNPLATFORM_EXPORT bool GetAngularDimensionClockWiseSweep (ElementHandleCR dimElement) const
 Get the clockwise sweep flag stored in an angular dimension. More...
 

Detailed Description

Modify and Query dimension specific properties of an element.

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

Member Function Documentation

DGNPLATFORM_EXPORT void ApplyDimensionStyle ( EditElementHandleR  eeh,
DimensionStyleCR  dimStyle,
bool  retainOverrides 
)

Modify the properties of a dimension element to conform to the provided dimension style object.

To remove overrides, get the dimension style using DimensionStyle::GetByName and pass false for retainOverrides. To add new overrides, get the dimension style using IDimensionQuery::GetDimensionStyle and pass true for retain overrides.

Parameters
eehINOUT dimension element
dimStyleIN dimension style
retainOverridesIN if false, all existing overrides are cleared from the dimension.
Returns
SUCCESS or ERROR
DGNPLATFORM_EXPORT BentleyStatus DeletePoint ( EditElementHandleR  dim,
int  pointNo 
)

Deletes the vertex at pointNo from a dimension element.

Parameters
dimIN OUT Dimension element
pointNoIN Point to delete
Returns
SUCCESS if the point is deleted
DGNPLATFORM_EXPORT BentleyStatus InsertPoint ( EditElementHandleR  eeh,
DPoint3dCP  point,
AssocPoint const *  assocPt,
DimensionStyleCR  dimStyle,
int  iPoint 
)

Insert a new point into a dimension element.

Parameters
eehINOUT dimension element
pointIN point coordinates
assocPtIN if assocPt is provided then point is optional
dimStyleIN the style is used specify point specific properties like extension line visibility and justification
iPointIN insertion index, pass -1 to append at the end
Returns
SUCCESS if the point was successfully inserted.
DGNPLATFORM_EXPORT void SetAngularDimensionClockWiseSweep ( EditElementHandleR  dimElement,
bool  value 
)

Set the clockwise sweep flag stored in an angular dimension.

Parameters
dimElementIN dimension element
valueIN value to set
DGNPLATFORM_EXPORT BentleyStatus SetHeight ( EditElementHandleR  eeh,
double  height 
)

Modify the height of a dimension element.

The height is the distance along the extension line from the first measurement point to the dimension line. All dimensions must contain at least one point in order for the height to be stored, however angular dimensions require at least two points.

Parameters
eehINOUT dimension element
heightOUT the height
Returns
SUCCESS if the height could be changed
DGNPLATFORM_EXPORT BentleyStatus SetJustification ( EditElementHandleR  eeh,
int  segmentNo,
DimStyleProp_Text_Justification  just 
)

Modify the justification of a segment in a dimension element.

Parameters
eehINOUT dimension element
segmentNoIN segment Number
justIN the justification
Returns
SUCCESS if the justification was set.
DGNPLATFORM_EXPORT BentleyStatus SetPoint ( EditElementHandleR  eeh,
DPoint3dCP  point,
AssocPoint const *  assocPt,
int  iPoint 
)

Insert a new point into a dimension element.

Parameters
eehINOUT dimension element
pointIN point coordinates
assocPtIN if assocPt is provided then point is optional
iPointIN point index
Returns
SUCCESS if the point was successfully changed.
DGNPLATFORM_EXPORT BentleyStatus SetPointsForLabelLine ( EditElementHandleR  eeh,
DSegment3dCP  segment,
HitPathP  hitPath,
double  offset,
RotMatrixCR  viewRMatrix,
DimensionStyleCR  dimStyle 
)

Insert a new point into a dimension element.

Parameters
eehINOUT dimension element
segmentIN Segment points. Optional if hitPath is non-NULL.
hitPathIN Used to create an association on the dimension. Only provide if you will be calling AddToModel.
offsetIN Distance along the line at which to position the label.
viewRMatrixIN View orientation
dimStyleIN Used to specify point specific properties like extension line visibility and justification.
Returns
SUCCESS if the points were successfully set.
DGNPLATFORM_EXPORT DgnHandlersStatus SetProxyCell ( EditElementHandleR  dimElement,
DgnPlatform::ElementId const &  proxyCellId,
DPoint3dCR  origin,
RotMatrixCR  rotMatrix 
)

Set the proxy cell element used in a dimension element.

Parameters
dimElementIN dimension element
rotMatrixIN rotation of the cell element.
proxyCellIdIN element ID of the cell element.
originIN origin of the cell element.
Returns
SUCCESS if the proxy cell was set.
DGNPLATFORM_EXPORT BentleyStatus SetRotationMatrix ( EditElementHandleR  eeh,
RotMatrixCR  rmatrix 
)

Modify the rotation matrix of a dimension element.

Parameters
eehIN dimension element
rmatrixIN orientation of the dimension elemnent.
Returns
SUCCESS if the rotation matrix was extracted.
DGNPLATFORM_EXPORT BentleyStatus SetTextOffset ( EditElementHandleR  dimElement,
int  segmentNo,
DPoint2dCR  offset 
)

Set text offset in a dimension element.

Parameters
dimElementIN dimension element
segmentNoIN segment Number element
offsetIN offset values
DGNPLATFORM_EXPORT BentleyStatus SetViewRotation ( EditElementHandleR  dimElement,
RotMatrixCR  rMatrix 
)

Set view rotation stored in a dimension element.

Parameters
dimElementIN dimension element
rMatrixIN view rotation of the dimension element.
DGNPLATFORM_EXPORT BentleyStatus SetWitnessUseAltSymbology ( EditElementHandleR  eh,
int  pointNo,
bool  value 
)

Modify whether the witness line uses an alternate symbology.

Parameters
ehINOUT dimension element
pointNoIN point Number.
valueIN bool use alt symbology on or off.
Returns
SUCCESS if the flag value can be determined.
DGNPLATFORM_EXPORT BentleyStatus SetWitnessVisibility ( EditElementHandleR  eeh,
int  pointNo,
bool  value 
)

Modify the visibility of a witness line in a dimension element.

Parameters
eehINOUT dimension element
pointNoIN point Number.
valueIN bool visibilty on or off.
Returns
SUCCESS if the witness line visibility was changed.

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

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