///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
// This application incorporates Open Design Alliance software pursuant to a license
// agreement with Open Design Alliance.
// Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
#ifndef QVAR_DEF_RO
#define DOUNDEF_QVAR_DEF_RO
#define QVAR_DEF_RO QVAR_DEF /*!DOM*/
#endif
#ifndef QVAR_DEF_RO
#define DOUNDEF_QVAR_DEF_RO
#define QVAR_DEF_RO QVAR_DEF /*!DOM*/
#endif
#ifndef ODTDIST
#define ODTDIST double /*!DOM*/
#define DOUNDEF_ODTDIST
#endif
#ifndef ODTORIENT
#define ODTORIENT double /*!DOM*/
#define DOUNDEF_ODTORIENT
#endif
#ifndef ODTANGLE
#define ODTANGLE double /*!DOM*/
#define DOUNDEF_ODTANGLE
#endif
#ifndef ODTLAYOUTID
#define ODTLAYOUTID OdDbObjectId /*!DOM*/
#define DOUNDEF_ODTLAYOUTID
#endif
#ifndef ODTTEXTSTYLEID
#define ODTTEXTSTYLEID OdDbObjectId /*!DOM*/
#define DOUNDEF_ODTTEXTSTYLEID
#endif
#ifndef ODTBOOL
#define ODTBOOL bool /*!DOM*/
#define DOUNDEF_ODTBOOL
#endif
/*
#ifdef DATE
#define SAVED_DATE_DEFINITION
#undef DATE
#endif
*/
// Type Name
/**
Type double
Initial value 0.0
Read-Only Yes
Saved In Database
Versions R12+
BACKZ specifies the back clipping distance for the current viewport.
Type OdInt16
Initial value 0
Read-Only Yes
Saved In Database
Versions R12+
VIEWMODE specifies the view mode for the current viewport. VIEWMODE will be the sum of
zero or more of the following:
ValueDescription
0x00 Disabled
0x01 Perspective enabled
0x02 Front clip enabled
0x04 Back clip enabled
0x08 UCS follow enabled
0x10 Front clipping plane not at eye
Type bool
Initial value true
Read-Only No
Saved In Database
Versions 2008+
The ANNOALLVISIBLE specifies whether to hide or display annotative entities that do not support the current annotation scale.
ValueDescription
false Only annotative entities that support the current scale representation are displayed.
true All annotative entities are displayed.
Type OdInt16
Initial value 3
Read-Only No
Saved In Database
Versions 2010+
The FRAME specifies visibility of frames for XRefs images and underlays. This variable is valid in range [0..3].
Overrides the IMAGEFRAME, DWFFRAME, PDFFRAME, DGNFRAME and XCLIPFRAME variables unless the value 3 is used for this variable
that instructs not to override.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
3 Use individual system variables
Type OdInt16
Initial value 1
Read-Only No
Saved In Database
Versions 2010+
The PDFFRAME specifies visibility of PDF underlay frames. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt16
Initial value 2
Read-Only No
Saved In Database
Versions 2010+
The XCLIPFRAME specifies visibility of XRef clipping boundaries. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt8
Initial value 2
Read-Only No
Saved In Database
Versions 2010+
The DWFFRAME specifies visibility of DWF or DWFx underlay frames. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt8
Initial value 2
Read-Only No
Saved In Database
Versions 2010+
The DGNFRAME specifies visibility of DGN frames. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt8
Initial value 2
Read-Only No
Saved In Database
Versions 2005+
The OLEFRAME specifies visibility of a frame around OLE objects. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt16
Initial value 1
Read-Only No
Saved In Database
Versions 2013+
The WIPEOUTFRAME specifies visibility of a frame for wipeout entities. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt8
Initial value -
Read-Only No
Saved In Database
Versions N/A
The POINTCLOUDCLIPFRAME specifies visibility of a frame for clipping boundaries on legacy point clouds. This variable is valid in range [0..2].
This variable takes effect if FRAME system variable is set to 3.
ValueDescription
0 Invisible
1 Is displayed and plotted
2 Is displayed but not plotted
Type OdInt16
Initial value 2
Range 0 ... 15
Read-Only No
Saved In Nondatabase, Quasi variable
Versions 2007+
The GRIDDISPLAY variable controls the display behavior and display limits of the grid.
The setting is stored as a bitcode using the sum of the following values:
ValueDescription
0 Restricts the grid to the area specified by the LIMITS command.
1 Does not restrict the grid to the area specified by the LIMITS command.
2 Turns on adaptive grid display, which limits the density of the grid when zoomed out.
4 If the grid is set to adaptive display and when zoomed in, generates additional, more closely spaced grid lines in the same proportion as the intervals of the major grid lines.
8 Changes the grid plane to follow the XY plane of the dynamic UCS (if value is 2, this setting is ignored).
For example, to get the value:
OdRusBufPtr pRb = pDb-\>getSysVar(L"GRIDMAJOR");
OdInt16 major = pRb-\>getInt16();
odPrintConsoleString(L"nGrid major = %d", major);
For example, to set the value:
OdRusBufPtr pRb = OdResBuf::newRb(OdResBuf::kRtInt16, 10);
pDb-\>setSysVar(L"GRIDMAJOR", pRb);
*/
//OdInt16 GRIDMAJOR;
QVAR_DEF (OdInt16, GRIDMAJOR, ValidateNone() )
/**
Type OdInt16
Initial value N/A
Read-Only No
Saved In Nondatabase, Quasi variable
Versions N/A
The VSBACKGROUNDS variable specifies whether backgrounds are displayed in the visual style applied to the current viewport.
\remarks
This system variable does not modify an existing visual style. Instead, it creates a temporary new visual style with the setting changed.
*/
//OdInt16 VSBACKGROUNDS;
QVAR_DEF (OdInt16, VSBACKGROUNDS, ValidateNone() )
/**
Type OdString
Initial value "ByEntity"
Read-Only No
Saved In Database
Versions 2007+
The VSEDGECOLOR variable stores the tint of edges in the visual style for the current viewport.
TrueColor value is set as follows: "RGB:XXX,XXX,XXX", where XXX is the color component value in
the range 0 to 255. Value 0 defines a color ByBlock, value 256 defines a color ByLayer, value 257
defines a color ByEntity, values 1 to 255 define the ACI color.
Note: An existing visual style is not changed when the system variable gets a new value.
Temporary visual style will be created as a clone of visual style assigned for current viewport.
For example, to get the value:
OdRusBufPtr pRb = pDb-\>getSysVar(L"VSEDGECOLOR");
OdString tint = pRb-\>getString();
odPrintConsoleString(L"nColor of edges = %s", tint);
For example, to set the value:
OdRusBufPtr pRb = OdResBuf::newRb(OdResBuf::kRtString, L"RGB:128,128,128");
pDb-\>setSysVar(L"VSEDGECOLOR", pRb);
*/
//OdString VSEDGECOLOR;
QVAR_DEF (OdString, VSEDGECOLOR, ValidateNone() )
/**
Type OdInt16
Initial value (-2)
Read-Only No
Saved In Database
Versions 2010+
The VSEDGEJITTER variable switches the display of edges to be viewed with several linear streaks,
as if the edges were sketched using a pencil. The value defines the number of jitters which can be:
ValueDescription
1 Low jitters
2 Medium jitters
3 High jitters
A negative value turns off the sketch effect, but the variable continues to store the number of jitters.
Note: An existing visual style is not changed when the system variable gets a new value.
Temporary visual style will be created as a clone of visual style assigned for current
viewport.
For example, to get the value:
OdRusBufPtr pRb = pDb-\>getSysVar(L"VSEDGEJITTER");
OdInt16 jitters = pRb-\>getInt16();
odPrintConsoleString(L"nJitters = %d", jitters);
For example, to set the value:
OdRusBufPtr pRb = OdResBuf::newRb(OdResBuf::kRtInt16, 1);
pDb-\>setSysVar(L"VSEDGEJITTER", pRb)
*/
//OdInt16 VSEDGEJITTER;
QVAR_DEF (OdInt16, VSEDGEJITTER, ValidateNone() )
/**
Type OdInt16
Initial value (-6)
Read-Only No
Saved In Nondatabase, Quasi variable
Versions 2011+
The VSEDGELEX variable allows edges to extend beyond their intersection for 3D entities.
The admissible range is 1 to 100 pixels. A negative value turns off the line extensions
effect, but the variable continues to store the previous setting.
Note: An existing visual style is not changed when the system variable gets a new value.
Temporary visual style will be created as a clone of visual style assigned for current viewport.
For example, to get the value:
OdRusBufPtr pRb = pDb-\>getSysVar(L"VSEDGELEX");
OdInt16 effect = pRb-\>getInt16();
odPrintConsoleString(L"nLine extensions effect = %d", effect);
For example, to set the value:
OdRusBufPtr pRb = OdResBuf::newRb(OdResBuf::kRtInt16, 10);
pDb-\>setSysVar(L"VSEDGELEX", pRb);
*/
//OdInt16 VSEDGELEX;
QVAR_DEF (OdInt16, VSEDGELEX, ValidateNone() )
/**