DgnElements.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include    <Bentley/Bentley.h>
#include    <DgnPlatform/DgnPlatform.h>
#include    <DgnPlatform/DgnPlatformErrors.r.h>
// #include    <DgnPlatform/IAuxCoordSys.h>
#include    <Bentley/CodePages.h>

DGNPLATFORM_TYPEDEFS (AttributeElm)
DGNPLATFORM_TYPEDEFS (ViewElement)
DGNPLATFORM_TYPEDEFS (SharedCell)
DGNPLATFORM_TYPEDEFS (SharedCellDef)
DGNPLATFORM_TYPEDEFS (LevelMaskElm)
DGNPLATFORM_TYPEDEFS (Elm_hdr)

typedef char            VariChar;             // CHAR_OK
typedef VariChar const* VariCharCP;
typedef VariChar*       VariCharP;

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct MicroStationAppIdRootsCallback;

/*----------------------------------------------------------------------+
|                                                                       |
|  Element Type Masks - Can be used to set up type masks for scanner    |
|                       or element modification commands                |
|                                                                       |
+----------------------------------------------------------------------*/
// The following masks must be 'OR'ed with typemask[0]
#define ELMBITMSK(elmNum)       (1<<((elmNum-1)%16))
#define TMSK0_CELL_LIB          ELMBITMSK (CELL_LIB_ELM)
#define TMSK0_CELL_HEADER       ELMBITMSK (CELL_HEADER_ELM)
#define TMSK0_LINE              ELMBITMSK (LINE_ELM)
#define TMSK0_LINE_STRING       ELMBITMSK (LINE_STRING_ELM)
#define TMSK0_GROUP_DATA        ELMBITMSK (GROUP_DATA_ELM)
#define TMSK0_SHAPE             ELMBITMSK (SHAPE_ELM)
#define TMSK0_TEXT_NODE         ELMBITMSK (TEXT_NODE_ELM)
#define TMSK0_DIG_SETDATA       ELMBITMSK (DIG_SETDATA_ELM)
#define TMSK0_DGNFIL_HEADER     ELMBITMSK (DGNFIL_HEADER_ELM)
#define TMSK0_LEV_SYM           ELMBITMSK (LEV_SYM_ELM)
#define TMSK0_CURVE             ELMBITMSK (CURVE_ELM)
#define TMSK0_CMPLX_STRING      ELMBITMSK (CMPLX_STRING_ELM)
#define TMSK0_CONIC             ELMBITMSK (CONIC_ELM)
#define TMSK0_CMPLX_SHAPE       ELMBITMSK (CMPLX_SHAPE_ELM)
#define TMSK0_ELLIPSE           ELMBITMSK (ELLIPSE_ELM)
#define TMSK0_ARC               ELMBITMSK (ARC_ELM)

// These following masks must be 'OR'ed with typemask[1] 
#define TMSK1_TEXT              ELMBITMSK (TEXT_ELM)
#define TMSK1_SURFACE           ELMBITMSK (SURFACE_ELM)
#define TMSK1_SOLID             ELMBITMSK (SOLID_ELM)
#define TMSK1_BSPLINE_POLE      ELMBITMSK (BSPLINE_POLE_ELM)
#define TMSK1_POINT_STRING      ELMBITMSK (POINT_STRING_ELM)
#define TMSK1_CONE              ELMBITMSK (CONE_ELM)
#define TMSK1_BSPLINE_SURFACE   ELMBITMSK (BSPLINE_SURFACE_ELM)
#define TMSK1_BSURF_BOUNDARY    ELMBITMSK (BSURF_BOUNDARY_ELM)
#define TMSK1_BSPLINE_KNOT      ELMBITMSK (BSPLINE_KNOT_ELM)
#define TMSK1_BSPLINE_CURVE     ELMBITMSK (BSPLINE_CURVE_ELM)
#define TMSK1_BSPLINE_WEIGHT    ELMBITMSK (BSPLINE_WEIGHT_ELM)

// These following masks must be 'OR'ed with typemask[2] 
#define TMSK2_DIMENSION         ELMBITMSK (DIMENSION_ELM)
#define TMSK2_SHAREDCELL_DEF    ELMBITMSK (SHAREDCELL_DEF_ELM)
#define TMSK2_SHARED_CELL       ELMBITMSK (SHARED_CELL_ELM)
#define TMSK2_MULTILINE         ELMBITMSK (MULTILINE_ELM)
#define TMSK2_ATTRIBUTE         ELMBITMSK (ATTRIBUTE_ELM)
#define TMSK2_TYPE44            ELMBITMSK (TYPE44_ELM)
#define TMSK2_DGNSTORE_HDR      ELMBITMSK (DGNSTORE_HDR)

// These following masks must be 'OR'ed with typemask[4] 
#define TMSK4_MICROSTATION_ELM  ELMBITMSK (MICROSTATION_ELM)

