dgnlib.h

Go to the documentation of this file.

/******************************************************************************
 * $Id$
 *
 * Project:  Microstation DGN Access Library
 * Purpose:  Definitions of public structures and API of DGN Library.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2000, Avenza Systems Inc, http://www.avenza.com/
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/
 
#ifndef DGNLIB_H_INCLUDED
#define DGNLIB_H_INCLUDED
 
#undef STRICT_CPLERRORNUM_TYPE
 
#include "cpl_conv.h"
 
CPL_C_START
 
#define CPLE_DGN_ERROR_BASE
#define CPLE_ElementTooBig              CPLE_DGN_ERROR_BASE+1
 
typedef struct {
    double x;   
    double y;   
    double z;   
} DGNPoint;
 
typedef struct {
    unsigned char       level;   
    unsigned char       type;    
    unsigned char       stype;   
    unsigned char       flags;   
    vsi_l_offset        offset;  
} DGNElementInfo;
 
typedef struct {
    int         offset;
    int         size;
 
    int         element_id;     
    int         stype;          
    int         level;          
    int         type;           
    int         complex;        
    int         deleted;        
    int         graphic_group;  
    int         properties;     
    int         color;          
    int         weight;         
    int         style;          
    int         attr_bytes;     
    unsigned char *attr_data;   
    int         raw_bytes;      
    unsigned char *raw_data;    
} DGNElemCore;
 
typedef struct {
  DGNElemCore   core;
 
  int           num_vertices;  
  DGNPoint      vertices[1];   
                               // Note: We set [1] to please clang UBSAN
                               // regarding structures that are extended at
                               // malloc time
 
} DGNElemMultiPoint;
 
typedef struct {
  DGNElemCore   core;
 
  DGNPoint      origin;         
  double        primary_axis;   
  double        secondary_axis; 
  double        rotation;       
  int           quat[4];
 
  double        startang;       
  double        sweepang;       
} DGNElemArc;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         font_id;       
    int         justification; 
    double      length_mult;   
    double      height_mult;   
    double      rotation;      
    DGNPoint    origin;        
    char        string[1];     
} DGNElemText;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         totlength;     
    int         numelems;      
    int         surftype;      
    int         boundelms;     
} DGNElemComplexHeader;
 
typedef struct {
  DGNElemCore   core;
 
  int           screen_flag;
  GByte         color_info[256][3]; 
} DGNElemColorTable;
 
typedef struct {
    int           flags;
    unsigned char levels[8];
    DGNPoint      origin;
    DGNPoint      delta;
    double        transmatrx[9];
    double        conversion;
    unsigned long activez;
} DGNViewInfo;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         dimension;         
    double      origin_x;       
    double      origin_y;       
    double      origin_z;       
    long        uor_per_subunit;   
    char        sub_units[3];      
    long        subunits_per_master; 
    char        master_units[3];   
    DGNViewInfo views[8];
 
} DGNElemTCB;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         totlength;         
    char        name[7];           
 unsigned short cclass;            
 unsigned short levels[4];         
    DGNPoint    rnglow;            
    DGNPoint    rnghigh;           
    double      trans[9];          
    DGNPoint    origin;            
    double      xscale;
    double      yscale;
    double      rotation;
 
} DGNElemCellHeader;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    short       celltype;          
    short       attindx;           
    char        name[7];           
    int         numwords;          
    short       dispsymb;          
 unsigned short cclass;            
 unsigned short levels[4];         
    char        description[28];   
} DGNElemCellLibrary;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         totlength;         
  // FIXME: Most of the contents of this element type is currently
  // unknown. Please get in touch with the authors if you have
  // information about how to decode this element.
} DGNElemSharedCellDefn;
 
typedef union { char *string; GInt32 integer; double real; } tagValueUnion;
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int         tagType;           
    int         tagSet;            
    int         tagIndex;          
    int         tagLength;         
    tagValueUnion tagValue;        
} DGNElemTagValue;
 
typedef struct _DGNTagDef {
    char        *name;      
    int         id;         
    char        *prompt;    
    int         type;       
    tagValueUnion defaultValue; 
} DGNTagDef;
 
#define DGNTT_STRING      1
#define DGNTT_INTEGER     3
#define DGNTT_FLOAT       4
 
typedef struct {
    DGNElemCore core;   /* must be at first position ! */
 
    int        tagCount;    
    int        tagSet;      
    int        flags;       
    char       *tagSetName; 
    DGNTagDef  *tagList;    
} DGNElemTagSet;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  short unknown;     
  int quat[4];      
  DGNPoint center_1; 
  double radius_1;   
  DGNPoint center_2; 
  double radius_2;   
} DGNElemCone;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  int       totlength;          
  int       numelems;           
  int       node_number;        
  short     max_length;         
  short     max_used;           
  short     font_id;            
  short     justification;      
  long      line_spacing;       
  double    length_mult;        
  double    height_mult;        
  double    rotation;           
  DGNPoint  origin;             
} DGNElemTextNode;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  long desc_words;               
  unsigned char curve_type;      
  unsigned char u_order;         
  unsigned short u_properties;   
  short num_poles_u;             
  short num_knots_u;             
  short rule_lines_u;            
  unsigned char v_order;         
  unsigned short v_properties;   
  short num_poles_v;             
  short num_knots_v;             
  short rule_lines_v;            
  short num_bounds;              
} DGNElemBSplineSurfaceHeader;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  long desc_words;               
  unsigned char order;           
  unsigned char properties;      
  unsigned char curve_type;      
  short num_poles;               
  short num_knots;               
} DGNElemBSplineCurveHeader;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  short number;         
  short numverts;       
  DGNPoint vertices[1]; 
} DGNElemBSplineSurfaceBoundary;
 
