gre/layer.h

Go to the documentation of this file.

/**
 * \file gre/layer.h
 * \brief GRE::LAYER class definition
 *
 * \if NODOC
 * $Id: layer.h_v 1.12 2003/12/15 16:52:51 mju Exp $
 *
 * $Log: layer.h_v $
 * Revision 1.12  2003/12/15 16:52:51  mju
 * Add dispflag_VectNoFillHighlighted.
 *
 * Revision 1.11  2003/11/20 13:26:33  mju
 * Add SetVisiblityGroupFromLayout.
 *
 * Revision 1.10  2003/10/06 19:38:38  mju
 * nc.
 *
 * Revision 1.9  2003/10/02 16:11:16  linux32build!build
 * doxygen
 *
 * Revision 1.8  2003/09/25 21:22:24  dwilliss
 * Don't capitalize enum any more. Genitor needed it, doxygen doesn't like it
 *
 * Revision 1.7  2003/09/23 13:08:08  mju
 * Explicitly init serializble in copy dispparm copy ctor.
 *
 * Revision 1.6  2003/09/18 22:00:53  mju
 * nc.
 *
 * Revision 1.5  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.4  2003/07/31 13:38:40  mju
 * Add Filter method to LAYER::FILTER.
 *
 * Revision 1.3  2003/07/30 15:15:58  mju
 * Ignore private sections.
 * Move DISPPARM defn outside layer so will be doc'd.  Add inlines where req'd.
 *
 * Revision 1.2  2003/06/17 13:39:52  mju
 * Include mfctreeview.h for MFC.
 *
 * Revision 1.1  2003/06/16 19:39:43  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_LAYER_H
#define  INC_GRE_LAYER_H

#ifndef  INC_GRE_OBJECTBASE_H
   #include <gre/objectbase.h>
#endif

#ifndef  INC_GRE_VIEWABLE_H
   #include <gre/viewable.h>
#endif

#ifndef  INC_GRE_ELEMSEARCH_H
   #include <gre/elemsearch.h>
#endif

#ifndef  INC_GRE_3DWIREFRAME_H
   #include <gre/3dwireframe.h>
#endif

#if !defined(INC_GRE_MFCTREEVIEW) && defined(WIN32_MFC)
   #include <gre/mfctreeview.h>
#endif

#ifndef  INC_MI32_GRTREE_H
   #include <mi32/grtree.h>
#endif

#ifndef  INC_MI32_RANGE_H
   #include <mi32/range.h>
#endif

#ifndef  INC_MI32_REGION_H
   #include <mi32/region.h>
#endif

#ifndef  INC_RVC_ELEMENT_H
   #include <rvc/element.h>
#endif

#ifndef  INC_MI32_RVCPARMS_H
   #include <mi32/rvcparms.h>
#endif

#ifndef  INC_MI32_DBEDIT_H
   #include <mi32/dbedit.h>
#endif

class BITSET;
class BITSET_UNOWNED;
struct SMLCONTEXT;
struct SMLCLASSMEMBER;
union SMLARG;
struct DATATIPPARMS;
class GRE_ELEMSAMPLE_DC;
namespace RVC {
   class GETOBJFILTER;
   }

//===================================================================================================================

//! Flags stored in xxxxDISPPARM.dispflags
enum DISPFLAGS {
   DISPFLAG_None =                  0x00000000,
   DISPFLAG_SaveDrawnSetOBS =       0x00000001, //!< OBSOLETE, DO NOT USE, retain def so can read old dispparms
   DISPFLAG_KeepOpenOBS =           0x00000002, //!< OBSOLETE, DO NOT USE, retain so can read old dispparms
   DISPFLAG_UseTempFile =           0x00000004, //!< Object is in a temporary file
   DISPFLAG_EditObjectOBS =         0x00000008, //!< OBSOLETE, DO NOT USE, retain so can read old dispparms
   DISPFLAG_NoDrawLabels =          0x40000000, //!< Don't draw labels
   DISPFLAG_DrawLabelsOnly =        0x80000000, //!< Only draw labels

   DISPFLAG_WarpToGeorefModel =     0x00000100, //!< Warp to model specified with georeference
   DISPFLAG_UsesTransparency =      0x00000200, //!< Uses transparency effects
   DISPFLAG_NoDrawWireframe =       0x00000400, //!< Don't draw layer in wireframe mode
   DISPFLAG_MayUseTransparency =    0x00000800, //!< Use of transparency unknown, assume it does until first time draw

   DISPFLAG_VectDrawNodes =         0x00010000, //!< Draw nodes for vector object
   DISPFLAG_VectLinesFirst =        0x00020000, //!< Draw vector lines before polygons
   DISPFLAG_VectNoFillPoly =        0x00040000, //!< Disable polygon filling
   DISPFLAG_VectNoFillHighlighted = 0x00080000, //!< Disable polygon filling when highlighted

   DISPFLAG_TINEdgesFirst =         0x00020000, //!< Draw TIN edges before triangles
   DISPFLAG_TINNoFillTri =          0x00040000, //!< Don't fill TIN triangles

   DISPFLAG_RastNullTransp =        0x00010000, //!< Make "null" cells transparent
   DISPFLAG_RastSkipOddLines =      0x00020000, //!< Skip odd screen lines (for 3Dmax glasses)
   DISPFLAG_RastSkipEvenLines =     0x00040000, //!< Skip even screen lines (for 3Dmax glasses)
   DISPFLAG_RastDoBlendMask =       0x00080000, //!< Do mask transparency blending if possible
   DISPFLAG_RastDisableRayCast =    0x00100000, //!< Disable ray-casting for 3D rendering
   DISPFLAG_RastSmoothForeground =  0x00200000, //!< Smooth foreground in 3D
   DISPFLAG_RastHyperspectLossy =   0x00400000, //!< Display hyperspectral in fast-lossy mode

   DISPFLAG_SurfProjOffEdge =       0x00010000, //!< Project data off edge of surface

   DISPFLAG_FormulaNullTransp =     0x00010000, //!< Make "null" cells transparent
   DISPFLAG_FormulaSkipOddLines =   0x00020000, //!< Skip odd screen lines (for 3Dmax glasses)
   DISPFLAG_FormulaSkipEvenLines =  0x00040000, //!< Skip even screen lines (for 3Dmax glasses)
   };
DEFINE_ENUM_OP_BITWISE(DISPFLAGS);

//===================================================================================================================

enum LAYERDRAWFLAGS {
   LAYERDRAWFLAG_None =             0x0000,  //!< No flags
// LAYERDRAWFLAG_ClipTo =           0x0001,
   LAYERDRAWFLAG_Clip =             0x0002,  //!< Clip layer
   LAYERDRAWFLAG_NoClipToGroup =    0x0004,  //!< Don't clip layer to group
   LAYERDRAWFLAG_SaveToTemplate =   0x0008,  //!< Save layer as-is to template
   LAYERDRAWFLAG_EditInTNTserver =  0x0010,  //!< Allow layer to be edited in TNTserver
   LAYERDRAWFLAG_MaskAll =          0xFFFF,  //!< Mask for setting all flags
   };
DEFINE_ENUM_OP_BITWISE(LAYERDRAWFLAGS);

//===================================================================================================================

enum LAYERFLAGS {
   LAYERFLAG_None =                 0x00000000, //!< No flags
   LAYERFLAG_NoSelNewObj =          0x00000010, //!< Don't allow user to select new object(s) via CtrlPanel
   LAYERFLAG_HiliteColorSet =       0x00000040, //!< Separate highlight color has been set for layer
   LAYERFLAG_3D =                   0x00000200, //!< Layer is fully 3-D, no "surface" required
   LAYERFLAG_KeepOpen =             0x00020000, //!< Set if object should remain open until layer is destroyed
   LAYERFLAG_Editable =             0x00040000, //!< Set if layer can be edited
   LAYERFLAG_CanShowInLocator =     0x00100000, //!< Set if can show this layer in the Locator window
   LAYERFLAG_IgnoreExtents =        0x00400000, //!< Ignore this layer when determining group extents
   LAYERFLAG_NoGeoreference =       0x00080000, //!< Set if no georeference info should be read for layer
   LAYERFLAG_NoDrawActiveElem =     0x01000000, //!< Don't draw "active" element
   LAYERFLAG_NoShowInLayerMgr =     0x02000000, //!< Don't show in layer manager, must also set LAYERFLAG_Temporary
   LAYERFLAG_NoAllowHide =          0x04000000, //!< Don't allow user to hide layer
   LAYERFLAG_NoAllowDelete =        0x08000000, //!< Don't allow user to delete layer
   LAYERFLAG_Temporary =            0x10000000, //!< Layer is temporary, cannot save in layout
   LAYERFLAG_MaskAll =              0xFFFFFFFF, //!< Mask for setting all flags
   };
DEFINE_ENUM_OP_BITWISE(LAYERFLAGS);

//===================================================================================================================

#define  GRE_MAXLAYERTYPES    32

//! Layer base class.
class GRE_LAYER : public GRE_OBJECT {
   public:

      //! Layer types.
      enum TYPE {
         TYPE_None =       0,
         TYPE_Raster =     1,
         TYPE_Vector =     2,
         TYPE_CAD =        3,
         TYPE_DBPinmap =   4,
         TYPE_MapGrid =    5,
         TYPE_ScaleBar =   6,
         TYPE_Text =       7,
         TYPE_Legend =     8,
         TYPE_TIN =        9,
         TYPE_Sketch =     10,
         TYPE_Region =     11,
         TYPE_Surface =    12,
         TYPE_Script =     13,
         TYPE_Formula =    14,
         TYPE_Legend2 =    15,
         TYPE_Shape =      16,
         TYPE_NEXT
         //! Check GRE_MAXLAYERTYPES when add new types
         };

      //! Container for global layer options.
      class GLOBALOPTIONS {      // GRE_LAYER::GLOBALOPTIONS
         public:

            class FORM;                         //!< Global options form, defined in <gre/uilrglob.h>

            enum DFTNAMEMODE {
               DFTNAMEMODE_ObjectDesc =      0,    //!< Use object description (or name if no description)
               DFTNAMEMODE_ObjectName =      1,    //!< Use object name
               DFTNAMEMODE_FileObjNames =    2     //!< Use combined file and object names
               };
            
            GLOBALOPTIONS (
               ): m_DftNameMode(DFTNAMEMODE_ObjectDesc), m_AutoOpenDftTableOnSel(true) { }

         #ifdef X_NATIVE
            Widget CreateEditForm (
               Widget parent,
               const Arg *arglist,
               int argcount
               );
         #endif

            bool GetAutoOpenDftTableOnSel (
               ) const { return (m_AutoOpenDftTableOnSel); }

            DFTNAMEMODE GetDftNameMode (
               ) const { return (m_DftNameMode); }

            void IniRead (
               const char *inigroup = 0
               );

            void IniWrite (
               const char *inigroup = 0
               ) const;

            void SetAutoOpenDftTableOnSel (
               bool AutoOpenDftTableOnSel
               ) { m_AutoOpenDftTableOnSel = AutoOpenDftTableOnSel; }

            void SetDftNameMode (
               DFTNAMEMODE DftNameMode
               ) { m_DftNameMode = DftNameMode; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            DFTNAMEMODE m_DftNameMode;
            bool m_AutoOpenDftTableOnSel;       //!< Automatically open default table on element selection (highlighting)
            friend class GRE_LAYER;
            #endif // GENERATING_DOXYGEN_OUTPUT
         }; // End of GRE_LAYER::GLOBALOPTIONS

      class DISPPARM;

      class TYPEDEFN;
      class COMPINFO;
      class FILTER;
      class FILTER_EXCLUDE;

   #ifdef X_NATIVE   
      //! Form for layer in "object manager".
      class OBJMGRFORM {
         public:

            //! Constructor.
            OBJMGRFORM (
               GRE_LAYER *layer
               );

            //! Destructor.
            ~OBJMGRFORM (
               );

            //! Create the form widget.
            Widget Create (
               );

            void DestroyForm (
               );

            Widget GetForm (
               ) const { return (m_form); }

            Widget GetToolMenuButton (
               ) const { return (m_ToolIconMB); }

            //! Hide the layer form in the object manager.
            void Hide (
               );

            void HideDetails (
               );

            //! Set the position of the object manager
            //! @return Next position after item.
            short SetObjMgrPos (
               short pindex = -2
               );

            //! Show layer form in object manager.
            short Show (
               short pindex = -2
               );

            void ShowDetails (
               );

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            GRE_LAYER *m_layer;
            Widget m_form;
            Widget m_ActiveTB;
            Widget m_ShowDetailsTB;
            Widget m_ToolIconMB;
            Widget m_VisibleIcon[GRE_MAXVIEWS];
            Widget m_MinScaleVisibleP;
            Widget m_MaxScaleVisibleP;
            Widget m_NameLabel;
            Widget m_DeleteMB;

            static void CB_CmdLayerDelete (Widget, void *vlayer, void*);
            static void CB_CmdLayerControls (Widget, void *vlayer, void*);
            static void CB_CmdTool (Widget, void *voption, void*);
            static void CB_EditScaleRange (Widget, void *vlayer);
            static void CB_NotifyGreObject (const GRE_CALLBACK_MSG *msg, void *vpObjMgrForm);
            static void CB_NotifyGreView (const GRE_CALLBACK_MSG *msg, void*);
            static void CB_ToggleActive (Widget, void *vlayer, XmToggleButtonCallbackStruct*);
            static void CB_ToggleShowDetails (Widget, void *vpObjMgrForm, XmToggleButtonCallbackStruct*);
            static void CB_ToggleVisibleInViewNum (Widget, void *vViewNum, XmToggleButtonCallbackStruct*);

            void OnNotifyGreObject (const GRE_CALLBACK_MSG& msg);
            void UpdateShowInternalTables ();
            void UpdateShowScaleRanges ();

            OBJMGRFORM (const OBJMGRFORM&);
            OBJMGRFORM& operator= (const OBJMGRFORM&);

            #endif // GENERATING_DOXYGEN_OUTPUT
         }; //! End of GRE_LAYER::OBJMGRFORM
   #endif

   #ifdef X_NATIVE
      class RAWELEMFORM {
         public:

            //! Constructor.
            explicit RAWELEMFORM (
               GRE_LAYER *layer
               );

            //! Destructor.
            ~RAWELEMFORM (
               );

            void CreateToggleForm (
               );

            void DestroyForms (
               );

            Widget GetToggleForm (
               ) const { return (m_ToggleForm); }

            void HideForms (
               );

            bool IsInfoShown (
               ) const { return (m_InfoForm != 0 && XtIsManaged(m_InfoForm)); }

            void SetElement (
               ELEMTYPE ElemType,
               INT32 ElemNum
               );

            short ShowToggleForm (
               short pindex
               );

            void SetInfoText (
               const UNICODE *string
               );

            //! Set the position of the Object Manager
            //! @return Next position after item.
            short SetObjMgrPos (
               short pindex
               );

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            GRE_LAYER *m_layer;
            ELEMTYPE m_ElemType;
            INT32 m_ElemNum;
            Widget m_ToggleForm;             //!< Form containing toggle for showing raw info
            Widget m_ShowInfoTB;             //!< Toggle for showing raw info
            Widget m_InfoForm;               //!< Form containing raw info
            Widget m_ElemNumP;               //!< 'Prompt' for entering element number
            Widget m_ElemTypeTB[6];          //!< ToggleButtons for selecting element type, indexed by component
            Widget m_InfoXeT;

            static void CB_BtnNextSelected (Widget, void*, void*);
            static void CB_BtnPrevSelected (Widget, void*, void*);
            static void CB_BtnSelectPrev (Widget, void*, void*);
            static void CB_BtnSelectNext (Widget, void*, void*);
            static void CB_EditElemNum (Widget, void*);
            static void CB_ToggleSetElemType (Widget, void*, void*);
            static void CB_ToggleShowInfo (Widget, void*, XmToggleButtonCallbackStruct*);
            static void EH_ResizeSW (Widget, void*, XEvent*, Boolean*);

            void CreateInfoForm ();
            void OnEditElemNum ();
            void SelectPrevNext (int add);
            void SetElemType (ELEMTYPE ElemType);
            void ShowInfoForm (bool show);

            RAWELEMFORM (const RAWELEMFORM&);
            RAWELEMFORM& operator= (const RAWELEMFORM&);

            #endif // GENERATING_DOXYGEN_OUTPUT
         }; //! End of GRE_LAYER::RAWELEMFORM
   #endif

      //! Determine if can construct layer from RVC object.
      static bool CanConstructFromObject (
         const RVC::OBJITEM& objitem
         );

      //! Construct layers using geospatial catalog.
      static ERRVALUE ConstructFromGeoCat (
         MDLGPARENT dlgparent,
         GRE_GROUP *group
         );

      //! Construct layer from specified object.
      static ERRVALUE ConstructFromObject (
         GRE_GROUP *group,                      //!< Group to contain new layer
         const RVC::OBJITEM& objitem,              //!< Object to construct layer for
         GRE_LAYER **retlayer = 0,              //!< New layer returned
         GRE_LAYER *reflayer = 0,               //!< Reference layer for insertion
         UINT32 createflags = 0                 //!< Creation flags
         );

      //! Construct multiple layers using object list (quick-add).
      static ERRVALUE ConstructFromObjList (
         GRE_GROUP *group,                      //!< Group to construct layers in, layers will be added after active layer
         const RVC::OBJITEMLIST& objlist           //!< List of objects to construct layers for
         );

      //! Edit global settings via dialog
      //! @return true if settings changed, false if not
      static bool EditGlobalSettings (
         MDLGPARENT dlgparent
         );

      //! Get default layer naming mode.
      static GLOBALOPTIONS::DFTNAMEMODE GetDftNameMode (
         ) { return (s_GlobalOptions.m_DftNameMode); }

      static const GLOBALOPTIONS& GetGlobalOptions (
         ) { InitStatic(); return (s_GlobalOptions); }

      //! Get number of registered layer types
      static UINT16 GetNumTypes (
         ) { return (s_NumTypes); }

      //! Get type definition for specific layer type index
      static const TYPEDEFN& GetTypeDefn (
         UINT16 idx
         ) { return (*s_TypeDefns[idx]); }

      //! Get type definition for specific layer type
      static const TYPEDEFN* GetTypeDefn (
         TYPE layertype
         );

      //! Get localized name for specific layer type
      static const UNICODE* GetTypeName (
         TYPE layertype
         );

   #if defined(X_NATIVE) || defined(WIN32_MFC)
      //! Prompt for multiple objects for quick-add.
      static ERRVALUE PromptObjects (
         MDLGPARENT dlgparent,                  //!< Parent for dialog
         RVC::OBJITEMLIST& objlist,             //!< List of selected objects returned
         GETOBJFLAGS flags=GETOBJFLAG_None,     //!< Additional flags for selection dialog
         const UNICODE *prompt = 0              //!< Prompt message for use in dialog ( Default is TEXTID_Prompt_Objects_Display )
         );
   #endif

      //! Register layer type
      static void RegisterLayerType (
         TYPEDEFN& typedefn
         );

      //! Set whether the default attribute table should be opened on element selection.
      static void SetAutoOpenDftTableOnSel (
         bool AutoOpenDftTableOnSel
         ) { s_GlobalOptions.m_AutoOpenDftTableOnSel = AutoOpenDftTableOnSel; }

      //! Set default layer naming mode
      static void SetDftNameMode (
         GLOBALOPTIONS::DFTNAMEMODE DftNameMode
         ) { s_GlobalOptions.m_DftNameMode = DftNameMode; }

      static void SetGlobalOptions (
         const GLOBALOPTIONS& options
         ) { s_GlobalOptions = options; }

      //! Method to install SML class, called by internal SML function.
      static void SMLClassInstall (
         SMLCONTEXT *context                    //!< SML context
         );

      //! Constructor
      GRE_LAYER (
         GRE_GROUP *group,                      //!< Group to contain layer
         GRE_LAYER *reflayer,                   //!< Reference layer for insertion
         TYPE layertype,                        //!< Layer type
         DISPPARM& dispparm,                    //!< Reference to layer's internal DISPPARM
         UINT32 flags                           //!< MDISPCREATE flags
         );

      //! Destructor
      virtual ~GRE_LAYER ();

   #ifdef WIN32_MFC
      //! Add "details" items to treeview (WIN32_MFC).
      void AddTreeViewDetails (
         GRE_MFC_TREEVIEW& TreeView,
         HTREEITEM hParent,
         HTREEITEM hInsertAfter
         ) { v_AddTreeViewDetails(TreeView,hParent,hInsertAfter); }
   #endif

   #ifdef WIN32_MFC
      //! Add "legend" items to treeview (WIN32_MFC).
      void AddTreeViewLegend (
         GRE_MFC_TREEVIEW& TreeView,
         HTREEITEM hParent,
         HTREEITEM hInsertAfter
         ) { v_AddTreeViewLegend(TreeView,hParent,hInsertAfter); }
   #endif

   #ifdef X_NATIVE
      //! Append items to popup menu (X only).
      void AppendPopupMenuItems (
         Widget widget,                      //!< Widget popup event occurred in
         const DPOINT2D *point,              //!< Point in layer coordinates where popup event occurred, NULL if not in view
         MENUITEMARRAY& menuitems            //!< Menu item array to append to
         ) { v_AppendPopupMenuItems(widget,point,menuitems); }
   #endif

      //! Assign layer to use specified object.
      ERRVALUE AssignObject (
         const RVC::OBJITEM& objitem
         ) { return (v_AssignObject(objitem)); }

      //! Assign layer to use specified object.
      ERRVALUE AssignObject (
         const FNAMEINODEUC *fnip
         );

      //! Determine if layer is set to be editable via TNTserver.
      bool CanEditInTNTserver (
         ) const { return ((drawflags & LAYERDRAWFLAG_EditInTNTserver) != 0); }

      //! Determine if capable of retrieving element extents
      bool CanGetElemExtents (
         ) const { return (m_CanGetElemExtents); }

      //! Determine if can open control dialog for layer
      bool CanOpenControlPanel (
         ) const { return (!m_IsControlPanelDisabled); }

      //! Determine if capable of reporting raw element information
      bool CanReportRawElemInfo (
         ) const { return (m_CanReportRawElemInfo); }

      //! Determine if can show "details" (components).
      bool CanShowDetails (
         ) const { return (v_CanShowDetails()); }

      //! Determine if element can be tested if inside/outside region
      bool CanTestElementByRegion (
         ) const { return (m_CanTestElementByRegion); }

      bool CanViewIn2D (
         ) const { return (m_CanViewIn2D); }

      bool CanViewIn3D (
         ) const { return (m_CanViewIn3D); }

      //! Change position in list
      bool ChangeListPos (
         GRE_LAYER* reflayer,
         UINT32 insertpos
         );

      //! Request close of object(s) associated with layer.
      void CloseObject (
         ) { v_CloseObject(); };

      //! Compute "margins" for layer
      void ComputeMargins (
         double& tmargin,                       //!< Top margin in "layer" coordinates returned
         double& bmargin,                       //!< Bottom margin in "layer" coordinates returned
         double& lmargin,                       //!< Left margin in "layer" coordinates returned
         double& rmargin                        //!< Right margin in "layer" coordinates returned
         ) { v_ComputeMargins(tmargin,bmargin,lmargin,rmargin); }

      //! Get default DataTip prefix for specified component.
      void DataTipGetDefaultPrefix (
         int component,                         //!< Component index
         DATATIPPARMS& DataTipParms             //!< DataTip parameters passed/returned
         ) const { v_DataTipGetDefaultPrefix(component,DataTipParms); }

      //! Get DataTip settings for specified component
      const DATATIPPARMS& DataTipGetParms (
         int component                          //!< Component index
         ) const { return (v_DataTipGetParms(component)); }

      //! Get DataTip search distance in pixels.
      inline int DataTipGetSearchDist (
         ) const;

      //! Determine if has DataTip available for any component.
      bool DataTipHasAvailable (
         ) const;

      //! Determine if has DataTip enabled for any component.
      bool DataTipHasEnabled (
         ) const;

      //! Determine if DataTip is enabled for this layer.
      //! May also need to use DataTipHasAvailable to determine if a DataTip is actually available.
      bool DataTipIsEnabled (
         ) const { return (m_DataTipEnabled); }

      //! Set default DataTip prefix for specified layer component.
      void DataTipSetDefaultPrefix (
         int component                          //!< Component index
         );

      //! Set DataTip parameters for specified layer component
      ERRVALUE DataTipSetParms (
         int component,                         //!< Component index
         const DATATIPPARMS& DataTipParms       //!< Parameter values to set
         ) { return (v_DataTipSetParms(component,DataTipParms)); }

      //! Get DataTip for specified element.
      //! The string if any will be appended to the MISTRING provided.
      //! @return TRUE if string was appended, FALSE if not, < 0 if error.
      int DataTipGetString (
         ELEMTYPE ElemType,                     //!< Element type
         INT32 ElemNum,                         //!< Element number
         MISTRING& string                       //!< String to append to
         );

      //! Translate DbList index to element number.
      INT32 DbListIndexToElemNum (
         int component,
         INT32 index
         ) { return (v_DbListIndexToElemNum(component,index)); }

      //! Translate element number to DbList index.
      INT32 DbListElemNumToIndex (
         int component,
         INT32 ElemNum
         ) { return (v_DbListElemNumToIndex(component,ElemNum)); }

      //! Determine if DbList index is same as element number.
      bool DbListIsIndexElemNum (
         ) const { return (m_DbListIsIndexElemNum); }

      void DisableControlPanel (
         ) { m_IsControlPanelDisabled = true; return; }

      //! Draw this layer.
      ERRVALUE Draw (
         GRE_LAYERDC& layerdc                   //!< Drawing control parameters
         ) { return (v_Draw(layerdc)); }

      //! Draw all views containing layer
      int DrawAllViews (
         UINT32 flags = 0                       //!< MDISPDRAW_... flags
         );

      ERRVALUE DrawElement (
         GRE_VIEW *view,                        //!< View to draw in, 0 for all
         ELEMTYPE ElemType,
         INT32 ElemNum,
         UINT32 drawflags
         );

      //! Draw single element for this layer
      ERRVALUE DrawElementLow (
         GRE_LAYERDC& layerdc,                  //!< Drawing control parameters
         ELEMTYPE ElemType,                     //!< Element type
         INT32 ElemNum,                         //!< Element number
         const void *style                      //!< Style for override, 0 for default
         ) { return (v_DrawElementLow(layerdc,ElemType,ElemNum,style)); }

      ERRVALUE DrawElements (
         GRE_VIEW *view,                        //!< View to draw in, 0 for all
         ELEMTYPE ElemType,
         UINT8 *ElemSet,
         UINT32 drawflags
         );

      //! Draw set of elements for this layer
      ERRVALUE DrawElementsLow (
         GRE_LAYERDC& layerdc,                  //!< Drawing control parameters
         ELEMTYPE ElemType,                     //!< Element type
         const UINT8 *ElemSet,                  //!< Element set
         const void *style                      //!< Style for override, 0 for default
         ) { return (v_DrawElementsLow(layerdc,ElemType,ElemSet,style)); }

      //! Draw element sample.
      ERRVALUE DrawElementSample (
         const GRE_ELEMSAMPLE_DC& sampledc,     //!< Drawing control parameters
         const RVC::ELEMENT& element,           //!< Element
         const LRECT2D& samplerect              //!< Destination rectangle
         ) { return (v_DrawElementSample(sampledc,element,samplerect)); }

      void EditColors (
         MDLGPARENT dlgparent
         );

      //! Enable DataTip for layer if available.
      //! The DataTip is enabled by default, this setting allows the user to easily turn DataTips on/off by layer.
      void EnableDataTip (
         bool enable = true
         ) { m_DataTipEnabled = enable; return; }

      //! Find closest element to specified point.
      //! @return element number, -1 if not found, < -1 if error
      INT32 FindClosestElement (
         const DPOINT2D& point,                 //!< Point in "object" coordinates
         double searchdist,                     //!< Distance to search in "object" coordinates
         double *distret,                       //!< Distance returned in "object" coordinates, (NULL if don't need)
         int component,                         //!< Component to search
         const UINT8 *SearchSet,                //!< Set of elements to search, NULL for all elements
         UINT32 findflags                       //!< MDISPFIND_... flags
         ) { return (v_FindClosestElement(point,searchdist,distret,component,SearchSet,findflags)); }

      //! Find elements matching specified query.
      //! @return number of elements found, < 0 if error
      INT32 FindElementsByQuery (
         ELEMTYPE ElemType,                     //!< Element type
         BITSET_UNOWNED& ElemSet,               //!< Set of elements found
         const UNICODE *QueryScript,            //!< Query script string
         SMLCONTEXT* QueryContext = 0           //!< Query/SML context
         );

      //! Find elements matching specified query with "match quality".
      //! An array of values, one per element, is returned with values from 0-255 corresponding
      //! to query return values from 0.0 to 1.0.  Values < 0 will be 0, values > 255 will be 255.
      ERRVALUE FindElementsByQueryExt (
         ELEMTYPE ElemType,                     //!< Element type
         SIMPLE_ARRAY<UINT8>& Result,           //!< Result for each element
         const UNICODE *QueryScript,            //!< Query script string
         SMLCONTEXT* QueryContext = 0           //!< Query/SML context
         );

      GRE_LAYER_SURFACE* FindSurfaceLayer (
         ) const;

      #ifndef GENERATING_DOXYGEN_OUTPUT
      //! Make protected when possible.
      void FinishCreation (UINT32 flags = 0);
      #endif // GENERATING_DOXYGEN_OUTPUT

      inline bool GetActiveElement (
         ELEMTYPE& ElemType,
         INT32& ElemNum
         ) const;

      inline bool GetActiveElement (
         RVC::ELEMENT& element
         ) const;

      inline INT32 GetActiveElemNum (
         ) const;

      inline ELEMTYPE GetActiveElemType (
         ) const;

      inline const COLOR& GetColorPedestal (
         ) const;

      //! Get component for specified element type.
      //! @return Component index, -1 if no corresponding component.
      int GetComponent (
         ELEMTYPE ElemType                      //!< Element type
         ) const { return (v_GetComponent(ElemType)); }

      //! Get icon for component.
      //! @return Icon for component or NULL if none
      MICON GetComponentIcon (
         int component                          //!< Component index
         ) const { return (v_GetComponentIcon(component)); }

      //! Get component information.
      //! @return Pointer to component information or NULL if none.
      COMPINFO* GetComponentInfo (
         int component                          //!< Component index
         ) { return (v_GetComponentInfo(component)); }

      //! Get component information (const version).
      //! @return Pointer to component information or NULL if none.
      const COMPINFO* GetComponentInfo (
         int component
         ) const { return (const_cast<GRE_LAYER*>(this)->GetComponentInfo(component)); }

      //! Get component information by element type.
      //! @return Pointer to component information or NULL if none.
      COMPINFO* GetComponentInfoByType (
         ELEMTYPE elemtype                      //!< Element type
         );

      //! Get localized name of component.
      //! @return Component name.
      MISTRING GetComponentName (
         int component                          //!< Component index
         ) const { return (v_GetComponentName(component)); }

      //! Get "parent" for dialogs associated with layer.
      MDLGPARENT GetDialogParent (
         ) const;

      //! Get DISPFLAGS for layer.
      inline DISPFLAGS GetDispFlags (
         ) const;

      UINT16 GetDispParmUsage (
         ) const { return ((layerflags & LAYERFLAG_Editable) ? DPARMUSAGE_Edit : DPARMUSAGE_Display); }

      //! Get pointer to default style of element type.
      //! @return Pointer to style, do not free.
      const void* GetElemDefaultStyle (
         ELEMTYPE ElemType                      //!< Element type
         ) const { return (v_GetElemDefaultStyle(ElemType)); }

      //! Get selection mode for element drawing
      //! @return Selection mode
      UINT16 GetElemDrawSelectionMode (
         ELEMTYPE ElemType                      //!< Element type
         ) const { return (v_GetElemDrawSelectionMode(ElemType)); }

      //! Get style mode for element drawing.
      //! @return style mode
      UINT16 GetElemDrawStyleMode (
         ELEMTYPE ElemType                      //!< Element type
         ) const { return (v_GetElemDrawStyleMode(ElemType)); }

      //! Get extents of specified element.
      ERRVALUE GetElemExtents (
         ELEMTYPE ElemType,                     //!< Element type
         INT32 ElemNum,                         //!< Element number
         DRECT3D& Extents                       //!< Extents returned
         ) { return (v_GetElemExtents(ElemType,ElemNum,Extents)); }

      //! Get element search structure.
      ERRVALUE GetElemSearchInfo (
         ELEMTYPE ElemType,                     //!< Element type
         GRE_ELEMSEARCH **sip                   //!< Pointer to search structure returned, DO NOT FREE!
         );

      UINT8 GetElemSelectMode (
         ) const;

      //! Get combined extents of all elements in set.
      ERRVALUE GetElemSetExtents (
         ELEMTYPE ElemType,                     //!< Element type
         const BITSET_UNOWNED& ElemSet,         //!< Set of elements
         DRECT3D& Extents                       //!< Extents in layer object coordinates returned
         );

      //! Get element type associated with specified component.
      ELEMTYPE GetElemType (
         int component                          //!< Component index
         ) const { return (v_GetElemType(component)); }

      const DRECT2D& GetExtents (
         ) const { return (m_Region.Extents); }

      GRE_GROUP * GetGroup (
         ) const { return (group); }

      //! Get georeference name for layer component.
      //! @return 'True' if layer has a georeference name, 'false' if not
      bool GetGeorefName (
         RVC::OBJECTNAME& gname,
         int component = 0                      //!< Component index
         ) const { return (v_GetGeorefName(gname,component)); }

      //! Get LAYERDRAWFLAGS for layer.
      LAYERDRAWFLAGS GetLayerDrawFlags (
         ) const { return (static_cast<LAYERDRAWFLAGS>(drawflags)); }

      //! Get LAYERFLAGS for layer.
      LAYERFLAGS GetLayerFlags (
         ) const { return (static_cast<LAYERFLAGS>(layerflags)); }

      //! Get layer type.
      TYPE GetLayerType (
         ) const { return (m_layertype); }

      //! Get legend for specified element type.
      //! @return Pointer to legend or NULL if no legend.
      const GRE_LEGEND* GetLegend (
         ELEMTYPE ElemType = ELEMTYPE_Empty     //!< Element type
         ) { return (v_GetLegend(ElemType)); }

      GraphicTreeItemMsgHandler GetLegendMsgHandler (
         ) const { return (m_LegendMsgHandler); }

      //! Get current layer drawing order position in list.
      //! @return 0 for first layer, 1 for second, etc.
      int GetListPos (
         );

      double GetMapScale (
         ) const;

      UINT8 GetMaskBlue (
         ) const { return (m_MaskBlue); }

      UINT8 GetMaskGreen (
         ) const { return (m_MaskGreen); }

      UINT8 GetMaskRed (
         ) const { return (m_MaskRed); }

      double GetMaxScaleVisible (
         ) const { return (m_MaxScaleVisible); }

      double GetMinScaleVisible (
         ) const { return (m_MinScaleVisible); }

      //! Get name of layer as MISTRING.
      void GetName (
         MISTRING& retname
         ) { retname = this->name; }

      //! Get name of layer.
      const UNICODE* GetName (
         ) const { return (name); }

      //! Get next layer in group.
      GRE_LAYER* GetNext (
         ) const { return (nextlayer); }

      inline int GetNumComponents (
         ) const;

      //! Get number of elements of specified type.
      //! @return number of elements, < 0 if error.
      INT32 GetNumElements (
         ELEMTYPE ElemType                      //!< Element type
         ) { return (v_GetNumElements(ElemType)); }

      inline int GetNumObjects (
         ) const;

   #ifdef X_NATIVE
      OBJMGRFORM& GetObjMgrForm (
         ) { return (m_ObjMgrForm); }
   #endif

      //! Get RVC::OBJITEM for layer component.
      //! @return Reference to object item, will be unattached if no object
      const RVC::OBJITEM& GetObjItem (
         int component = 0                      //!< Component index
         ) const { return (v_GetObjItem(component)); }

      //! Get previous layer in group.
      GRE_LAYER* GetPrevious (
         ) const { return (prevlayer); }

      const DRECT2D& GetProjExtents (
         ) const {
         MregionGenerateDest(const_cast<DREGION*>(&m_Region));
         return (m_Region.DestExtents);
         }

      const MAPPROJPARM& GetProjParm (
         ) const { return (m_Region.mapparm); }

   #ifdef X_NATIVE
      RAWELEMFORM& GetRawElemForm (
         ) { return (m_RawElemForm); }
   #endif

      const DREGION& GetRegion (
         ) const { return (m_Region); }

      //! Get whether to show internal tables in table lists.
      bool GetShowInternalTables (
         ) const { return (GetViewable()->GetShowInternalTables()); }

      //! Get whether to show scale ranges in layer lists.
      bool GetShowScaleRanges (
         ) const { return (GetViewable()->GetShowScaleRanges()); }

      void GetSizeMeters (
         double& xsize,
         double& ysize
         ) const;

      //! Get style information for specified element type
      //! @return 0 if OK, -1 if no style object, < -1 if error
      ERRVALUE GetStyleInfo (
         ELEMTYPE ElemType,                     //!< Element type
         RVC::OBJITEM& ObjItem,                 //!< Style object item returned
         RVC::OBJECTNAME& TableName             //!< Style assignment table name returned
         ) { return (v_GetStyleInfo(ElemType,ObjItem,TableName)); }

   #ifdef X_NATIVE
      //! Get layer-specific items to add to "tools" menu.
      //! @return Menu item array or NULL if no items, DO NOT FREE.
      MENUITEM* GetToolMenu (
         ) const { return (v_GetToolMenu()); }
   #endif

      //! Get tranformation from layer to group's map coordinates in TRANSPARM
      void GetTransGroup (
         TRANSPARM& transparm                   //!< Transformation parameters to fill in
         ) const;

      //! Get tranformation from layer to group's map coordinates in TRANS2D_MAPGEN
      void GetTransGroup (
         TRANS2D_MAPGEN& trans                  //!< Transformation to fill in
         ) const;

      //! Get transformation from layer to map in TRANSPARM
      void GetTransMap (
         TRANSPARM& transparm,                  //!< Transformation parameters to fill in
         bool setoutput                         //!< True to set in output side, false for input side
         ) const;

      //! Get transformation from layer to map in TRANS2D_MAPGEN
      void GetTransMap (
         TRANS2D_MAPGEN& trans,                 //!< Transformation to fill in
         bool setoutput                         //!< True to set in output side, false for input side
         ) const;

      //! Get type definition for this layer
      const TYPEDEFN& GetTypeDefn (
         ) const { return (*GetTypeDefn(m_layertype)); }

      //! Get unique layer ID.
      //! IDs are unique within the scope of the topmost VIEWABLE object.  Thus all
      //! layers in a layout have unique IDs within that layout.
      UINT32 GetUniqueID (
         ) const { return (m_UniqueID); }

      //! Get top-level GRE_VIEWABLE which contains layer.
      GRE_VIEWABLE* GetViewable (
         ) const;

      //! Get "map scale" of first view containing layer.
      //! @return "inverse" of scale (eg. 24000 for 1:24000)
      double GetViewMapScale (
         ) const;

      //! Get visiblity for layer in group views.
      UINT32 GetVisibleGroup (
         ) const { return (VisibleViewGroup); }

      //! Get visiblity for layer in layout views.
      UINT32 GetVisibleLayout (
         ) const { return (VisibleViewLayout); }

      //! Get scale range over which layer is visible
      void GetVisibleScaleRange (
         double& MinScaleVisible,               //!< Minimum scale visible returned, 0 for no minimum
         double& MaxScaleVisible                //!< Maximum scale visible returned, 0 for no maximum
         ) { MinScaleVisible = m_MinScaleVisible; MaxScaleVisible = m_MaxScaleVisible; }

      //! Get 3D wireframe color for layer.
      inline const COLOR& GetWireframeColor (
         ) const;

      //! Get Z offset (unscaled) for layer.
      inline double GetZOffset (
         ) const;

      //! Get Z range (scaled) for layer.
      void GetZRangeScaled (
         DOUBLE_RANGE& zrange
         ) const;

      //! Determine if layer has color plane masks set.
      bool HasColorMasks (
         ) const { return (m_MaskRed != 0 || m_MaskGreen != 0 || m_MaskBlue != 0); }

      //! Determine if layer has null "image" cells.
      bool HasNullImageCells (
         ) const { return (v_HasNullImageCells()); }

      //! Determine if layer can show a legend in LegendView
      bool HasLegend (
         ) const { return (m_LegendMsgHandler != 0); }

   #ifdef WIN32_MFC
      //! Determine if layer supports "legend" for treeview (WIN32_MFC).
      bool HasTreeViewLegend (
         ) const { return (v_HasTreeViewLegend()); }
   #endif

      //! Determine if layer has valid extents
      bool HasValidExtents (
         ) const { return (m_HasExtents); }

      //! Highlight single element in layer.
      //! @return TRUE if selected set changed, FALSE if not, < 0 if error
      int HighlightElement (
         ELEMTYPE ElemType,
         INT32 ElemNum,
         int SelectMode,
         GRE_VIEW *firstview,
         UINT32 drawflags
         );

      //! Highlight set of elements in layer.
      //! @return TRUE if selected set changed, FALSE if not, < 0 if error
      int HighlightElements (
         ELEMTYPE ElemType,
         const UINT8 *ElemSet,
         int SelectMode,
         GRE_VIEW *firstview,
         UINT32 drawflags
         );

      //! Highlight elements matching specified query.
      //! @return number of elements found, < 0 if error
      int HighlightElementsByQuery (
         ELEMTYPE ElemType,
         SMLCONTEXT* QueryContext,
         int QuerySegment,
         const UNICODE* QueryScript,
         GRE_VIEW *firstview,
         UINT32 drawflags
         );

      //! Highlight elements using specified region.
      //! @return TRUE if highlight set changed, FALSE if not < 0 if error.
      int HighlightElementsByRegion (
         ELEMTYPE ElemType,
         const GEOREGION& Region,
         GEOREGION::TESTMODE RegionTest,
         GRE_VIEW *firstview,
         UINT32 DrawFlags
         ) { return (v_HighlightElementsByRegion(ElemType,Region,RegionTest,firstview,DrawFlags)); }

      //! Determine if layer is in the process of being created.
      bool IsBeingCreated (
         ) const { return (m_IsBeingCreated); }

      //! Determine if specified component is marked as "selectable" for highlighting by user.
      bool IsComponentSelectable (
         int component
         ) const;

      bool IsEditable (
         ) const { return ((layerflags &