// These following masks must be 'OR'ed with typemask[5] 
#define TMSK5_RASTER_HDR            ELMBITMSK (RASTER_HDR)
#define TMSK5_RASTER_COMP           ELMBITMSK (RASTER_COMP)
#define TMSK5_RASTER_LINK           ELMBITMSK (RASTER_REFERENCE_ELM)
#define TMSK5_RASTER_REFCMPN        ELMBITMSK (RASTER_REFERENCE_COMP)
#define TMSK5_RASTER_HIERARCHY      ELMBITMSK (RASTER_HIERARCHY_ELM)
#define TMSK5_RASTER_HIERARCHYCMPN  ELMBITMSK (RASTER_HIERARCHY_COMP)
#define TMSK5_RASTER_FRAME          ELMBITMSK (RASTER_FRAME_ELM)
#define TMSK5_TABLE_ENTRY           ELMBITMSK (TABLE_ENTRY_ELM)
#define TMSK5_TABLE                 ELMBITMSK (TABLE_ELM)

// These following masks must be 'OR'ed with typemask[6] 
#define TMSK6_MATRIX_HEADER             ELMBITMSK (MATRIX_HEADER_ELM)
#define TMSK6_MATRIX_INT_DATA           ELMBITMSK (MATRIX_INT_DATA_ELM)
#define TMSK6_MATRIX_DOUBLE_DATA        ELMBITMSK (MATRIX_DOUBLE_DATA_ELM)
#define TMSK6_MESH_HEADER               ELMBITMSK (MESH_HEADER_ELM)
#define TMSK6_EXTENDED                  ELMBITMSK (EXTENDED_ELM)
#define TMSK6_EXTENDED_NONGRAPHIC_ELM   ELMBITMSK (EXTENDED_NONGRAPHIC_ELM)
#define TMSK6_VIEW_GROUP                ELMBITMSK (VIEW_GROUP_ELM)
#define TMSK6_VIEW                      ELMBITMSK (VIEW_ELM)
#define TMSK6_LEVEL_MASK                ELMBITMSK (LEVEL_MASK_ELM)
#define TMSK6_REFERENCE_ATTACH          ELMBITMSK (REFERENCE_ATTACH_ELM)
#define TMSK6_NAMED_GROUP_HDR           ELMBITMSK (NAMED_GROUP_HDR_ELM)
#define TMSK6_DGNCOMPONENT_INSTANCE     ELMBITMSK (DGNCOMPONENT_INSTANCE_ELM)

/*----------------------------------------------------------------------+
|                                                                       |
|  Element Processing Status codes -- Can be used to control            |
|   selective tree traversals.                                          |
|                                                                       |
+----------------------------------------------------------------------*/
#define MDLELMDSCR_OPERATION_SKIP_MY_CHILDREN (-10)
/*----------------------------------------------------------------------+
|                                                                       |
|       Level definitions                                               |
|                                                                       |
+----------------------------------------------------------------------*/
#define     MSSTARTAPP_LEVEL            10

#define     MSXBASE_LEVEL               10      // Xbase
#define     MSDB_LEVEL                  10      // exists for backwards compatibility to XBASE
#define     MSIX_LEVEL                  11      // Informix
#define     MSRIS_LEVEL                 12      // RIS     
#define     MSORACLE_LEVEL              13      // Oracle  
#define     MSINGRES_LEVEL              14      // INGRES  
#define     MSSYBASE_LEVEL              15      // Sybase  
#define     MSODBC_LEVEL                16      // ODBC    
#define     MSCTMORCL_LEVEL             17      // Continuum Oracle
#define     MSOLEDB_LEVEL               18      // OLEDB
#define     MSBUDBC_LEVEL               19      // Bentley Universal Database Connection

#define     MSAPPINFO_LEVEL             20
#define     MSSTARTMDL_LEVEL            21
#define     MSATTRDATA_LEVEL            24
#define     MSTCBEXT_LEVEL              25
#define     MSMAP_LEVEL                 26
#define     MSBREP_LEVEL                28
#define     MSPROJECTBANK_LEVEL         29
#define     MSMODELELEMENT_LEVEL        32
#define     MSUPDATESEQUENCE_LEVEL      33

#define     MS_LEVEL_TABLE_LEVEL                                1
#define     MS_FONT_TABLE_LEVEL                                 2
#define     MS_TEXTSTYLE_TABLE_LEVEL                            3
#define     MS_FILTER_TABLE_LEVEL                               4
#define     MS_DIMSTYLE_TABLE_LEVEL                             5
#define     MS_MLINESTYLE_TABLE_LEVEL                           6
#define     MS_LSTYLE_NAME_LEVEL                                7
#define     MS_LSTYLE_DEF_LEVEL                                 8
#define     MS_DICTIONARY_TABLE_LEVEL                           9
#define     MS_REGAPP_TABLE_LEVEL                               10
#define     MS_COLORBOOK_TABLE_LEVEL                            11
#define     MS_CUSTOM_RENDERMODE_LEVEL                          12   // Deprecated (never used in production).
#define     MS_SYMBOLSTYLE_TABLE_LEVEL                          16
#define     MS_COLORBOOK_LEVEL                                  17
#define     MS_MATERIAL_PALETTE_LEVEL                           18
#define     MS_LEVEL_NAME_DICTIONARY_TABLE_LEVEL                19
#define     MS_ANIMATION_PARAMETER_TABLE_LEVEL                  20
#define     MS_ANIMATION_SCHEDULEINFO_TABLE_LEVEL               21
#define     MS_RENDERSETUP_LEVEL                                22
#define     MS_LIGHTSETUP_LEVEL                                 23
#define         MS_NAMED_PRESENTATION_TABLE_LEVEL                                       24
#define     MS_MAX_VALID_TABLE_LEVEL                            MS_NAMED_PRESENTATION_TABLE_LEVEL
#define     MS_NUM_VALID_TABLE_LEVELS                           (MS_MAX_VALID_TABLE_LEVEL+1)


