Public Member Functions | List of all members
IDimensionQuery Struct Referenceabstract

Query an element for dimension specific properties. More...

#include <DimensionHandler.h>

Inheritance diagram for IDimensionQuery:
IDimensionEdit DimensionHandler

Public Member Functions

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

Query an element for dimension specific properties.

In order to query the properties of a dimension, get the dimensionstyle object representing the element using the function IDimensionQuery::GetDimensionStyle. Then query the required values using DimensionStyle API.

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

Member Function Documentation

DGNPLATFORM_EXPORT BentleyStatus ExtractPoint ( ElementHandleCR  eh,
DPoint3dR  point,
int  iPoint 
) const

Query a point from a dimension element.

Parameters
ehIN dimension element
pointOUT the coordinates of the requested point
iPointIN index of requested point
Returns
SUCCESS if the point was extracted
DGNPLATFORM_EXPORT bool GetAngularDimensionClockWiseSweep ( ElementHandleCR  dimElement) const

Get the clockwise sweep flag stored in an angular dimension.

Parameters
dimElementIN dimension element
DGNPLATFORM_EXPORT DimensionStylePtr GetDimensionStyle ( ElementHandleCR  eh) const

Get an object representing the style of a dimension element.

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

Parameters
ehIN dimension element
Returns
dimension style
DGNPLATFORM_EXPORT DimensionType GetDimensionType ( ElementHandleCR  eh) const

Query the type of a dimension element.

Parameters
ehIN dimension element
Returns
dimension type enum
DGNPLATFORM_EXPORT BentleyStatus GetHeight ( ElementHandleCR  eh,
double &  height 
) const

Query 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
ehIN dimension element
heightOUT the height
Returns
SUCCESS if the height was extracted
DGNPLATFORM_EXPORT BentleyStatus GetJustification ( ElementHandleCR  eh,
int  segmentNo,
DimStyleProp_Text_Justification just 
) const

Query the justification of a text in a dimension element.

All dimensions must contain at least two points for the justification values to be valid.

Parameters
ehIN dimension element
segmentNoIN segment to be queried
justOUT the justification
Returns
SUCCESS if the justification was extracted.
DGNPLATFORM_EXPORT int GetNumPoints ( ElementHandleCR  eh) const

Query the number of points in dimension element.

Parameters
ehIN dimension element
Returns
dimension point count
DGNPLATFORM_EXPORT int GetNumSegments ( ElementHandleCR  eh) const

Query the number of segements present in a dimension element.

Parameters
ehIN dimension element
Returns
dimension segment count
DGNPLATFORM_EXPORT DimStylePropMaskPtr GetOverrideFlags ( ElementHandleCR  eh) const

Query the local overrides from the dimension's style.

If a bit in the returned mask is OFF, then that property is controlled by the dimension's style, so that if the style changes, that change will be propagated to the dimension. If a bit is ON, then the property is locally controlled by the dimension, and the property will not be effected by style changes.

Parameters
ehIN dimension element
Returns
dimension style
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.

Parameters
dimElementIN dimension element
rotMatrixOUT rotation of the cell element.
proxyCellIdOUT Proxy cell element id.
originOUT Origin of the cell element.
Returns
SUCCESS if the proxy cell was found.
DGNPLATFORM_EXPORT BentleyStatus GetRotationMatrix ( ElementHandleCR  eh,
RotMatrixR  rmatrix 
) const

Query for the rotation matrix of a dimension element.

Parameters
ehIN dimension element
rmatrixOUT rotation of the dimension elemnent.
Returns
SUCCESS if the rotation matrix was extracted.
DGNPLATFORM_EXPORT BentleyStatus GetTextOffset ( ElementHandleCR  dimElement,
int  segmentNo,
DPoint2dR  offset 
) const

Query for the text offset in a dimension element.

Parameters
dimElementIN dimension element
segmentNoIN segment Number element
offsetOUT offset values
DGNPLATFORM_EXPORT BentleyStatus GetViewRotation ( ElementHandleCR  dimElement,
RotMatrixR  rmatrix 
) const

Query for the view rotation stored in a dimension element.

Parameters
dimElementIN dimension element
rmatrixOUT view rotation of the dimension element.
DGNPLATFORM_EXPORT BentleyStatus GetWitnessUseAltSymbology ( ElementHandleCR  eh,
int  pointNo,
bool &  value 
) const

Query whether the witness line uses an alternate symbology.

Parameters
ehIN dimension element
pointNoIN point Number.
valueOUT bool use alt symbology on or off.
Returns
SUCCESS if the flag value can be determined.
DGNPLATFORM_EXPORT BentleyStatus GetWitnessVisibility ( ElementHandleCR  eh,
int  pointNo,
bool &  value 
) const

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

Parameters
ehIN dimension element
pointNoIN point Number.
valueOUT bool visibilty on or off.
Returns
SUCCESS if the witness line visibility was found.

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

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