mdl.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
#define __mdlH__

#include    <Mstn\basedefs.h>
#include    <Mstn\basetype.h>
#include    <Mstn\MstnDefs.h>
#include    "mstypes.h"
#include    <DgnPlatform\TextParam.h>
#include    <DgnPlatform\ModelAccess.h>
#include    <DgnPlatform\StoredExpression.h>

/*----------------------------------------------------------------------+
|                                                                       |
|       MDL function pointers are longs when viewed by native code      |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct mdlDesc MdlDesc;
/*  We assume that when this structure is used in an MDL source
    file, it will hold MDL function pointers.  When it is used in
    native code, it will hold native code function pointers.  An
    entry can actually hold either an MDL or a native function pointer.
    However, if an MDL source file contains a cast to a ...
*/
typedef void (*CmdHandler) (WCharCP);

typedef struct tagMdlCommandNumber
    {
    CmdHandler          pHandler;
    CommandNumber       number;
    } MdlCommandNumber;

typedef struct tagMdlCommandName
    {
    CmdHandler      pHandler;
    char            *pName;         // CHAR_OK
    } MdlCommandName;

// Define standard MdlMain to enforce unicode
extern "C" DLLEXPORT void MdlMain (int argc, WCharCP argv[]);


/*----------------------------------------------------------------------+
|                                                                       |
|       Text creation routine parameters                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define     TXT_NO_TRANSFORM            0x8000
#define     TXT_BY_TILE_SIZE            1
#define     TXT_BY_MULT                 2
#define     TXT_BY_TEXT_SIZE            3
#define     TXT_BY_WIDTH_ASPECT         4

/*----------------------------------------------------------------------+
|
|   Defines for mdlElement_getFilePos & mdlElement_setFilePos routines.
|
|   NOTE: FILEPOS_COMPONENT has been removed. A complex component no
|         longer has a unique file position and will instead report
|         the file position of it's outermost complex header.
|         Applications that need the currently located component
|         can get it's ElementRefP using DisplayPath::GetComponentElem.
|         See mdlLocate_getCurrPath, mdlLocate_getComponentOffset.
|
+----------------------------------------------------------------------*/
#define FILEPOS_EOF                     0
#define FILEPOS_CURRENT                 1
#define FILEPOS_FIRST_ELE               2
#define FILEPOS_NEXT_ELE                3
#define FILEPOS_WORKING_SET             4
#define FILEPOS_NEXT_NEW_ELEMENT        6

/*----------------------------------------------------------------------+
|                                                                       |
|   Defines for mdlElmdscr_ routines                                    |
|                                                                       |
+----------------------------------------------------------------------*/
#define ELMD_ELEMENT                    (1<<0)
#define ELMD_PRE_HDR                    (1<<1)
#define ELMD_POST_HDR                   (1<<2)
#define ELMD_PRE_NESTEDHDR              (1<<3)
#define ELMD_POST_NESTEDHDR             (1<<4)
#define ELMD_ALL_ONCE    (ELMD_ELEMENT | ELMD_PRE_HDR | ELMD_PRE_NESTEDHDR)
#define ELMD_HDRS_ONCE   (ELMD_PRE_HDR | ELMD_PRE_NESTEDHDR)

/*----------------------------------------------------------------------+
|                                                                       |
|   Parameters for mdlModify_ routines                                  |
|                                                                       |
+----------------------------------------------------------------------*/
#if !defined(__midl) // For a MIDL compile, all we care about are the values of the #define constants.

typedef struct mdlCopyParamsTag
    {
    int     reserved1;
    void    *reserved2;
    void    *reserved3;
    } MdlCopyParams;

#endif // !defined(__midl)

#define MODIFY_ORIG                     (1<<1)
#define MODIFY_COPY                     0
#define MODIFY_DRAWINHILITE             (1<<3)
#define MODIFY_DONTDRAWNEW              (1<<4)
#define MODIFY_DONTERASEORIG            (1<<5)
#define MODIFY_TRAVERSENAMEDGROUPASCOPY (1<<6)

