CFx SDK Documentation  2022 SP0
QuasiVarDefs.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2017, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Teigha(R) software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 
25 
26 #ifndef QVAR_DEF_RO
27 #define DOUNDEF_QVAR_DEF_RO
28 #define QVAR_DEF_RO QVAR_DEF
29 #endif
30 
31 #ifndef QVAR_DEF_RO
32 #define DOUNDEF_QVAR_DEF_RO
33 #define QVAR_DEF_RO QVAR_DEF
34 #endif
35 
36 
37 #ifndef ODTDIST
38 #define ODTDIST double
39 #define DOUNDEF_ODTDIST
40 #endif
41 
42 #ifndef ODTORIENT
43 #define ODTORIENT double
44 #define DOUNDEF_ODTORIENT
45 #endif
46 
47 #ifndef ODTANGLE
48 #define ODTANGLE double
49 #define DOUNDEF_ODTANGLE
50 #endif
51 
52 #ifndef ODTLAYOUTID
53 #define ODTLAYOUTID OdDbObjectId
54 #define DOUNDEF_ODTLAYOUTID
55 #endif
56 
57 #ifndef ODTTEXTSTYLEID
58 #define ODTTEXTSTYLEID OdDbObjectId
59 #define DOUNDEF_ODTTEXTSTYLEID
60 #endif
61 
62 #ifndef ODTBOOL
63 #define ODTBOOL bool
64 #define DOUNDEF_ODTBOOL
65 #endif
66 
67 /*
68 #ifdef DATE
69 #define SAVED_DATE_DEFINITION
70 #undef DATE
71 #endif
72 */
73 
74 //FELIX_CHANGE_BEGIN
75 // QVAR_DEF_2 is used for variables which have duplicate definition in SysVarDefs.h
76 #ifndef QVAR_DEF_2
77  #define UNDEF_QVAR_DEF_2
78  #define QVAR_DEF_2 QVAR_DEF
79 #endif
80 
81 #ifndef QVAR_DEF_RO_2
82  #define UNDEF_QVAR_DEF_RO_2
83  #define QVAR_DEF_RO_2 QVAR_DEF_RO
84 #endif
85 
86 // Type Name
87 
111 //<dom_var_def>double BACKZ;
112 QVAR_DEF_RO(ODTDIST, BACKZ, ValidateNone() )
113 
114 
135 //<dom_var_def>OdDbObjectId CTAB;
136 QVAR_DEF (ODTLAYOUTID, CTAB, ValidateLayout() )
137 
162 //<dom_var_def>OdString CPLOTSTYLE;
163 QVAR_DEF (OdString, CPLOTSTYLE, ValidateNone() )
164 
186 //<dom_var_def>OdInt16 CVPORT;
187 QVAR_DEF (OdInt16, CVPORT, ValidateNone() )
188 
214 //<dom_var_def>OdString DWGNAME;
215 QVAR_DEF_RO(OdString, DWGNAME, ValidateNone() )
216 
241 //<dom_var_def>OdString DWGPREFIX;
242 QVAR_DEF_RO(OdString, DWGPREFIX, ValidateNone() )
243 
270 //<dom_var_def>bool DWGTITLED;
271 QVAR_DEF_RO(ODTBOOL, DWGTITLED, ValidateNone() )
272 
273 QVAR_DEF_2 (ODTDIST, ELEVATION, ValidateNone() )
274 QVAR_DEF_RO_2(OdGePoint3d, EXTMAX, ValidateNone() )
275 QVAR_DEF_RO_2(OdGePoint3d, EXTMIN, ValidateNone() )
276 
300 //<dom_var_def>double FRONTZ;
301 QVAR_DEF_RO(ODTDIST, FRONTZ, ValidateNone() )
302 
330 //<dom_var_def>bool GRIDMODE;
331 QVAR_DEF (ODTBOOL, GRIDMODE, ValidateBOOL() )
332 
354 //<dom_var_def>OdGePoint2d GRIDUNIT;
355 QVAR_DEF (OdGePoint2d, GRIDUNIT, ValidateNone() )
356 
357 QVAR_DEF_2 (OdGePoint3d, INSBASE, ValidateNone() )
358 QVAR_DEF_RO_2(ODTDIST, LENSLENGTH, ValidateNone() )
359 QVAR_DEF_2 (ODTBOOL, LIMCHECK, ValidateBOOL() )
360 QVAR_DEF_2 (OdGePoint2d, LIMMAX, ValidateNone() )
361 QVAR_DEF_2 (OdGePoint2d, LIMMIN, ValidateNone() )
362 
386 //<dom_var_def>double SNAPANG;
387 QVAR_DEF (ODTANGLE, SNAPANG, ValidateNone() )
388 
410 //<dom_var_def>OdGePoint2d SNAPBASE;
411 QVAR_DEF (OdGePoint2d, SNAPBASE, ValidateNone() )
412 
444 //<dom_var_def>OdInt16 SNAPISOPAIR;
445 QVAR_DEF (OdInt16, SNAPISOPAIR, ValidateNone() )
446 
474 //<dom_var_def>OdInt16 SNAPMODE;
475 QVAR_DEF (ODTBOOL, SNAPMODE, ValidateBOOL() )
476 
507 //<dom_var_def>OdInt16 SNAPSTYL;
508 QVAR_DEF (ODTBOOL, SNAPSTYL, ValidateBOOL() )
509 
531 //<dom_var_def>OdGePoint2d SNAPUNIT;
532 QVAR_DEF (OdGePoint2d, SNAPUNIT, ValidateNone() )
533 
608 //<dom_var_def>OdCodePageId SYSCODEPAGE;
609 QVAR_DEF_RO(OdCodePageId, SYSCODEPAGE, ValidateNone() )
610 
632 //<dom_var_def>OdGePoint3d TARGET;
633 QVAR_DEF_RO(OdGePoint3d, TARGET, ValidateNone() )
634 
662 //<dom_var_def>bool UCSFOLLOW;
663 QVAR_DEF (ODTBOOL, UCSFOLLOW, ValidateBOOL() )
664 
694 //<dom_var_def>OdInt16 UCSICON;
695 QVAR_DEF (OdInt16, UCSICON, ValidateNone() )
696 
724 //<dom_var_def>bool UCSVP;
725 QVAR_DEF (ODTBOOL, UCSVP, ValidateBOOL() )
726 
727 QVAR_DEF_RO_2(ODTUCSNAME, UCSNAME, ValidateNone() )
728 QVAR_DEF_RO_2(OdGePoint3d, UCSORG, ValidateNone() )
729 QVAR_DEF_RO_2(OdGeVector3d, UCSXDIR, ValidateNone() )
730 QVAR_DEF_RO_2(OdGeVector3d, UCSYDIR, ValidateNone() )
731 
752 //<dom_var_def>OdGePoint3d VIEWCTR;
753 QVAR_DEF_RO(OdGePoint3d, VIEWCTR, ValidateNone() )
754 
775 //<dom_var_def>OdGeVector3d VIEWDIR;
776 QVAR_DEF_RO(OdGeVector3d, VIEWDIR, ValidateNone() )
777 
809 //<dom_var_def>OdInt16 VIEWMODE;
810 QVAR_DEF_RO(OdInt16, VIEWMODE, ValidateNone() )
811 
832 //<dom_var_def>double VIEWSIZE;
833 QVAR_DEF_RO(ODTDIST, VIEWSIZE, ValidateNone() )
834 
857 //<dom_var_def>double VIEWTWIST;
858 QVAR_DEF_RO(ODTORIENT, VIEWTWIST, ValidateNone() )
859 
886 //<dom_var_def>OdInt16 WORLDUCS;
887 QVAR_DEF_RO(OdInt16, WORLDUCS, ValidateNone() )
888 
889 QVAR_DEF_RO(OdString, LOGINNAME, ValidateNone() )
890 QVAR_DEF_RO(OdDbDate, DATE, ValidateNone() )
891 QVAR_DEF_RO(double, CDATE, ValidateNone() )
892 
893 //-----------------------------------------
894 // Variables added in AC 2008
895 //-----------------------------------------
896 
917 //<dom_var_def>double CANNOSCALEVALUE;
918 QVAR_DEF_RO(double, CANNOSCALEVALUE, ValidateNone() )
919 //FELIX_CHANGE_BEGIN
920 //QVAR_DEF (ODTBOOL, ANNOALLVISIBLE, ValidateBOOL() )
921 //FELIX_CHANGE_END
951 //<dom_var_def>bool DIMANNO;
952 QVAR_DEF_RO(ODTBOOL, DIMANNO, ValidateNone() )
953 
954 /* TODO:
955  GRIDMAJOR
956 */
957 
958 QVAR_DEF (ODTBOOL, PERSPECTIVE, ValidateNone() )
959 QVAR_DEF_2 (OdInt16, DIMUNIT, ValidateNone() )
960 
961 //-----------------------------------------
962 // Variables added in AC 2010
963 //-----------------------------------------
964 
978 QVAR_DEF (OdInt16, IMAGEFRAME, ValidateNone() )
979 QVAR_DEF_2 (OdInt16, FRAME, ValidateNone() )
980 QVAR_DEF_2 (OdInt16, PDFFRAME, ValidateNone() )
981 QVAR_DEF_2 (OdInt16, XCLIPFRAME, ValidateNone() )
982 QVAR_DEF_2 (OdInt8, DWFFRAME, ValidateNone() )
983 //FELIX_CHANGE_BEGIN
984 //bug 39795
985 QVAR_DEF_2 (OdInt8, DGNFRAME, /*ValidateNone()*/ValidateRange(0,2) )
986 //FELIX_CHANGE_END
987 QVAR_DEF (OdInt8, OLEFRAME, ValidateNone() )
988 QVAR_DEF_2 (OdInt16, WIPEOUTFRAME, ValidateNone() )
989 QVAR_DEF_2 (OdInt16, POINTCLOUDCLIPFRAME, ValidateNone() )
990 
991 QVAR_DEF_2 (ODTTEXTSTYLEID, TEXTSTYLE, ValidateTextStyle())
992 //FELIX_CHANGE_BEGIN
993 //bug 31183
994 QVAR_DEF_2 (double, TEXTSIZE, /*ValidateNone()*/ValidatePositiveNonZero() )
995 //FELIX_CHANGE_END
996 
1030 //<dom_var_def>OdInt16 GRIDDISPLAY;
1031 QVAR_DEF (OdInt16, GRIDDISPLAY, ValidateNone() )
1032 
1068 //<dom_var_def>OdInt16 GRIDMAJOR;
1069 QVAR_DEF (OdInt16, GRIDMAJOR, ValidateNone() )
1070 
1071 QVAR_DEF (OdInt16, VSBACKGROUNDS, ValidateNone() )
1072 
1113 //<dom_var_def>OdString VSEDGECOLOR;
1114 QVAR_DEF (OdString, VSEDGECOLOR, ValidateNone() )
1115 
1164 //<dom_var_def>OdInt16 VSEDGEJITTER;
1165 QVAR_DEF (OdInt16, VSEDGEJITTER, ValidateNone() )
1166 
1206 //<dom_var_def>OdInt16 VSEDGELEX;
1207 QVAR_DEF (OdInt16, VSEDGELEX, ValidateNone() )
1208 
1248 //<dom_var_def>OdInt16 VSEDGEOVERHANG;
1249 QVAR_DEF (OdInt16, VSEDGEOVERHANG, ValidateNone() )
1250 
1296 //<dom_var_def>OdInt16 VSEDGES;
1297 QVAR_DEF (OdInt16, VSEDGES, ValidateNone() )
1298 
1337 //<dom_var_def>OdInt16 VSEDGESMOOTH;
1338 QVAR_DEF (OdInt16, VSEDGESMOOTH, ValidateNone() )
1339 
1386 //<dom_var_def>OdInt16 VSFACECOLORMODE;
1387 QVAR_DEF (OdInt16, VSFACECOLORMODE, ValidateNone() )
1388 
1429 //<dom_var_def>OdInt16 VSFACEHIGHLIGHT;
1430 QVAR_DEF (OdInt16, VSFACEHIGHLIGHT, ValidateNone() )
1431 
1471 //<dom_var_def>OdInt16 VSFACEOPACITY;
1472 QVAR_DEF (OdInt16, VSFACEOPACITY, ValidateNone() )
1473 
1519 //<dom_var_def>OdInt16 VSFACESTYLE;
1520 QVAR_DEF (OdInt16, VSFACESTYLE, ValidateNone() )
1521 
1560 //<dom_var_def>OdInt16 VSHALOGAP;
1561 QVAR_DEF (OdInt16, VSHALOGAP, ValidateNone() )
1562 
1603 //<dom_var_def>OdString VSINTERSECTIONCOLOR;
1604 QVAR_DEF (OdString, VSINTERSECTIONCOLOR, ValidateNone() )
1605 
1650 //<dom_var_def>OdInt16 VSINTERSECTIONEDGES;
1651 QVAR_DEF (OdInt16, VSINTERSECTIONEDGES, ValidateNone() )
1652 
1706 //<dom_var_def>OdInt16 VSINTERSECTIONLTYPE;
1707 QVAR_DEF (OdInt16, VSINTERSECTIONLTYPE, ValidateNone() )
1708 
1753 //<dom_var_def>OdInt16 VSISOONTOP;
1754 QVAR_DEF (OdInt16, VSISOONTOP, ValidateNone() )
1755 
1801 //<dom_var_def>OdInt16 VSLIGHTINGQUALITY;
1802 QVAR_DEF (OdInt16, VSLIGHTINGQUALITY, ValidateNone() )
1803 
1849 //<dom_var_def>OdInt16 VSMATERIALMODE;
1850 QVAR_DEF (OdInt16, VSMATERIALMODE, ValidateNone() )
1851 
1891 //<dom_var_def>OdString VSMONOCOLOR;
1892 QVAR_DEF (OdString, VSMONOCOLOR, ValidateNone() )
1893 
1934 //<dom_var_def>OdString VSOBSCUREDCOLOR;
1935 QVAR_DEF (OdString, VSOBSCUREDCOLOR, ValidateNone() )
1936 
1981 //<dom_var_def>OdInt16 VSOBSCUREDEDGES;
1982 QVAR_DEF (OdInt16, VSOBSCUREDEDGES, ValidateNone() )
1983 
2053 //<dom_var_def>OdInt16 VSOBSCUREDLTYPE;
2054 QVAR_DEF (OdInt16, VSOBSCUREDLTYPE, ValidateNone() )
2055 
2096 //<dom_var_def>OdString VSOCCLUDEDCOLOR;
2097 QVAR_DEF (OdString, VSOCCLUDEDCOLOR, ValidateNone() )
2098 
2143 //<dom_var_def>OdInt16 VSOCCLUDEDEDGES;
2144 QVAR_DEF (OdInt16, VSOCCLUDEDEDGES, ValidateNone() )
2145 
2218 //<dom_var_def>OdInt16 VSOCCLUDEDLTYPE;
2219 QVAR_DEF (OdInt16, VSOCCLUDEDLTYPE, ValidateNone() )
2220 
2269 //<dom_var_def>OdInt16 VSSHADOWS;
2270 QVAR_DEF (OdInt16, VSSHADOWS, ValidateNone() )
2271 
2335 //<dom_var_def>OdInt16 VSSILHEDGES;
2336 QVAR_DEF (OdInt16, VSSILHEDGES, ValidateNone() )
2337 
2379 //<dom_var_def>OdInt16 VSSILHWIDTH;
2380 QVAR_DEF (OdInt16, VSSILHWIDTH, ValidateNone() )
2381 
2437 //<dom_var_def>OdInt16 NAVVCUBEDISPLAY;
2438 QVAR_DEF (OdInt16, NAVVCUBEDISPLAY, ValidateRange(0, 3))
2439 
2482 //<dom_var_def>OdInt16 DEFAULTLIGHTING;
2483 QVAR_DEF (OdInt16, DEFAULTLIGHTING, ValidateRange(0, 1))
2484 
2528 //<dom_var_def>OdInt16 DEFAULTLIGHTINGTYPE;
2529 QVAR_DEF (OdInt16, DEFAULTLIGHTINGTYPE, ValidateRange(0, 1))
2530 
2531 #ifdef UNDEF_QVAR_DEF_2
2532  #undef QVAR_DEF_2
2533 #endif
2534 
2535 #ifdef UNDEF_QVAR_DEF_RO_2
2536  #undef QVAR_DEF_RO_2
2537 #endif
2538 //FELIX_CHANGE_END
2539 
2540 #ifdef DOUNDEF_ODTDIST
2541 #undef ODTDIST
2542 #undef DOUNDEF_ODTDIST
2543 #endif
2544 
2545 #ifdef DOUNDEF_ODTORIENT
2546 #undef ODTORIENT
2547 #undef DOUNDEF_ODTORIENT
2548 #endif
2549 
2550 #ifdef DOUNDEF_ODTANGLE
2551 #undef ODTANGLE
2552 #undef DOUNDEF_ODTANGLE
2553 #endif
2554 
2555 #ifdef DOUNDEF_ODTLAYOUTID
2556 #undef ODTLAYOUTID
2557 #undef DOUNDEF_ODTLAYOUTID
2558 #endif
2559 
2560 #ifdef DOUNDEF_ODTTEXTSTYLEID
2561 #undef ODTTEXTSTYLEID
2562 #undef DOUNDEF_ODTTEXTSTYLEID
2563 #endif
2564 
2565 #ifdef DOUNDEF_QVAR_DEF_RO
2566 #undef QVAR_DEF_RO
2567 #undef DOUNDEF_QVAR_DEF_RO
2568 #endif
2569 
2570 #ifdef DOUNDEF_ODTBOOL
2571 #undef ODTBOOL
2572 #undef DOUNDEF_ODTBOOL
2573 #endif
ValidateBOOL
ValidateBOOL()) VAR_DEF(ODTORIENT
ValidateRange
ValidateRange(0, 8)) VAR_DEF(double
ValidateNone
ValidateNone()) VAR_DEF(OdUInt16
ValidatePositiveNonZero
ValidatePositiveNonZero()) VAR_DEF(bool
ValidateTextStyle
ValidateTextStyle(NullIdAllowed)) VAR_DEF(ODTDIST
ODTUCSNAME
#define ODTUCSNAME
Definition: FxDatabase.h:221
QVAR_DEF
#define QVAR_DEF(type, name, validator)
Definition: FxDatabase.h:245
OdCodePageId
OdCodePageId
Definition: OdCodePage.h:31
OdInt16
short OdInt16
Definition: OdPlatformSettings.h:756
OdInt8
signed char OdInt8
Definition: OdPlatformSettings.h:755
QVAR_DEF_RO_2
#define QVAR_DEF_RO_2
Definition: QuasiVarDefs.h:83
QVAR_DEF_RO
#define QVAR_DEF_RO
Definition: QuasiVarDefs.h:28
ODTORIENT
#define ODTORIENT
Definition: QuasiVarDefs.h:43
QVAR_DEF_2
#define QVAR_DEF_2
Definition: QuasiVarDefs.h:78
ODTDIST
#define ODTDIST
Definition: QuasiVarDefs.h:38
TEXTSIZE
TEXTSIZE
Definition: QuasiVarDefs.h:994
ODTLAYOUTID
#define ODTLAYOUTID
Definition: QuasiVarDefs.h:53
ODTTEXTSTYLEID
#define ODTTEXTSTYLEID
Definition: QuasiVarDefs.h:58
ODTANGLE
#define ODTANGLE
Definition: QuasiVarDefs.h:48
ODTBOOL
#define ODTBOOL
Definition: QuasiVarDefs.h:63
EXTMIN
EXTMIN
Definition: SysVarDefs.h:422
UCSNAME
UCSNAME
Definition: SysVarDefs.h:2851
XCLIPFRAME
XCLIPFRAME
Definition: SysVarDefs.h:6738
LIMMIN
LIMMIN
Definition: SysVarDefs.h:498
LIMCHECK
LIMCHECK
Definition: SysVarDefs.h:1645
TEXTSTYLE
TEXTSTYLE
Definition: SysVarDefs.h:861
PDFFRAME
PDFFRAME
Definition: SysVarDefs.h:6702
POINTCLOUDCLIPFRAME
const OdCmTransparency const OdCmTransparency const OdCmColor const OdCmColor const OdCmColor const OdCmColor const OdCmTransparency const OdCmTransparency POINTCLOUDCLIPFRAME
Definition: SysVarDefs.h:7063
WIPEOUTFRAME
const OdCmTransparency const OdCmTransparency const OdCmColor const OdCmColor const OdCmColor const OdCmColor const OdCmTransparency const OdCmTransparency WIPEOUTFRAME
Definition: SysVarDefs.h:7028
EXTMAX
EXTMAX
Definition: SysVarDefs.h:452
DWFFRAME
DWFFRAME
Definition: SysVarDefs.h:6506
DGNFRAME
DGNFRAME
Definition: SysVarDefs.h:6542
LIMMAX
LIMMAX
Definition: SysVarDefs.h:544
INSBASE
INSBASE
Definition: SysVarDefs.h:389
UCSORG
UCSORG
Definition: SysVarDefs.h:3937
ELEVATION
ELEVATION
Definition: SysVarDefs.h:1541
UCSXDIR
UCSXDIR
Definition: SysVarDefs.h:3968
LENSLENGTH
LENSLENGTH
Definition: SysVarDefs.h:6301
UCSYDIR
UCSYDIR
Definition: SysVarDefs.h:4000
FRAME
FRAME
Definition: SysVarDefs.h:6687
Generated on Fri Jan 22 2021 18:01:49