#define     VIEW_GROUP_HDR_LEVEL            1

#define     VIEW_HDR_LEVEL                  1

/*----------------------------------------------------------------------+
|                                                                       |
|       MicroStation Application Element Signatures                     |
|                                                                       |
+----------------------------------------------------------------------*/
#define     MSEXACTCOLOR_SIGNATURE              140
#define     MSDIGITAL_SIGNATURE                 22145
#define     MSMODELER_SIGNATURE                 20286
#define     MSIMAGEMANAGER_SIGNATURE            22082
#define     MSFARREFELM_SIGNATURE               22246
#define     MSDESIGNLINKS_SIGNATURE             22594
#define     MSCONFLICTS_SIGNATURE               22275
#define     MSAPPLICATIONSETTINGS_SIGNATURE     22276
#define     MSRELATIONSHIPS_SIGNATURE           22277
#define     MSGEOCOORD_SIGNATURE                182     // 0x00b6

/*----------------------------------------------------------------------+
|                                                                       |
|       Raster Element (Type 87) Data Types                             |
|                                                                       |
+----------------------------------------------------------------------*/
enum    MSRasterElemTypes
{
    BITMAP_RASTER               = 1,
    BYTE_DATA_RASTER            = 2,
    BINARY_RLE_RASTER           = 9,
    BYTE_RLE_RASTER             = 24,
};

/*----------------------------------------------------------------------+
|                                                                       |
|   Surface/Solid Types                                                 |
|                                                                       |
+----------------------------------------------------------------------*/
#define SURFTYPE_PROJECTION             0
#define SURFTYPE_REVOLUTION             8
#define SOLIDTYPE_REVOLUTION            1

/*----------------------------------------------------------------------+
|                                                                       |
|       Bspline Flags definitions                                       |
|                                                                       |
+----------------------------------------------------------------------*/
#define     BSPLINE_CONSTRUCTION_POLE                   0
#define     BSPLINE_CONSTRUCTION_INTERPOLATION          1
#define     BSPLINE_CONSTRUCTION_LEASTSQUARE            2

/*----------------------------------------------------------------------+
|                                                                       |
|       Elm_hdr archive flags                                           |
|                                                                       |
+----------------------------------------------------------------------*/
#define     ELM_HDR_ARCHIVE_NEW                         2
#define     ELM_HDR_ARCHIVE_MODIFIED                    1

#if !defined (__midl) // During MIDL compile, all we care about are the values of the #define constants. 

/*----------------------------------------------------------------------+
|                                                                       |
|   Linkage Header - Same for all element user data                     |
|                                                                       |
|   Use LinkageUtil::GetWords/setWords to get/set linkage size.           |
|                                                                       |
+----------------------------------------------------------------------*/
struct LinkageHeader
{
    UInt16      wdMantissa:8;           // mantissa words: wtf if wdExponent=0 
    UInt16      wdExponent:4;           // exponent for words multiplier       
    UInt16      user:1;                 // boolean: user data linkage          
    UInt16      modified:1;             // boolean: user linkage modified      
    UInt16      remote:1;               // boolean: remote linkage             
    UInt16      info:1;                 // boolean: informational linkage      
    UInt16      primaryID;              // User ID number                      
};

/*----------------------------------------------------------------------+
|                                                                       |
|   Element Header structure - common to all MicroStation elements      |
|                                                                       |
+----------------------------------------------------------------------*/
struct Elm_hdr
{
    UInt16          type;               // element type 
    UInt16          reserved:6;         // reserved for future flags - always 0 
    UInt16          archive:2;          // modified or added and not yet committed to history 
    UInt16          obsolete__:1;       // was 'conflict' 
    UInt16          obsolete_2:1;       // was deleted complex by header 
    UInt16          nonModel:1;         // true if this element is file-specific and does not belong in any model 
    UInt16          locked:1;           // element is locked 
    UInt16          isGraphics:1;       // element is a graphics element, has Dsp_hdr 
    UInt16          isComplexHeader:1;  // is a complex header, must have number of elements following its header 
    UInt16          complex:1;          // this element is part of a complex element 
    UInt16          deleted:1;          // this element is deleted 
    UInt32          elementSize;        // number of words in element 
    UInt32          attrOffset;         // offset (in words) from start of element to attributes 
    LevelId         level;              // element level 
    T_AUInt64       uniqueId;           // unique ID of element 
    T_Adouble       lastModified;       // last time this element was changed 
};