typedef struct {
  DGNElemCore core;   /* must be at first position ! */
 
  float array[1];         
} DGNElemKnotWeight;
 
/* -------------------------------------------------------------------- */
/*      Structure types                                                 */
/* -------------------------------------------------------------------- */
 
#define DGNST_CORE                 1
 
#define DGNST_MULTIPOINT           2
 
#define DGNST_COLORTABLE           3
 
#define DGNST_TCB                  4
 
#define DGNST_ARC                  5
 
#define DGNST_TEXT                 6
 
#define DGNST_COMPLEX_HEADER       7
 
#define DGNST_CELL_HEADER          8
 
#define DGNST_TAG_VALUE            9
 
#define DGNST_TAG_SET             10
 
#define DGNST_CELL_LIBRARY        11
 
#define DGNST_CONE                12
 
#define DGNST_TEXT_NODE           13
 
#define DGNST_BSPLINE_SURFACE_HEADER   14
 
#define DGNST_BSPLINE_CURVE_HEADER     15
 
#define DGNST_BSPLINE_SURFACE_BOUNDARY 16
 
#define DGNST_KNOT_WEIGHT              17
 
#define DGNST_SHARED_CELL_DEFN         18
 
/* -------------------------------------------------------------------- */
/*      Element types                                                   */
/* -------------------------------------------------------------------- */
#define DGNT_CELL_LIBRARY              1
#define DGNT_CELL_HEADER               2
#define DGNT_LINE                      3
#define DGNT_LINE_STRING               4
#define DGNT_GROUP_DATA                5
#define DGNT_SHAPE                     6
#define DGNT_TEXT_NODE                 7
#define DGNT_DIGITIZER_SETUP           8
#define DGNT_TCB                       9
#define DGNT_LEVEL_SYMBOLOGY          10
#define DGNT_CURVE                    11
#define DGNT_COMPLEX_CHAIN_HEADER     12
#define DGNT_COMPLEX_SHAPE_HEADER     14
#define DGNT_ELLIPSE                  15
#define DGNT_ARC                      16
#define DGNT_TEXT                     17
#define DGNT_3DSURFACE_HEADER         18
#define DGNT_3DSOLID_HEADER           19
#define DGNT_BSPLINE_POLE             21
#define DGNT_POINT_STRING             22
#define DGNT_BSPLINE_SURFACE_HEADER   24
#define DGNT_BSPLINE_SURFACE_BOUNDARY 25
#define DGNT_BSPLINE_KNOT             26
#define DGNT_BSPLINE_CURVE_HEADER     27
#define DGNT_BSPLINE_WEIGHT_FACTOR    28
#define DGNT_CONE                     23
#define DGNT_SHARED_CELL_DEFN         34
#define DGNT_SHARED_CELL_ELEM         35
#define DGNT_TAG_VALUE                37
#define DGNT_APPLICATION_ELEM         66
 
/* -------------------------------------------------------------------- */
/*      Line Styles                                                     */
/* -------------------------------------------------------------------- */
#define DGNS_SOLID              0
#define DGNS_DOTTED             1
#define DGNS_MEDIUM_DASH        2
#define DGNS_LONG_DASH          3
#define DGNS_DOT_DASH           4
#define DGNS_SHORT_DASH         5
#define DGNS_DASH_DOUBLE_DOT    6
#define DGNS_LONG_DASH_SHORT_DASH 7
 