#define MODIFY_REQUEST_NOHEADERS        0
#define MODIFY_REQUEST_HEADERS          (1<<0)
#define MODIFY_REQUEST_ONLYONE          (1<<1)

#define MODIFY_STATUS_NOCHANGE          0
#define MODIFY_STATUS_REPLACE           (1<<0)
#define MODIFY_STATUS_DELETE            (1<<1)
#define MODIFY_STATUS_ABORT             (1<<2)
#define MODIFY_STATUS_FAIL              (1<<3)
#define MODIFY_STATUS_REPLACEDSCR       (1<<4)
#define MODIFY_STATUS_MODIFIED          (1<<5)
#define MODIFY_STATUS_DONTDELETEROWS    (1<<6)
#define MODIFY_STATUS_DONTHILITE        (1<<7)
#define MODIFY_STATUS_SWAPPEDDSCR       (1<<8)
#define MODIFY_STATUS_ERROR             (MODIFY_STATUS_FAIL | MODIFY_STATUS_ABORT)

/*----------------------------------------------------------------------+
|                                                                       |
|   Compress callback types                                             |
|                                                                       |
+----------------------------------------------------------------------*/
enum CompressType
{
    PRE_COMPRESS_DGNFILE    = 1,
    POST_COMPRESS_DGNFILE   = 2
};


#define VIEWMODE_WIREFRAME              0
#define VIEWMODE_CROSSSECTION           1
#define VIEWMODE_WIREMESH               2
#define VIEWMODE_HIDDENLINE             3
#define VIEWMODE_FILLEDHLINE            4
#define VIEWMODE_CONTANTSHADE           5
#define VIEWMODE_SMOOTHSHADE            6
#define VIEWMODE_PHONGSHADE             7


/*----------------------------------------------------------------------+
|                                                                       |
|   Defines for mdlOutput_printf.                                       |
|                                                                       |
+----------------------------------------------------------------------*/
#define MSG_MESSAGE                     0
#define MSG_ERROR                       1
#define MSG_PROMPT                      2
#define MSG_STATUS                      3
#define MSG_COMMAND                     4
#define MSG_KEYIN                       5
#define MSG_CONSOLE                     6

/*----------------------------------------------------------------------+
|                                                                       |
|   Defines for mdlWindow_ routines                                     |
|                                                                       |
+----------------------------------------------------------------------*/
typedef struct MSWindow MSWindow;

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for associative points                                    |
|                                                                       |
+----------------------------------------------------------------------*/
#define POINT_CHECK                     0
#define POINT_ASSOC                     1
#define POINT_STD                       2

/* Arc association options */
#define ASSOC_ARC_ANGLE                 0
#define ASSOC_ARC_CENTER                1
#define ASSOC_ARC_START                 2
#define ASSOC_ARC_END                   3

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlMline functions                                    |
|                                                                       |
+----------------------------------------------------------------------*/
#define MLCAP_NONE                      0x0
#define MLCAP_LINE                      0x1
#define MLCAP_OUTER_ARCS                0x2
#define MLCAP_INNER_ARCS                0x4
#define MLCAP_CLOSE                     0x8

#define MLJOIN_CLOSE                    0
#define MLJOIN_OPEN                     1
#define MLJOIN_MERGE                    2

typedef enum MlineCapFlags
    {
    MLINE_CAPFLAG_None              = 0,
    MLINE_CAPFLAG_ColorBySegment    = 1
    } MlineCapFlags;

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlText functions                                     |
|                                                                       |
+----------------------------------------------------------------------*/
#define FRACTIONS                       (1<<1)
#define INTERNATIONAL                   (1<<2)
#define CONTROL                         (1<<3)
#define HTML_CHAR                       (1<<4)

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlState_startFenceCommand                            |
|                                                                       |
+----------------------------------------------------------------------*/
#define FENCE_NO_CLIP                   0
#define FENCE_CLIP_ORIG                 1
#define FENCE_CLIP_COPY                 3

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlSystem_loadMdlProgramExtended                      |
|                                                                       |
+----------------------------------------------------------------------*/
#define LOADPROGRAM_APPLICATION_CLASS   1
#define LOADPROGRAM_MESSAGES            2
#define LOADPROGRAM_DEBUGGER            3
#define LOADPROGRAM_STARTUP_STRING      4
#define LOADPROGRAM_PARENT_NAME         5
#define LOADPROGRAM_STARTUP_TYPE        6