/*----------------------------------------------------------------------+
|                                                                       |
|   Element properties word                                             |
|                                                                       |
+----------------------------------------------------------------------*/
struct DispHdrProperties
    {
    UInt16          elementClass:4;     // element class 
    UInt16          reserved:1;         // reserved, do not use 
    UInt16          unused2:1;          // do not use 
    UInt16          unused3:1;          // do not use 
    UInt16          invisible:1;        // element is not displayed 
    UInt16          dynamicRange:1;     // element does not have a stable range
    UInt16          n:1;                // new
    UInt16          m:1;                // modified 
    UInt16          is3d:1;             // element is 3d 
    UInt16          r:1;                // relative to: 0=database 1=screen 
    UInt16          p:1;                // planar 
    UInt16          s:1;                // 0=snappable, 1=nonsnappable 
    UInt16          h:1;                // hole or solid (usually) 
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Display header - Common to all displayed MicroStation elements.     |
|                                                                       |
|   NOTE: Check ehdr.isGraphics before accessing dhdr using             |
|         element.hdr.dhdr. If ehdr.isGraphics is not set               |
|         the element is a non-graphic type that does not               |
|         have a dhdr; i.e. it's data starts right after the ehdr.      |
|                                                                       |
+----------------------------------------------------------------------*/
struct Disp_hdr
    {
    UInt32          grphgrp;            // graphics group number 
    Int32           priority;           // element display priority 
    union
        {
        Int16       s;
        DispHdrProperties  b;
        } props;
    UInt16          reserved;
    Symbology       symb;
    ScanRange       range;
    };

struct Header
    {
    Elm_hdr         ehdr;
    Disp_hdr        dhdr;               // NOTE: dhdr is not valid unless ehdr.isGraphics is set 
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Cell Element (complex element, type 2)                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct cell_2d
    {
    Elm_hdr         ehdr;                           // element header 
    Disp_hdr        dhdr;                           // display header 
    UInt32          componentCount;                 // number of elements following header 
    UInt16          classMap;                       // class bit map 
    struct
        {
        UInt16      isAnnotation:1;                 // is annotation cell 
        UInt16      matchSourceAnnotationSize:1;    // true = when scaling, do not scale its annotations 
        UInt16      matchSourceDimValue:1;          // true = when scaling, do not scale its dimension values 
        UInt16      matchSourceMultilineOffset:1;   // true = when scaling, do not scale its multiline offsets 
        UInt16      reserved:12;                    // reserved 
        } flags;                                   
    DPoint2d        rnglow;                         // extent centered on origin, low 
    DPoint2d        rnghigh;                        // extent centered on origin, hi 
    T_Adouble       transform[2][2];                // transformation matrix 
    DPoint2d        origin;                         // cell origin 
    } Cell_2d;

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Cell Element (complex element, type 3)                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct cell_3d
    {
    Elm_hdr         ehdr;                           // element header 
    Disp_hdr        dhdr;                           // display header 
    UInt32          componentCount;                 // number of elements following header 
    UInt16          classMap;                       // class bit map 
    struct
        {
        UInt16      isAnnotation:1;                 // is annotation cell 
        UInt16      matchSourceAnnotationSize:1;    // true = when scaling, do not scale its annotations  
        UInt16      matchSourceDimValue:1;          // true = when scaling, do not scale its dimension values 
        UInt16      matchSourceMultilineOffset:1;   // true = when scaling, do not scale its multiline offsets 
        UInt16      reserved:12;                    // reserved 
        } flags;                                     
    DPoint3d        rnglow;                         // extent centerd on origin, lo 
    DPoint3d        rnghigh;                        // extent centered on origin, hi 
    T_Adouble       transform[3][3];                // transformation matrix 
    DPoint3d        origin;                         // cell origin
    } Cell_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Line Element (type 3)                                           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct line_2d
    {
    Elm_hdr         ehdr;               // element header
    Disp_hdr        dhdr;               // display header 
    DPoint2d        start;              // starting point 
    DPoint2d        end;                // ending point 
    } Line_2d;

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Line Element (type 3)                                           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct line_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    DPoint3d        start;              // starting point 
    DPoint3d        end;                // ending point 
    } Line_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Line String Element (type 4)                                    |
|                                                                       |
|   Same structure represents 2-D Shape Elements (type 6), 2-D Curve    |
|   Elements (type 11), and 2-D Conic Elements (type 13).  Shapes differ|
|   from line strings in that shape elements always start and end at    |
|   the same point.  Curve and conic elements use the first and last    |
|   vertices to establish the slope at the beginning and end.           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct line_string_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          numverts;           // number of vertices 
    UInt32          reserved;           // reserved 
    DPoint2d        vertice[1];         // points 
    } Line_String_2d;                    

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Line String Element (type 4)                                    |
|                                                                       |
|   See comments for 2-D Line String Element.                           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct line_string_3d
    {
    Elm_hdr         ehdr;               // element header
    Disp_hdr        dhdr;               // display header 
    UInt32          numverts;           // number of vertices 
    UInt32          reserved;           // reserved 
    DPoint3d        vertice[1];         // points 
    } Line_String_3d;                    