/* -------------------------------------------------------------------- */
/*      3D Surface Types                                                */
/* -------------------------------------------------------------------- */
#define DGNSUT_SURFACE_OF_PROJECTION    0
#define DGNSUT_BOUNDED_PLANE            1
#define DGNSUT_BOUNDED_PLANE2           2
#define DGNSUT_RIGHT_CIRCULAR_CYLINDER  3
#define DGNSUT_RIGHT_CIRCULAR_CONE      4
#define DGNSUT_TABULATED_CYLINDER       5
#define DGNSUT_TABULATED_CONE           6
#define DGNSUT_CONVOLUTE                7
#define DGNSUT_SURFACE_OF_REVOLUTION    8
#define DGNSUT_WARPED_SURFACE           9
 
/* -------------------------------------------------------------------- */
/*      3D Solid Types                                                  */
/* -------------------------------------------------------------------- */
#define DGNSOT_VOLUME_OF_PROJECTION     0
#define DGNSOT_VOLUME_OF_REVOLUTION     1
#define DGNSOT_BOUNDED_VOLUME           2
 
/* -------------------------------------------------------------------- */
/*      Class                                                           */
/* -------------------------------------------------------------------- */
#define DGNC_PRIMARY                    0
#define DGNC_PATTERN_COMPONENT          1
#define DGNC_CONSTRUCTION_ELEMENT       2
#define DGNC_DIMENSION_ELEMENT          3
#define DGNC_PRIMARY_RULE_ELEMENT       4
#define DGNC_LINEAR_PATTERNED_ELEMENT   5
#define DGNC_CONSTRUCTION_RULE_ELEMENT  6
 
/* -------------------------------------------------------------------- */
/*      Group Data level numbers.                                       */
/*                                                                      */
/*      These are symbolic values for the typ 5 (DGNT_GROUP_DATA)       */
/*      level values that have special meanings.                        */
/* -------------------------------------------------------------------- */
#define DGN_GDL_COLOR_TABLE     1
#define DGN_GDL_NAMED_VIEW      3
#define DGN_GDL_REF_FILE        9
 
/* -------------------------------------------------------------------- */
/*      Word 17 property flags.                                         */
/* -------------------------------------------------------------------- */
#define DGNPF_HOLE         0x8000
#define DGNPF_SNAPPABLE    0x4000
#define DGNPF_PLANAR       0x2000
#define DGNPF_ORIENTATION  0x1000
#define DGNPF_ATTRIBUTES   0x0800
#define DGNPF_MODIFIED     0x0400
#define DGNPF_NEW          0x0200
#define DGNPF_LOCKED       0x0100
#define DGNPF_CLASS        0x000f
 
/* -------------------------------------------------------------------- */
/*      DGNElementInfo flag values.                                     */
/* -------------------------------------------------------------------- */
#define DGNEIF_DELETED     0x01
#define DGNEIF_COMPLEX     0x02
 
/* -------------------------------------------------------------------- */
/*      Justifications                                                  */
/* -------------------------------------------------------------------- */
#define DGNJ_LEFT_TOP           0
#define DGNJ_LEFT_CENTER        1
#define DGNJ_LEFT_BOTTOM        2
#define DGNJ_LEFTMARGIN_TOP     3    /* text node header only */
#define DGNJ_LEFTMARGIN_CENTER  4    /* text node header only */
#define DGNJ_LEFTMARGIN_BOTTOM  5    /* text node header only */
#define DGNJ_CENTER_TOP         6
#define DGNJ_CENTER_CENTER      7
#define DGNJ_CENTER_BOTTOM      8
#define DGNJ_RIGHTMARGIN_TOP    9    /* text node header only */
#define DGNJ_RIGHTMARGIN_CENTER 10   /* text node header only */
#define DGNJ_RIGHTMARGIN_BOTTOM 11   /* text node header only */
#define DGNJ_RIGHT_TOP          12
#define DGNJ_RIGHT_CENTER       13
#define DGNJ_RIGHT_BOTTOM       14
 
/* -------------------------------------------------------------------- */
/*      DGN file reading options.                                       */
/* -------------------------------------------------------------------- */
#define DGNO_CAPTURE_RAW_DATA   0x01
 
