API_​DimensionType

Describes a (linear) dimension.

    typedef struct {
        API_Elem_Head                      head;
        short                              linPen;
        short                              filler_1;
        API_TextPosID                      textPos;
        API_DirID                          textWay;
        API_AppearID                       dimAppear;
        bool                               detailedHoleDim;
        char                               nominalHoleDim;
        char                               compAutoThick;
        bool                               defStaticDim;
        API_WitnessID                      defWitnessForm;
        double                             defWitnessVal;
        API_NoteType                       defNote;
        API_MarkerData                     markerData;
        char                               ed_dimForm;
        char                               ed_arrowAng;
        bool                               ed_arrowFill;
        bool                               ed_arrowUp;
        bool                               ed_needPlus;
        bool                               usedIn3D;
        bool                               horizontalText;
        bool                               onlyDimensionText;
        API_DimOriginID                    ed_origin;
        API_CircleLevelDimensionFillID     ed_circleLevelDimensionFill;
        Int32                              filler_4[4];
        API_Coord                          refC;
        API_Vector                         direction;
        API_DimBase                        arcBase;
        Int32                              nDimElem;
        Int32                              filler_5;
        API_Coord3D                        refC3D;
        API_Vector3D                       direction3D;
        API_Vector3D                       normVect3D;
        API_DimLayoutID                    dimLayout;
        bool                               pushNeighborEnabled;
        bool                               placeUnderEnabled;
        bool                               advanced;
        bool                               clipOtherSide;
        Int32                              filler_6[6];
    } API_DimensionType;

 

Members

head
General element header.
linPen
Pen attribute index of dimension and witness lines.
textPos
Dimension text position (see API_TextPosID).
textWay
The position of the text relative to the dimension line (see API_DirID). The possible values are: APIDir_Parallel, APIDir_Horizontal, APIDir_Vertical, APIDir_ArcDim.
dimAppear
Appearance of the dimension (see API_AppearID).
detailedHoleDim
Detailed door/window dimension.
nominalHoleDim
Nominal height for door/window dimension.
compAutoThick Modified in API 21
Dimension type bits of composite walls.
Composite thickness
defStaticDim
Static dimension (default)?
defWitnessForm
Default witness line format (see API_WitnessID).
defWitnessVal
Default gap (APIWtn_Fix) or length (APIWtn_Large) of witness line according to defWitnessForm.
defNote
Default note parameters (see API_NoteType).
markerData
Marker specification (see API_MarkerData).
ed_dimForm
Elevation dimension marker type.
ed_arrowAng
Elevation dimension half-arrow angle:
0

30 degrees

1

45 degrees

2

60 degrees

ed_arrowFill
Elevation dimension arrow is filled or not.
ed_arrowUp
Elevation dimension arrow is up/down.
ed_needPlus
Elevation dimension plus sign needed for positive numbers.
usedIn3D Changed in API 12
Used for dimensioning 3D points.
horizontalText Changed in API 12
Dimension texts are horizontal.
onlyDimensionText New in API 20
Only dimension texts (notes) are visible — no leader line.
ed_origin
Elevation dimension origin./
ed_circleLevelDimensionFill New in API 22
Elevation dimension: the circle style marker fill.
refC
Dimension line location.
direction
Direction of the dimension line if parallel.
arcBase
Neig & unique ID of the base element for an arc dimension chain.
nDimElem
Number of segments in dimension elements’ chain (see API_ElementMemo)
refC3D Changed in API 12
Position of the dimension chain (used only in 3D).
direction3D Changed in API 12
Direction of the dimension line (used only in 3D).
normVect3D Changed in API 12
Dimension plane’s normal vector (used only in 3D).
dimLayout 19
Layouting algorithm used by the dimension.
pushNeighborEnabled 19
Enable a note to push its neighbours (In case of API_Flexible layouting algorithm).
placeUnderEnabled 19
Try to place a note under the dimension line (In case of API_Flexible layouting algorithm).
advanced 19
Use advanced logic (In case of API_Centered layouting algorithm).
clipOtherSide 19
No witness line part on the other side (opposite to basepoint).

 

Remarks

For dimension related memo data see the ACAPI_Element_GetMemo function.

 

Requirements

Version: API 4.1 or later
Header: APIdefs_Elements.h

 

See Also

API_Elem_Head, API_TextPosID, API_DirID, API_AppearID, API_WitnessID, API_NoteType, API_MarkerData, API_Coord, API_Vector, API_Coord3D, API_Vector3D, API_Neig, API_Element,
API_DimElem, API_DimBase, API_ElementMemo,
Element Manager, API Types