/*----------------------------------------------------------------------+
|                                                                       |
|   Color table element (type 5, level 1)                               |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct  colorTable
    {
    Elm_hdr         ehdr;               // element header 
    Int16           screen_flag;        // screen flag 
    byte            color_info[1];      // color table information 
    } ColorTable;                        

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Text Node Element (complex element, type 7)                     |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct text_node_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    UInt32          nodenumber;         // text node number 
    UInt32          font;               // text font used 
    UInt16          maxlngth;           // maximum length allowed 
    UInt16          just;               // justification type 
    T_Adouble       linespc;            // line spacing 
    T_Adouble       lngthmult;          // length multiplier 
    T_Adouble       hghtmult;           // height multiplier 
    T_Adouble       rotationAngle;      // rotation angle 
    DPoint2d        origin;             // origin 
    } Text_node_2d;

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Text Node Element (complex element, type 7)                     |
|                                                                       |
+----------------------------------------------------------------------*/
// Text Node Element (note: this is a complex element) 
typedef struct text_node_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    UInt32          nodenumber;         // text node number 
    UInt32          font;               // text font used 
    UInt16          maxlngth;           // maximum length allowed 
    UInt16          just;               // justification type 
    T_Adouble       linespc;            // line spacing 
    T_Adouble       lngthmult;          // length multiplier 
    T_Adouble       hghtmult;           // height multiplier 
    T_Adouble       quat[4];            // quaternion rotations 
    DPoint3d        origin;             // origin 
    } Text_node_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   Design file header (type 9)                                         |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct dgn_header
    {
    Elm_hdr         ehdr;               // element header 
    Int16           tcbinfo[1];         // tcb information 
    } Dgn_header;

