gre/base.h

Go to the documentation of this file.

/**
 * \file gre/base.h <gre/base.h>
 * \brief Base GRE definitions
 *
 * \if NODOC
 * $Id: base.h_v 1.56 2006/12/11 16:28:12 mju Exp $
 *
 * $Log: base.h_v $
 * Revision 1.56  2006/12/11 16:28:12  mju
 * Remove unused deprecated typedefs.
 *
 * Revision 1.55  2006/12/08 14:29:57  mju
 * Remove unused legacy typedefs.
 *
 * Revision 1.54  2006/12/05 16:05:50  mju
 * Remove unused deprecated typedef.
 *
 * Revision 1.53  2006/09/28 13:47:34  mju
 * Don't need elemparms hdr here anymore.
 *
 * Revision 1.52  2006/09/27 17:03:43  mju
 * Remove unused legacy names.
 *
 * Revision 1.51  2006/09/21 22:00:42  mju
 * Move element parameters and their required headers to elemparms hdr.
 *
 * Revision 1.50  2006/09/18 13:53:02  mju
 * Use styletype hdr.
 *
 * Revision 1.49  2006/09/15 17:57:46  mju
 * Add geometric3d decl.
 *
 * Revision 1.48  2006/09/15 15:29:30  mju
 * Add serializerbase hdr.
 *
 * Revision 1.47  2006/09/14 17:18:12  mju
 * Fwd decl scriptcontext.
 *
 * Revision 1.46  2006/09/08 20:03:04  mju
 * Fwd declare wireframe.
 *
 * Revision 1.45  2006/04/13 16:24:28  dwilliss
 * doxygen problem
 *
 * Revision 1.44  2006/03/31 16:14:46  mju
 * Had red/blue swapped in uicolor values.
 *
 * Revision 1.43  2006/03/24 16:17:02  mju
 * Add datatip predefined enum and member.
 *
 * Revision 1.42  2006/02/21 18:35:21  mju
 * Mark datatipparms.unitSTored for deletion.
 *
 * Revision 1.41  2006/01/10 21:27:30  mju
 * Add uicolor defns.
 *
 * Revision 1.40  2005/11/14 21:49:30  mju
 * Exclude deprecated items if deprecate_all defined.
 *
 * Revision 1.39  2005/11/11 22:51:25  mju
 * Remove group namelen constant.
 *
 * Revision 1.38  2005/11/04 18:51:38  mju
 * Put rest of gre enums in namespace.
 *
 * Revision 1.37  2005/11/03 15:41:11  mju
 * Remove last mfc defn.
 *
 * Revision 1.36  2005/11/02 23:00:34  mju
 * Remove objmgr stuff.
 *
 * Revision 1.35  2005/11/02 21:32:02  mju
 * Remove most mfc stuff.
 *
 * Revision 1.34  2005/10/27 13:31:28  mju
 * Deprecate legacy typedefs.
 *
 * Revision 1.33  2005/10/14 17:29:53  mju
 * GRE namespace.
 *
 * Revision 1.31  2005/09/14 21:52:59  mju
 * Add rendertarget_GroupActiveElems.
 *
 * Revision 1.30  2005/07/19 17:05:54  mju
 * Add rendertarget_GroupMatte.
 *
 * Revision 1.29  2005/05/20 20:31:47  mju
 * Change datatip member to positive name.
 *
 * Revision 1.28  2005/05/17 17:35:58  mju
 * Add noHighlight to datatipparms.
 *
 * Revision 1.27  2005/05/03 15:02:17  mju
 * Add rendertarget_None.
 *
 * Revision 1.26  2005/05/02 17:43:28  mju
 * Add drawflag_useDataTipColor.
 *
 * Revision 1.25  2005/04/29 18:07:10  mju
 * Fix enum order.
 *
 * Revision 1.24  2005/04/29 17:49:06  mju
 * Add rendertarget enum.
 *
 * Revision 1.23  2005/03/31 16:57:05  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.22  2005/03/01 22:59:45  scowan
 * Removed unused all background flag.
 *
 * Revision 1.21  2005/03/01 14:20:27  mju
 * Remove unused/unneeded drawflag values.
 *
 * Revision 1.20  2005/02/24 18:52:07  mju
 * Add drawflag_erase.
 *
 * Revision 1.19  2005/02/23 16:55:45  mju
 * Add drawflag_onlyHighlighted.
 *
 * Revision 1.18  2005/02/21 18:45:55  mju
 * Add drawflags for noHighlighting and includeUnhighlighted.
 *
 * Revision 1.17  2005/02/18 22:34:10  mju
 * Add drawflag_ViewInView.
 *
 * Revision 1.16  2005/02/18 17:05:51  mju
 * Add drawflag_NoUpdateScreen.
 *
 * Revision 1.15  2005/02/15 15:37:50  mju
 * Remove unused drawflags.
 *
 * Revision 1.14  2005/02/14 18:52:31  mju
 * Add groupview decl.
 *
 * Revision 1.13  2005/01/20 16:53:37  mju
 * Add enums for listpos, drawflags, highlightmode.
 * Move some defns here from mdisp.
 *
 * Revision 1.12  2004/07/21 21:55:39  mju
 * Add layerview decl, move labelplacement decls here.
 *
 * Revision 1.11  2004/04/30 14:04:23  mju
 * Fwd declare callback_msg.
 *
 * Revision 1.10  2004/03/12 20:51:01  mju
 * Add copy ctor/op= for datatipparms.
 *
 * Revision 1.9  2004/03/12 18:19:26  mju
 * Change datatipparms prefix/suffix to be mistring.
 *
 * Revision 1.8  2004/03/04 18:57:24  mju
 * Move more shared stuff here.
 *
 * Revision 1.7  2004/02/06 16:00:50  mju
 * Add GRE_FIND_FLAGS enum.
 *
 * Revision 1.4  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/07/30 14:43:49  mju
 * Ignore forward decls.
 *
 * Revision 1.1  2003/06/16 19:39:13  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_BASE_H
#define  INC_GRE_BASE_H

#ifndef  INC_MI32_STDDEFNS_H
   #include <mi32/stddefns.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward-declare classes.

namespace GRE {
   struct AUTOLABELPARMS;
   class CTRL_TREEVIEW;
   struct DATATIPPARMS;
   class ELEMSAMPLE_DC;
   class GEOMETRIC3D;
   class GROUP;
   class GROUPVIEW;
   struct LABELPARMS;
   class LABELPLACE;
   class LABELPLACEMENT;
   class LAYER;
   class LAYER_CAD;
   class LAYER_FORMULA;
   class LAYER_LEGEND;
   class LAYER_LEGEND2;
   class LAYER_MAPGRID;
   class LAYER_PINMAP;
   class LAYER_RASTER;
   class LAYER_REGION;
   class LAYER_SCALEBAR;
   class LAYER_SCRIPT;
   class LAYER_SHAPE;
   class LAYER_SKETCH;
   class LAYER_SURFACE;
   class LAYER_TEXT;
   class LAYER_TIN;
   class LAYER_VECTOR;
   class LAYERDC;
   class LAYERVIEW;
   class LAYOUT;
   class LEGEND;
   struct LEGENDPARMS;
   struct LINEPARMS;
   class MSG;
   class OBJECT;
   struct POINTPARMS;
   struct POLYPARMS;
   class SCRIPTCONTEXT_DRAW;
   class SCRIPTCONTEXT_STYLE;
   struct SELECTPARMS;
   struct STYLEPARMS;
   class TOOL;
   class VIEW;
   class VIEWABLE;
   class VIEWPOINT3D;
   class WIREFRAME;
   }

#endif // GENERATING_DOXYGEN_OUTPUT


#define  GRE_SERIAL_VERSION   3

namespace GRE {

//! Position in list for use in creation and reordering.
enum LISTPOS {
   LISTPOS_First =   0,
   LISTPOS_After =   1,
   LISTPOS_Before =  2,
   LISTPOS_Last =    3
   };

//! Condition for redrawing views.
enum DRAWCONDITION {
   DRAWCONDITION_Always,         //!< Always draw
   DRAWCONDITION_IfNeeded,       //!< Only draw if has changed
   DRAWCONDITION_IfAutoUpdate    //!< Only draw if auto-update preference is on and has changed
   };

//! Drawing flags.
enum DRAWFLAGS {
   DRAWFLAG_None =                  0x00000000,
   DRAWFLAG_ViewInView =            0x00000001, //!< Draw to view-in-view buffer
   DRAWFLAG_OnlyHighlighted =       0x00000002, //!< Only draw 'highlighted' elements
   DRAWFLAG_Erase =                 0x00000010, //!< Erase elements (for GRE::VIEW::DrawLayerElement/s)
   DRAWFLAG_ForceDraw =             0x00000020, //!< Force all specified elements to draw even if not "selected"
   DRAWFLAG_UpdateSearchTree =      0x00000040, //!< Update search tree when drawing even if in tree already
   DRAWFLAG_UpdateScreen =          0x00000080, //!< Refresh screen after drawing
   DRAWFLAG_NoUpdateScreen =        0x00000100, //!< Disable screen refresh after drawing
   DRAWFLAG_NoHighlighting =        0x00000200, //!< Draw elements without highlighting
   DRAWFLAG_UpdateBuffers =         0x00000400, //!< Update render buffers
   DRAWFLAG_SelectChanged =         DRAWFLAG_UpdateBuffers,
   DRAWFLAG_AllNonLocViews =        0x00001000, //!< Draw all non-locator views
   DRAWFLAG_NoMessage =             0x00004000, //!< Don't display messages while drawing
   DRAWFLAG_Wireframe =             0x00008000, //!< Only draw wireframes
   DRAWFLAG_NoResumeTool =          0x00010000, //!< Don't "resume" tool after drawing view
   DRAWFLAG_NoBlankScreen =         0x00040000, //!< Don't "blank" screen when start drawing view
   DRAWFLAG_NoCallbacks =           0x00400000, //!< Don't invoke callback lists while drawing
   DRAWFLAG_CheckDrawnSet =         0x00800000, //!< Check "drawn" set for highlighting
   DRAWFLAG_ReduceSpeckle3D =       0x01000000, //!< Perform 3D background speckle reduction
   DRAWFLAG_UseDataTipColor =       0x02000000, //!< Draw in 'datatip element' color.
   DRAWFLAG_UseHighlightColor =     0x04000000, //!< Draw elements in "highlight" color
   DRAWFLAG_UseActiveColor =        0x08000000, //!< Draw element in "active" color
   DRAWFLAG_NoCheckVisible =        0x10000000, //!< Don't check visiblity of layer/group in view
   DRAWFLAG_LabelPlacementPass =    0x20000000, //!< Internal use: 2nd pass to render just labels
   };
DEFINE_ENUM_OP_BITWISE(DRAWFLAGS)

//! Flags for "find" methods.
enum FINDFLAGS {
   FINDFLAG_ViewCoords =      0x0000,  //!< Point given in "view" coordinates
   FINDFLAG_DisplayCoords =   0x0001,  //!< Point given in "display" coordinates
   FINDFLAG_LayerCoords =     0x0002,  //!< Point given in "layer" (object) coordinates
   FINDFLAG_UseClosest =      0x0004,  //!< Return closest if no other found
   FINDFLAG_NoSingleLayer =   0x0008,  //!< Don't check single-layer groups
   FINDFLAG_No3D =            0x0010,  //!< Don't check 3-D groups
   FINDFLAG_SearchDrawnSet =  0x0020,  //!< Only search the "drawn" element set
   FINDFLAG_MapCoords =       0x0040   //!< Point given in "map" coordinates
   };
DEFINE_ENUM_OP_BITWISE(FINDFLAGS)

//! Targets for rendering individual elements.
enum RENDERTARGET {
   RENDERTARGET_None =              0x0000,
   RENDERTARGET_LayerNormal =       0x0001,     //!< Layer buffer for unhighlighted elements
   RENDERTARGET_LayerHighlight =    0x0002,     //!< Layer buffer for highlighted elements
   RENDERTARGET_LayerLabel =        0x0004,     //!< Layer buffer for labels
   RENDERTARGET_LayerAll =          0x0007,     //!< All layer buffers
   RENDERTARGET_Group =             0x0010,     //!< Group combined buffer
   RENDERTARGET_GroupActiveElems =  0x0020,     //!< Group 'active elements' buffer
   RENDERTARGET_GroupMatte =        0x0040,     //!< Group matte buffer
   RENDERTARGET_GroupOverlay =      0x0080,     //!< Group overlay buffer
   RENDERTARGET_GroupAll =          0x00F0,     //!< All group buffers
   RENDERTARGET_ViewMemory =        0x1000,     //!< View memory buffer
   RENDERTARGET_ViewScreen =        0x8000      //!< View screen (unbuffered)
   };
DEFINE_ENUM_OP_BITWISE(RENDERTARGET)

//! Mode for highlighing elements.
enum HIGHLIGHTMODE {
   HIGHLIGHTMODE_NotSet =     0,    //!< Not set, use parent's setting
   HIGHLIGHTMODE_Replace =    1,    //!< Replace selected set with elements provided
   HIGHLIGHTMODE_Add =        2,    //!< Add elements provided to selected set
   HIGHLIGHTMODE_Subtract =   3,    //!< Subtract elements from selected set
   HIGHLIGHTMODE_Toggle =     4,    //!< Toggle selection status of elements
   };

// Colors for user interface elements.
const UINT32 UICOLOR_TextNormal =            0x00000000;
const UINT32 UICOLOR_TextDim =               0x00505050;    // Gray
const UINT32 UICOLOR_TextNotVisibleAtScale = 0x00208020;    // Dark Green
const UINT32 UICOLOR_TextNotInExtent =       0x00800000;    // Dark Blue
const UINT32 UICOLOR_TextNotYetRendered =    0x000000A0;    // Red
const UINT32 UICOLOR_TextEditable =          0x00800080;    // Purple


#define  MDISPSELECT_ViewCoords           0x0000   //!< Point(s) in "view" coordinates
#define  MDISPSELECT_DisplayCoords        0x0001   //!< Point(s) in "display" coordinates
#define  MDISPSELECT_AutoOpenDefaultLayer 0x0002   //!< Automatically make "default" layer elements selectable
#define  MDISPSELECT_AutoOpenActiveLayer  0x0004   //!< Automatically make "active" layer elements selectable
#define  MDISPSELECT_AutoOpenTable        0x0008   //!< Automatically open table(s) for selectable element types

#define  MDISPVISIBLE_AllViews         0xFFFFFFFF
#define  MDISPVISIBLE_Locator          0x00000001
#define  MDISPVISIBLE_Hardcopy         0x80000000

//===================================================================================================================
}  // End namespace GRE

#endif   // INC_GRE_BASE_H

---