// this is the meaning of the output variable of mdlRefFile_getIntegerParameters with paramName set to REFERENCE_ACTIVATESTATUS
typedef enum ReferenceActivateStatus
{
REFERENCE_ACTIVATE_ReadOnly             = 0,
REFERENCE_ACTIVATE_Activated           = 1,
REFERENCE_ACTIVATE_WriteLocked         = 2,
} ReferenceActivateStatus;

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlView_getRenderParameters / setRenderParameters     |
|   Positive values are view dependent; negative are view independent   |
|                                                                       |
+----------------------------------------------------------------------*/
        /* view independent parameters */
#define RENDER_STEREO_SEPARATION                (- 1)
#define RENDER_MAX_POLYGON_SIZE                 (- 2)
#define RENDER_AMBIENT_INTENSITY                (- 3)
#define RENDER_FLASH_INTENSITY                  (- 4)
#define RENDER_SOLAR_INTENSITY                  (- 5)
#define RENDER_SOLAR_DIRECTION                  (- 6)
#define RENDER_LATITUDE                         (- 7)
#define RENDER_LONGITUDE                        (- 8)
#define RENDER_SOLAR_TIME_USE_CURRENT_TIME      (- 9)
#define RENDER_SOLAR_TIME_DST                   (-10)
#define RENDER_SOLAR_TIME_PM                    (-11)
#define RENDER_SOLAR_TIME_MONTH                 (-12)
#define RENDER_SOLAR_TIME_MINUTE                (-13)
#define RENDER_SOLAR_TIME_HOUR                  (-14)
#define RENDER_SOLAR_TIME_DAY                   (-15)
#define RENDER_NEAR_DEPTH_DENSITY               (-16)
#define RENDER_FAR_DEPTH_DENSITY                (-17)
#define RENDER_NEAR_DEPTH_DISTANCE              (-18)
#define RENDER_HAZE_COLOR                       (-19)
#define RENDER_SHADOW_TOLERANCE                 (-20)
#define RENDER_SOLAR_YEAR                       (-21)
#define RENDER_GMT_OFFSET                       (-22)
#define RENDER_FLASH_INTENSITY_SCALE            (-23)
#define RENDER_SOLAR_INTENSITY_SCALE            (-24)
#define RENDER_AMBIENT_INTENSITY_SCALE          (-25)
#define RENDER_AZIMUTH                          (-26)
#define RENDER_SOLAR_VECTOR_OVERRIDE            (-27)
#define RENDER_VECTOR_SHIFT                     (-28)
#define RENDER_BACKGROUND_FILE                  (-29)
#define RENDER_SOLAR_SHADOW_RES                 (-30)

#define RENDER_FLAG_RENDER_LINES_AS_VECTORS     (-40)
#define RENDER_FLAG_IGNORE_LINEAR               (-41)
#define RENDER_FLAG_SAVE_SHADOW_MAPS            (-42)
#define RENDER_FLAG_SOLAR_BY_VECTOR             (-43)
#define RENDER_FLAG_INTERPOLATE_TEXTURES        (-44)
#define RENDER_FLAG_SHADOW_FILTER               (-45)
#define RENDER_FLAG_SOLAR_SHADOWS               (-46)
#define RENDER_FLAG_ANTIALIAS_GRID              (-47)
#define RENDER_FLAG_FLASH_LIGHT                 (-48)
#define RENDER_FLAG_SOLAR_LIGHT                 (-49)
#define RENDER_FLAG_AMBIENT_LIGHT               (-50)

        /* view dependent parameters */
#define RENDER_CAMERA_ANGLE                      1
#define RENDER_CAMERA_FOCAL_LENGTH               2
#define RENDER_CAMERA_POSITION                   3