/*----------------------------------------------------------------------+
|                                                                       |
|    Complex string (type 12, complex)                                  |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct complex_string
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    UInt32          reserved;           // reserved 
    } Complex_string;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Ellipse Element (type 15)                                       |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct ellipse_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    T_Adouble       primary;            // primary axis 
    T_Adouble       secondary;          // secondary axis 
    T_Adouble       rotationAngle;      // rotation angle 
    DPoint2d        origin;             // origin 
    } Ellipse_2d;

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Ellipse Element (type 15)                                       |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct ellipse_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    T_Adouble       primary;            // primary axis 
    T_Adouble       secondary;          // secondary axis 
    T_Adouble       quat[4];            // quaternion rotations 
    DPoint3d        origin;             // origin 
    } Ellipse_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Arc Element (type 16)                                           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct arc_2d
    {
    Elm_hdr         ehdr;
    Disp_hdr        dhdr;
    T_Adouble       startAngle;         // start angle 
    T_Adouble       sweepAngle;         // sweep angle 
    T_Adouble       primary;            // primary axis 
    T_Adouble       secondary;          // secondary axis 
    T_Adouble       rotationAngle;      // rotation angle 
    DPoint2d        origin;             // origin 
    } Arc_2d;

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Arc Element (type 16)                                           |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct arc_3d
    {
    Elm_hdr         ehdr;
    Disp_hdr        dhdr;
    T_Adouble       startAngle;         // start angle 
    T_Adouble       sweepAngle;         // sweep angle 
    T_Adouble       primary;            // primary axis 
    T_Adouble       secondary;          // secondary axis 
    T_Adouble       quat[4];            // quaternion rotations 
    DPoint3d        origin;             // origin 
    } Arc_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Text Element (type 17)                                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct text_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          font;               // text font used 
    UInt16          just;               // justification type 
    UInt16          numchars;           // # of characters 
    T_Adouble       lngthmult;          // length multiplier 
    T_Adouble       hghtmult;           // height multiplier 
    T_Adouble       length;             // total length of the text 
    T_Adouble       height;             // total height of the text 
    T_Adouble       rotationAngle;      // rotation angle of the text 
    DPoint2d        origin;             // origin 
    UInt16          edflds;             // # of enter data fields 
    VariChar        string[6];          // characters
    } Text_2d;                           

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Text Element (type 17)                                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct text_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          font;               // text font used 
    UInt16          just;               // justification type 
    UInt16          numchars;           // # of characters 
    T_Adouble       lngthmult;          // length multiplier 
    T_Adouble       hghtmult;           // height multiplier 
    T_Adouble       length;             // total length of the text 
    T_Adouble       height;             // total height of the text 
    T_Adouble       quat[4];            // quaternion rotations 
    DPoint3d        origin;             // origin 
    UInt16          edflds;             // # of enter data fields 
    VariChar        string[6];          // characters 
    } Text_3d;                           

/*----------------------------------------------------------------------+
|                                                                       |
|    Surface (type 18, complex)     3d only                             |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct surface_type18
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    UInt32          boundelms;          // number of boundary elements 
    UInt16          surftype;           // surface type 
    UInt16          reserved[3];        // reserved 
    } Surface;

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D  B-Spline pole element (type 21)                                |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_pole_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          numpoles;           // number of poles 
    UInt32          reserved;           // reserved 
    DPoint2d        poles[1];           // points 
    } Bspline_pole_2d;                   

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D  B-Spline pole element (type 21)                                |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_pole_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          numpoles;           // number of poles 
    UInt32          reserved;           // reserved 
    DPoint3d        poles[1];           // points 
    } Bspline_pole_3d;                   

/*----------------------------------------------------------------------+
|                                                                       |
|   2-D Point String element (type 22)                                  |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct point_string_2d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          numpts;             // number of points 
    UInt32          reserved;           // reserved 
    DPoint2d        point[1];           // points 
    } Point_string_2d;                   

/*----------------------------------------------------------------------+
|                                                                       |
|   3-D Point String element (type 22)                                  |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct point_string_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          numpts;             // number of points 
    UInt32          reserved;           // reserved 
    DPoint3d        point[1];           // points 
    } Point_string_3d;                   

/*----------------------------------------------------------------------+
|                                                                       |
|   Circular truncated cone  (type 23)    3-D files only                |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct cone_3d
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    struct
        {
        UInt16      type:3;             // cone type 
        UInt16      rsrv:12;            // reserved 
        UInt16      surf:1;             // 0 = solid, 1 = surface 
        } b;
    UInt16          reserved[3];        // unused 
    T_Adouble       quat[4];            // orientation quaternion 
    DPoint3d        center_1;           // center of first circle 
    T_Adouble       radius_1;           // radius of first circle 
    DPoint3d        center_2;           // center of second circle 
    T_Adouble       radius_2;           // radius of second cirele 
    } Cone_3d;

/*----------------------------------------------------------------------+
|                                                                       |
|   Bspline flags                                                       |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct  bspline_flags
    {
    UInt32          order:5;                    // order - 2
    UInt32          curve_display:1;            // curve display flag 
    UInt32          poly_display:1;             // polygon display flag 
    UInt32          rational:1;                 // rationalization flag 
    UInt32          closed:1;                   // closed curve flag 
    UInt32          curve_type:8;               // curve type 
    UInt32          construct_type:4;           // construction type: pole, interpolation or least square 
    UInt32          isNaturalTangents:1;        // T/F: autocompute natural/bessel tangent if it's zero (open spline) 
    UInt32          isChordLenTangents:1;       // T/F: scale nonzero tangent by chordlen/bessel (open spline) 
    UInt32          isColinearTangents:1;       // T: adjust autocomputed tangent(s) to be colinear (geometrically closed spline) 
    UInt32          isChordLenKnots:1;          // T/F: use chordlen/uniform knots (!inParams, periodic spline) 
    UInt32          isZeroStartTangent:1;       // T: autocompute start tangent---ignore stored value (open spline) 
    UInt32          isZeroEndTangent:1;         // T: autocompute end tangent---ignore stored value (open spline) 
    UInt32          storeFullKnots:1;           // denote knot vectors that are NOT in [0.0, 1.0] range (open spline) 
    UInt32          reserved:4;                 // reserved 
    } Bspline_flags;                             

/*----------------------------------------------------------------------+
|                                                                       |
|   Bspline surface flags                                               |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bsurf_flags
    {
    UInt32          v_order:5;                  // b-spline order - 2 (v Direction)
    UInt32          arcSpacing:1;               // rule lines spaced by arc length 
    UInt32          v_closed:1;                 // closed curve flag 
    UInt32          storeFullKnots:1;           // denote knot vectors that are NOT in [0.0, 1.0] range and params.closed == false 
    UInt32          reserved:24;                // reserved 
    } Bsurf_flags;

/*----------------------------------------------------------------------+
|                                                                       |
|   Bspline surface header      (type 24)                               |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_surface
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    Bspline_flags   flags;              // miscellaneous flags 
    UInt32          num_poles_u;        // number of poles 
    UInt32          num_knots_u;        // number of knots 
    UInt32          rule_lines_u;       // number of rule lines 
    Bsurf_flags     bsurf_flags;        // bspline surface flags 
    UInt32          num_poles_v;        // number of poles 
    UInt32          num_knots_v;        // number of knots 
    UInt32          rule_lines_v;       // number of rule lines 
    UInt32          num_bounds;         // number of boundaries 
    } Bspline_surface;

/*----------------------------------------------------------------------+
|                                                                       |
|   B-spline Surface boundary (type 25)                                 |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bsurf_boundary
    {
    Elm_hdr         ehdr;               // element header 
    UInt32          number;             // boundary number 
    UInt32          numverts;           // number of boundary vertices 
    DPoint2d        vertices[1];        // boundary points (in UV space) 
    } Bsurf_boundary;

/*----------------------------------------------------------------------+
|                                                                       |
|   B-spline weight     factor (type 26)                                |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_weight
    {
    Elm_hdr         ehdr;               // element header 
    T_Adouble       weights[1];         // bspline weights (variable length) 
    } Bspline_weight;

/*----------------------------------------------------------------------+
|                                                                       |
|   B-spline curve header  (type 27)                                    |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_curve
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    Bspline_flags   flags;              // miscellaneous flags 
    UInt32          num_poles;          // number of poles 
    UInt32          num_knots;          // number of knots 
    } Bspline_curve;

/*----------------------------------------------------------------------+
|                                                                       |
|   B-spline knot bvector (type 28)                                      |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct bspline_knot
    {
    Elm_hdr         ehdr;               // element header 
    T_Adouble       knots[1];           // knots (variable length) 
    } Bspline_knot;

/*----------------------------------------------------------------------+
|                                                                       |
|   Shared Cell Instance (type 35) - complete definition unpublished    |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct scOverride
    {
    UInt16          level:1;            // level override (true for pnt cells)  
    UInt16          relative:1;         // relative or absolute                 
    UInt16          classValue:1;       // class value                          
    UInt16          color:1;            // color of all components              
    UInt16          weight:1;           // weight of all components             
    UInt16          style:1;            // style of all components              
    UInt16          assocPnt:1;         // origin of cell is associative point  
    UInt16          scaleDimsWysiwyg:1; // true = when scaling, do non-default scaling of dims (scale dim sizes, don't scale dim values) 
    UInt16          unused:8;
    } SCOverride;

/*----------------------------------------------------------------------+
|                                                                       |
|   Flags structure                                                     |
|                                                                       |
+----------------------------------------------------------------------*/
typedef union raster_flags
    {
    struct
        {
        unsigned    right:1;
        unsigned    lower:1;
        unsigned    horizontal:1;
        unsigned    format:5;
        unsigned    color:1;
        unsigned    transparent:1;
        unsigned    positive:1;
        unsigned    unused:5;
        } b;
    Int16 s;
    } Raster_flags;