/* -------------------------------------------------------------------- */
/*      Known attribute linkage types, including my synthetic ones.     */
/* -------------------------------------------------------------------- */
#define DGNLT_DMRS              0x0000
#define DGNLT_INFORMIX          0x3848
#define DGNLT_ODBC              0x5e62
#define DGNLT_ORACLE            0x6091
#define DGNLT_RIS               0x71FB
#define DGNLT_SYBASE            0x4f58
#define DGNLT_XBASE             0x1971
#define DGNLT_SHAPE_FILL        0x0041
#define DGNLT_ASSOC_ID          0x7D2F
 
/* -------------------------------------------------------------------- */
/*      File creation options.                                          */
/* -------------------------------------------------------------------- */
 
#define DGNCF_USE_SEED_UNITS              0x01
#define DGNCF_USE_SEED_ORIGIN             0x02
#define DGNCF_COPY_SEED_FILE_COLOR_TABLE  0x04
#define DGNCF_COPY_WHOLE_SEED_FILE        0x08
 
/* -------------------------------------------------------------------- */
/*      B-Spline Curve flags. Also used for U-direction of surfaces     */
/* -------------------------------------------------------------------- */
#define DGNBSC_CURVE_DISPLAY              0x10
#define DGNBSC_POLY_DISPLAY               0x20
#define DGNBSC_RATIONAL                   0x40
#define DGNBSC_CLOSED                     0x80
 
/* -------------------------------------------------------------------- */
/*      B-Spline Curve flags for V-direction of surfaces.               */
/* -------------------------------------------------------------------- */
#define DGNBSS_ARC_SPACING                0x40
#define DGNBSS_CLOSED                     0x80
 
/* -------------------------------------------------------------------- */
/*      API                                                             */
/* -------------------------------------------------------------------- */
typedef void *DGNHandle;
 
DGNHandle CPL_DLL    DGNOpen( const char *, int );
void CPL_DLL         DGNSetOptions( DGNHandle, int );
int CPL_DLL          DGNTestOpen( GByte *, int );
const DGNElementInfo CPL_DLL *DGNGetElementIndex( DGNHandle, int * );
int CPL_DLL          DGNGetExtents( DGNHandle, double * );
int CPL_DLL          DGNGetDimension( DGNHandle );
DGNElemCore CPL_DLL *DGNReadElement( DGNHandle );
void CPL_DLL         DGNFreeElement( DGNHandle, DGNElemCore * );
void CPL_DLL         DGNRewind( DGNHandle );
int  CPL_DLL         DGNGotoElement( DGNHandle, int );
void CPL_DLL         DGNClose( DGNHandle );
int  CPL_DLL         DGNLoadTCB( DGNHandle );
int  CPL_DLL         DGNLookupColor( DGNHandle, int, int *, int *, int * );
int  CPL_DLL         DGNGetShapeFillInfo( DGNHandle, DGNElemCore *, int * );
int  CPL_DLL         DGNGetAssocID( DGNHandle, DGNElemCore * );
int  CPL_DLL         DGNGetElementExtents( DGNHandle, DGNElemCore *,
                                           DGNPoint *, DGNPoint * );
 
void CPL_DLL         DGNDumpElement( DGNHandle, DGNElemCore *, FILE * );
const char CPL_DLL  *DGNTypeToName( int );
 
void CPL_DLL  DGNRotationToQuaternion( double, int * );
void CPL_DLL  DGNQuaternionToMatrix( int *, float * );
int CPL_DLL   DGNStrokeArc( DGNHandle, DGNElemArc *, int, DGNPoint * );
int CPL_DLL   DGNStrokeCurve( DGNHandle, DGNElemMultiPoint*, int, DGNPoint * );
void CPL_DLL  DGNSetSpatialFilter( DGNHandle hDGN,
                                   double dfXMin, double dfYMin,
                                   double dfXMax, double dfYMax );
int  CPL_DLL  DGNGetAttrLinkSize( DGNHandle, DGNElemCore *, int );
unsigned char CPL_DLL *
              DGNGetLinkage( DGNHandle hDGN, DGNElemCore *psElement,
                             int iIndex, int *pnLinkageType,
                             int *pnEntityNum, int *pnMSLink, int *pnLinkSize);
 
/* Write API */
 
int  CPL_DLL  DGNWriteElement( DGNHandle, DGNElemCore * );
int  CPL_DLL  DGNResizeElement( DGNHandle, DGNElemCore *, int );
DGNHandle CPL_DLL
      DGNCreate( const char *pszNewFilename, const char *pszSeedFile,
                 int nCreationFlags,
                 double dfOriginX, double dfOriginY, double dfOriginZ,
                 int nMasterUnitPerSubUnit, int nUORPerSubUnit,
                 const char *pszMasterUnits, const char *pszSubUnits );