#define RENDER_VIEW_LEVELS                       4
#define RENDER_VIEW_ORIGIN                       5
#define RENDER_VIEW_DELTA                        6
#define RENDER_VIEW_TRANSMATRX                   7
#define RENDER_VIEW_CONVERSION                   8
#define RENDER_VIEW_ACTIVE_Z                     9

#define RENDER_VIEW_FLAGS_FAST_CURVE            10
#define RENDER_VIEW_FLAGS_FAST_TEXT             11
#define RENDER_VIEW_FLAGS_FAST_FONT             12
#define RENDER_VIEW_FLAGS_LINE_WGHTS            13
#define RENDER_VIEW_FLAGS_PATTERNS              14
#define RENDER_VIEW_FLAGS_TEXT_NODES            15
#define RENDER_VIEW_FLAGS_ED_FIELDS             16
#define RENDER_VIEW_FLAGS_ON_OFF                17
#define RENDER_VIEW_FLAGS_DELAY                 18
#define RENDER_VIEW_FLAGS_GRID                  19
#define RENDER_VIEW_FLAGS_LEV_SYMB              20
#define RENDER_VIEW_FLAGS_POINTS                21
#define RENDER_VIEW_FLAGS_CONSTRUCTS            22
#define RENDER_VIEW_FLAGS_DIMENS                23
#define RENDER_VIEW_FLAGS_FAST_CELL             24
#define RENDER_VIEW_FLAGS_DEF                   25

#define RENDER_EXT_FLAGS_FILL                   30
#define RENDER_EXT_FLAGS_RASTER_TEXT            31
#define RENDER_EXT_FLAGS_AUX_DISPLAY            32
#define RENDER_EXT_FLAGS_ORIENTATION_DISPLAY    33
#define RENDER_EXT_FLAGS_VIEW_RENDERED          34
#define RENDER_EXT_FLAGS_CAMERA                 35
#define RENDER_EXT_FLAGS_RENDER_MODE            36
#define RENDER_EXT_FLAGS_BACKGROUND             37
#define RENDER_EXT_FLAGS_REF_BOUNDARY_DISPLAY   38
#define RENDER_EXT_FLAGS_FAST_BOUNDARY_CLIP     39
#define RENDER_EXT_FLAGS_DEPTH_CUE              40
#define RENDER_EXT_FLAGS_INHIBIT_DYNAMICS       41
#define RENDER_EXT_FLAGS_APP_DISPLAY            42
#define RENDER_EXT_FLAGS_SHADOWS                43
#define RENDER_EXT_FLAGS_TEXTURE_MAPS           44
#define RENDER_EXT_FLAGS_HAZE                   45
#define RENDER_EXT_FLAGS_TRANSPARENCY           46
#define RENDER_EXT_FLAGS_SLOW_DITHER            47
#define RENDER_EXT_FLAGS_INHIBIT_LINE_STYLES    48
#define RENDER_EXT_FLAGS_ACCELERATED            49
#define RENDER_EXT_FLAGS_PATTERN_DYNAMICS       50
#define RENDER_EXT_FLAGS_HIDDEN_LINE            51
#define RENDER_EXT_FLAGS_TAGS_OFF               52
#define RENDER_EXT_FLAGS_DRAWING_VIEW           53
#define RENDER_EXT_FLAGS_RENDER_DISPLAY_EDGES   54
#define RENDER_EXT_FLAGS_RENDER_DISPLAY_HIDDEN  55

/*----------------------------------------------------------------------+
|                                                                       |
|   Constant for MicroStation BASIC linkage ID                          |
|                                                                       |
+----------------------------------------------------------------------*/
#define LINKAGEID_BASIC             43797

/*----------------------------------------------------------------------+
|                                                                       |
|   Constants for mdlTextFile_ functions                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define TEXTFILE_READ           0
#define TEXTFILE_WRITE          1
#define TEXTFILE_APPEND         2

#define TEXTFILE_DEFAULT            0x0
#define TEXTFILE_KEEP_NEWLINE       0x1
#define TEXTFILE_NO_NEWLINE         0x1
#define TEXTFILE_NEWLINES_TO_LINES  0x2