/*----------------------------------------------------------------------+
|                                                                       |
|   Raster header element (type 87)                                     |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct raster_hdr
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    UInt32          componentCount;     // number of elements following header 
    Raster_flags    flags;              // miscellaneous raster data 
    byte            background;
    byte            foreground;
    UInt16          xextent;
    UInt16          yextent;
    Int16           reserved;
    T_Adouble       resolution;
    T_Adouble       scale;
    DPoint3d        origin;
    UInt32          numverts;
    UInt32          reserved2;
    union
        {
        DPoint2d    vert2d[1];
        DPoint3d    vert3d[1];
        } u;
    } Raster_hdr;

/*----------------------------------------------------------------------+
|                                                                       |
|   Raster component (type 88)                                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct raster_comp
    {
    Elm_hdr         ehdr;               // element header 
    Disp_hdr        dhdr;               // display header 
    Raster_flags    flags;              // flags 
    byte            background;
    byte            foreground;
    UInt16          xoffset;
    UInt16          yoffset;
    UInt16          numpixels;
    byte            pixel[4];
    } Raster_comp;


/*----------------------------------------------------------------------+
|                                                                       |
|   Application element (type 66, level 20)                             |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct      applicationElm
    {
    Elm_hdr         ehdr;
    Int16           signatureWord;
    Int16           appData[1];
    } ApplicationElm;

/*----------------------------------------------------------------------+
|                                                                       |
|   Reference Attachment Element (type 100, level 0)                    |
|   This is a complex element whose components are level bit masks for  |
|   each view.                                                          |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct referenceFileElm
    {
    Elm_hdr         ehdr;               // element header 
    UInt32          componentCount;     // number of elements following header 
    UInt32          version;            // reference attachment version number 
    UInt32          groupId;            // group number that this ref belongs to 
    UInt32          fileNumber;         // file number 
    T_AUInt64       parentAttachmentId; // element id of parent attachment for copied refs 
    Fb_opts         fb_opts;            // file builder options mask 
    Fd_opts         fd_opts;            // file displayer options mask 
    UInt32          priority;           // attachment display priority 
    ViewFlags       displayFlags[8];    // display flags 
    UInt16          baseNestDepth;      // this is retained when copying attachments 
    UInt16          reserved;           // future use 
    DPoint3d        refOrigin;          // origin in reference uors 
    DPoint3d        masterOrigin;       // origin in master file uors 
    RotMatrix       transform;          // transformation matrix 
    T_Adouble       scale;              // conversion factor 
    T_Adouble       reservedScale[2];   // reserved for future scaling options 
    T_Adouble       zFront;             // Z-front plane 
    T_Adouble       zBack;              // Z-back plane 
    DPoint3d        cameraPosition;     // Camera position 
    T_Adouble       cameraFocalLength;  // Camera focal length 
    UInt16          nestDepth;          // nest depth 
    UInt16          reserved1;          // in 8.0, this was used as dimPercent. Do not use 
    Int16           foreignUnitMode;    // unused 
    UInt16          nClipPoints;        // clipping vertices 
    DPoint2d        clipPoints[1];      // clipping polygon 
    } ReferenceFileElm;


CLRPUBLIC struct JointDef
    {
    DPoint3d  dir;     //  Unit bvector in direction of joint        
    T_Adouble scale;   //  Ratio of joint length to line distance   
    };

struct MlinePoint
    {
    DPoint3d        point;
    struct
        {
        UInt16     assoc:1;
        UInt16     roundCorner:1;       // Unused - to enable corner rounding 
        UInt16     reserved:14;
        } flags;
    UInt16          reserved;           // padding 
    UInt16          breakNo;            // Starting point in break array for this segment 
    UInt16          nBreaks;            // Number of breaks in this segment 
    T_Adouble       radius;             // For when we figure out how to round corners 
    };

struct MlineBreak
    {
    UInt32          lineMask;
    UInt32          flags;
    T_Adouble       offset;
    T_Adouble       length;
    T_Adouble       angle;
    };


enum
    {
    MODELELEMENT_VERSION       = 7,
    MIN_MODELFLAG_Properties   = 0,
    MAX_MODELFLAG_Properties   = 31,
    MIN_MODELFLAG_Settings     = 32,
    MAX_MODELFLAG_Settings     = 63,
    MODELFLAG_UseBackgroundColor =  4,
    };

enum IsoPlaneValues {IsoPlaneTop = 0, IsoPlaneLeft, IsoPlaneRight, IsoPlaneAll};
#define MAX_RGB_TRANSPARENTCOLOR        32
#define MAX_CONTTONE_TRANSPARENTCOLOR   256
#define MAXMASKNAMELENGTH               255 //see also MAX_MASK_NAMELENGTH in IRasterAttachment.h

typedef struct _rgbColorCube
    {
    RgbColorDef colorMin;
    RgbColorDef colorMax;
    } _RGBColorCube;

typedef struct _rgbTransparentColorDef
    {
    _RGBColorCube  colorCube;
    Byte transparency;              // 0...255, 0 -> Opaque. 
    } _RGBTransparentColorDef;


typedef struct _rasterTransparentColorDef
    {
    Byte index;
    Byte transparency; // 0...255, 0 -> Opaque. 
    } _RasterTransparentColorDef;

typedef struct _rasterRgbColorCube
    {
    RgbaColorDef colorMin;
    RgbaColorDef colorMax;
    } _RasterRGBColorCube;

typedef struct _rasterRgbTransparentColorDef
    {
    _RasterRGBColorCube  colorCube;
    Byte                 transparency; // 0...255, 0 -> Opaque. 
    Byte                 padding[7];
    } _RasterRGBTransparentColorDef;

typedef union _transparentColors
    {
    _RasterTransparentColorDef        index[MAX_CONTTONE_TRANSPARENTCOLOR];
    _RasterRGBTransparentColorDef     rgb[MAX_RGB_TRANSPARENTCOLOR];
    } RasterTransparentColors;


/*---------------------------------------------------------------------------------**/
CLRPUBLIC union MSElement
    {
    Elm_hdr             ehdr;
    Header              hdr; // NOTE: hdr.dhdr is not valid unless ehdr.isGraphics is set 
    Cell_2d             cell_2d;
    Cell_3d             cell_3d;
    Line_2d             line_2d;
    Line_3d             line_3d;
    Line_String_2d      line_string_2d;
    Line_String_3d      line_string_3d;
    Text_node_2d        text_node_2d;
    Text_node_3d        text_node_3d;
    Complex_string      complex_string;
    Ellipse_2d          ellipse_2d;
    Ellipse_3d          ellipse_3d;
    Arc_2d              arc_2d;
    Arc_3d              arc_3d;
    Text_2d             text_2d;
    Text_3d             text_3d;
    Point_string_2d     point_string_2d;
    Point_string_3d     point_string_3d;
    Cone_3d             cone_3d;
    Surface             surf;
    Bspline_pole_2d     bspline_pole_2d;
    Bspline_pole_3d     bspline_pole_3d;
    Bspline_curve       bspline_curve;
    Bspline_surface     bspline_surface;
    Bspline_weight      bspline_weight;
    Bspline_knot        bspline_knot;
    Bsurf_boundary      bsurf_boundary;
    Raster_hdr          raster_hdr;
    Raster_comp         raster_comp;
    ApplicationElm      applicationElm;
    ColorTable          colorTable;
    ReferenceFileElm    referenceFileElm;
    Int16               tmp[MAX_ELEMENT_WORDS];
    Int16               buf[MAX_INTERNAL_ELEM_WORDS];

    DGNPLATFORM_EXPORT size_t Size () const;
    
    DGNPLATFORM_EXPORT size_t CopyTo (MSElementR rhs) const;

    DGNPLATFORM_EXPORT DgnPlatform::ElementId GetID () const;

    DGNPLATFORM_EXPORT bool IsComplexHeader () const;

    DGNPLATFORM_EXPORT int GetComplexComponentCount () const;

    }; // MSElement

#endif // !defined (__midl) 

END_BENTLEY_DGNPLATFORM_NAMESPACE