DGNElemCore CPL_DLL *DGNCloneElement( DGNHandle hDGNSrc, DGNHandle hDGNDst,
                                      DGNElemCore *psSrcElement );
int CPL_DLL   DGNUpdateElemCore( DGNHandle hDGN, DGNElemCore *psElement,
                                 int nLevel, int nGraphicGroup, int nColor,
                                 int nWeight, int nStyle );
int CPL_DLL   DGNUpdateElemCoreExtended( DGNHandle hDGN,
                                         DGNElemCore *psElement );
 
DGNElemCore CPL_DLL *
              DGNCreateMultiPointElem( DGNHandle hDGN, int nType,
                                       int nPointCount, DGNPoint*pasVertices );
DGNElemCore CPL_DLL  *
              DGNCreateArcElem2D( DGNHandle hDGN, int nType,
                                  double dfOriginX, double dfOriginY,
                                  double dfPrimaryAxis, double dfSecondaryAxis,
                                  double dfRotation,
                                  double dfStartAngle, double dfSweepAngle );
 
DGNElemCore CPL_DLL  *
              DGNCreateArcElem( DGNHandle hDGN, int nType,
                                double dfOriginX, double dfOriginY,
                                double dfOriginZ,
                                double dfPrimaryAxis, double dfSecondaryAxis,
                                double dfStartAngle, double dfSweepAngle,
                                double dfRotation, int *panQuaternion );
 
DGNElemCore CPL_DLL  *
              DGNCreateConeElem( DGNHandle hDGN,
                                 double center_1X, double center_1Y,
                                 double center_1Z, double radius_1,
                                 double center_2X, double center_2Y,
                                 double center_2Z, double radius_2,
                                 int *panQuaternion );
 
DGNElemCore CPL_DLL *
             DGNCreateTextElem( DGNHandle hDGN, const char *pszText,
                                int nFontId, int nJustification,
                                double dfLengthMult, double dfHeightMult,
                                double dfRotation, int *panQuaternion,
                       double dfOriginX, double dfOriginY, double dfOriginZ );
 
DGNElemCore CPL_DLL *
            DGNCreateColorTableElem( DGNHandle hDGN, int nScreenFlag,
                                     GByte abyColorInfo[256][3] );
DGNElemCore CPL_DLL *
DGNCreateComplexHeaderElem( DGNHandle hDGN, int nType,
                            int nTotLength, int nNumElems );
DGNElemCore CPL_DLL *
DGNCreateComplexHeaderFromGroup( DGNHandle hDGN, int nType,
                                 int nNumElems, DGNElemCore **papsElems );
 
DGNElemCore CPL_DLL *
DGNCreateSolidHeaderElem( DGNHandle hDGN, int nType, int nSurfType,
                          int nBoundElems, int nTotLength, int nNumElems );
DGNElemCore CPL_DLL *
DGNCreateSolidHeaderFromGroup( DGNHandle hDGN, int nType, int nSurfType,
                               int nBoundElems, int nNumElems,
                               DGNElemCore **papsElems );
 
DGNElemCore CPL_DLL  *
DGNCreateCellHeaderElem( DGNHandle hDGN, int nTotLength, const char *pszName,
                         short nClass, short *panLevels,
                         DGNPoint *psRangeLow, DGNPoint *psRangeHigh,
                         DGNPoint *psOrigin, double dfXScale, double dfYScale,
                         double dfRotation );
 
DGNElemCore CPL_DLL *
DGNCreateCellHeaderFromGroup( DGNHandle hDGN, const char *pszName,
                              short nClass, short *panLevels,
                              int nNumElems, DGNElemCore **papsElems,
                              DGNPoint *psOrigin,
                              double dfXScale, double dfYScale,
                              double dfRotation );
 
int CPL_DLL DGNAddMSLink( DGNHandle hDGN, DGNElemCore *psElement,
                          int nLinkageType, int nEntityNum, int nMSLink );
 
int CPL_DLL DGNAddRawAttrLink( DGNHandle hDGN, DGNElemCore *psElement,
                               int nLinkSize, unsigned char *pabyRawLinkData );
 
int CPL_DLL DGNAddShapeFillInfo( DGNHandle hDGN, DGNElemCore *psElement,
                                 int nColor );
 
int CPL_DLL DGNElemTypeHasDispHdr( int nElemType );
 
CPL_C_END
 
#endif /* ndef DGNLIB_H_INCLUDED */