base.h

Go to the documentation of this file.

/**
 * \file base.h <gre/base.h>
 * \brief Base GRE definitions
 *
 * \if NODOC
 * $Id: base.h_v 1.12 2004/07/21 21:55:39 mju Exp $
 *
 * $Log: base.h_v $
 * 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.2  2003/06/17 13:39:33  mju
 * Add MFC_TREEVIEW decl.
 *
 * 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  INC_RVC_STYLE_H
   #include <rvc/style.h>
#endif

#ifndef  INC_MI32_GREMODE_H
   #include <mi32/gremode.h>
#endif

#ifndef  INC_MI32_LABLSTYL_H
   #include <mi32/lablstyl.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward-declare classes.
class GRE_CALLBACK_MSG;
class GRE_ELEMSAMPLE_DC;
class GRE_LAYER;
class GRE_LAYER_RASTER;
class GRE_LAYER_SURFACE;
class GRE_LAYERDC;
class GRE_LAYOUT;
class GRE_LEGEND;
class GRE_GROUP;
class GRE_OBJECT;
class GRE_TOOL;
class GRE_VIEW;
class GRE_VIEWABLE;
class GRE_VIEWPOINT3D;

#ifdef WIN32_MFC
class GRE_MFC_VIEW;
class GRE_MFC_DLGCOMPSELQUERY;
class GRE_MFC_TREEVIEW;
class GRE_MFC_STATUSBAR;
#endif

namespace GRE {
   class LABELPLACE;
   class LABELPLACEMENT;
   class LAYERVIEW;
   }

namespace RVC {
   class DBASE;
   }
#endif // GENERATING_DOXYGEN_OUTPUT


//! GRE object types.
enum GRE_OBJTYPE {
   GRE_OBJTYPE_None =   0,
   GRE_OBJTYPE_System = 0x01,
   GRE_OBJTYPE_Layout = 0x02,
   GRE_OBJTYPE_Group =  0x04,
   GRE_OBJTYPE_Layer =  0x08,
   GRE_OBJTYPE_View =   0x10,
   GRE_OBJTYPE_All =    0xFF,
   };
DEFINE_ENUM_OP_BITWISE(GRE_OBJTYPE);

#define  GRE_MAXVIEWS         32             //!< Maximum number of views per viewable object
#define  GRE_GROUP_NAMELEN    64

#ifdef X_NATIVE
//! Item type in "object manager" list.
enum GRE_OBJMGRITEM {
   GRE_OBJMGRITEM_Layer =     0,
   GRE_OBJMGRITEM_Component = 1,
   GRE_OBJMGRITEM_Table =     2,
   GRE_OBJMGRITEM_RawForm =   3,
   };
#endif

enum GRE_FIND_FLAGS {
   GRE_FIND_ViewCoords =      0x0000,  //!< Point given in "view" coordinates
   GRE_FIND_DisplayCoords =   0x0001,  //!< Point given in "display" coordinates
   GRE_FIND_LayerCoords =     0x0002,  //!< Point given in "layer" (object) coordinates
   GRE_FIND_UseClosest =      0x0004,  //!< Return closest if no other found
   GRE_FIND_NoSingleLayer =   0x0008,  //!< Don't check single-layer groups
   GRE_FIND_No3D =            0x0010,  //!< Don't check 3-D groups
   GRE_FIND_SearchDrawnSet =  0x0020,  //!< Only search the "drawn" element set
   GRE_FIND_MapCoords =       0x0040   //!< Point given in "map" coordinates
   };
DEFINE_ENUM_OP_BITWISE(GRE_FIND_FLAGS);

/*----------------------------------------------------------------------------*/
/*    Flags used in Mdisp...Create functions                                  */
/*----------------------------------------------------------------------------*/

#define  GRE_SERIAL_VERSION   3

#define  MDISPLISTPOS_End           0x00000000
#define  MDISPLISTPOS_After         0x00000001
#define  MDISPLISTPOS_Before        0x00000002
#define  MDISPLISTPOS_Beginning     0x00000003
#define  MDISPLISTPOS_Mask          0x00000003

         //! Flags for all object types
#define  MDISPCREATE_InsertEnd            MDISPLISTPOS_End
#define  MDISPCREATE_InsertAfter          MDISPLISTPOS_After
#define  MDISPCREATE_InsertBefore         MDISPLISTPOS_Before
#define  MDISPCREATE_InsertBeginning      MDISPLISTPOS_Beginning

#define  MDISPCREATE_NoCallCreateCB       0x00000004  //!< Don't call callback list when object created
#define  MDISPCREATE_Temporary            0x00000008  //!< Object is temporary

         //! Flags for layers
#define  MDISPCREATE_LayerNoSelNewObj     0x00001000  //!< Don't allow user to select new object(s) via CtrlPanel
#define  MDISPCREATE_LayerKeepOpen        0x00002000  //!< Set if object should remain open until layer is destroyed
#define  MDISPCREATE_LayerEditable        0x00004000  //!< Set if creating layer to be edited
#define  MDISPCREATE_LayerNoGeoreference  0x00008000  //!< Set if no georeference info should be read for layer
#define  MDISPCREATE_LayerIgnoreExtents   0x00010000  //!< Ignore layer extents in group
#define  MDISPCREATE_LayerOnePerGroup     0x00020000  //!< Create layers one per group (MdispLayerCreateMulti)
#define  MDISPCREATE_LayerDispParmSet     0x00040000  //!< Dispparm values have already been set
#define  MDISPCREATE_LayerNoAllowDelete   0x00080000  //!< Don't allow user to delete layer
#define  MDISPCREATE_LayerNoControlPanel  0x00100000  //!< Don't allow control panel for layer
#define  MDISPCREATE_LayerNoPromptObject  0x00200000  //!< Don't prompt user for object even if don't have one
#define  MDISPCREATE_LayerNoComputePos    0x00400000  //!< Don't call ComputeLayerPositions() when adding new layer
#define  MDISPCREATE_LayerNoSetActive     0x00800000  //!< Don't make newly-created layer "active"
#define  MDISPCREATE_LayerNoShowInMgr     0x01000000  //!< Don't show this layer in layer manager
#define  MDISPCREATE_LayerOpenCtrlPanel   0x02000000  //!< Open control panel for layer

         //! Flags for groups
#define  MDISPCREATE_Group3D              0x00001000  //!< Group is 3-D
#define  MDISPCREATE_GroupNoAutoMatch     0x00002000  //!< Don't default to automatch any layers
#define  MDISPCREATE_GroupNoSetActive     0x00004000  //!< Don't make newly-created group "active"

         //! Flags for views
#define  MDISPCREATE_ViewNoCloseOption    0x00000100  //!< Don't include "Close" option on view menu
#define  MDISPCREATE_ViewDestroyOnClose   0x00000200  //!< Destroy view when View/Close selected
#define  MDISPCREATE_ViewNoSelectTool     0x00000400  //!< Don't add "Select" tool
#define  MDISPCREATE_ViewNoLegendView     0x00000800  //!< Don't create LegendView
#define  MDISPCREATE_ViewNoStdTools       0x00001000  //!< Don't add any standard tools
#define  MDISPCREATE_ViewNoDftAddIcons    0x00002000  //!< Don't put default "add" icon(s) on toolbar
#define  MDISPCREATE_ViewNoCancelButton   0x00004000  //!< Don't put "Cancel" button at bottom of window
#define  MDISPCREATE_ViewNoSkipButton     0x00008000  //!< Don't put "Skip" button at bottom of window
#define  MDISPCREATE_ViewNoRedrawButton   0x00010000  //!< Don't put "Redraw" button at bottom of window
#define  MDISPCREATE_ViewNoToolBoxTool    0x00020000  //!< Don't add "ToolBox" tool
#define  MDISPCREATE_ViewNoStatusLine     0x00040000  //!< Don't create "status" line
#define  MDISPCREATE_ViewNoIconBar        0x00080000  //!< Don't create iconbar
#define  MDISPCREATE_ViewNoDftDrawIcons   0x00100000  //!< Don't create default "draw" icons when creating window
#define  MDISPCREATE_ViewNoDftViewIcons   0x00200000  //!< Don't create default "view" icons when creating window
#define  MDISPCREATE_ViewNoScalePosLine   0x00400000  //!< Don't create zoom/scale/position line at bottom of view window
#define  MDISPCREATE_ViewNoScrollbars     0x00800000  //!< Don't create scroll bars
#define  MDISPCREATE_ViewLocator          0x01000000  //!< Create locator view
#define  MDISPCREATE_View3D               0x02000000  //!< View is 3D
#define  MDISPCREATE_ViewHardcopy         0x04000000  //!< Create "hardcopy" view
#define  MDISPCREATE_ViewStereoLeft       0x08000000  //!< Create "left" stereo view
#define  MDISPCREATE_ViewStereoRight      0x10000000  //!< Create "right" stereo view
#define  MDISPCREATE_ViewDialogModal      0x20000000  //!< View is contained in modal dialog
#define  MDISPCREATE_ViewAllowGeoLock     0x40000000  //!< Allow GeoLocking

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

#define  LABELSELECT_None           0x0000
#define  LABELSELECT_AllDrawnElem   0x0001   //!< Show labels for all "drawn" elements
#define  LABELSELECT_IfFit          0x0002   //!< If label fits inside/alongside element

#define  LABELTEXT_None             0x0000
#define  LABELTEXT_ByAttribute      0x0001
#define  LABELTEXT_ByField          LABELTEXT_ByAttribute
#define  LABELTEXT_ByScript         0x0002
#define  LABELTEXT_ByQuery          LABELTEXT_ByScript

//===================================================================================================================
//!      Parameters needed for various element types

//! Selection parameters for determining which elements to draw
struct SELECTPARMS {
   public:
      UINT16 Mode;                           //!< Selection mode - SELECTMODE_...
      INT16 Table;                           //!< 'Selection' table number
      UNICODE *QueryStr;                     //!< Query script for selection by query
      RVC::OBJECTNAME TableName;             //!< 'Selection' table name

      SELECTPARMS (                          //! Default constructor
         );
      SELECTPARMS (                          //! Copy constructor
         const SELECTPARMS& rhs
         );
      ~SELECTPARMS ();                       //! Destructor

      SELECTPARMS& operator= (               //! Assignment
         const SELECTPARMS& rhs
         );

      //! Check and validate for specified database and optionally fix mode if none valid.
      void CheckTable (
         const RVC::DBASE& db,               //!< Database object
         bool fixmode                        //!< Fix selection mode if necessary
         );

      //! Determine if need to have a valid database table.
      bool NeedTable (
         ) const { return ((Mode & SELECTMODE_NeedsTable) != 0); }

      //! Validate settings and fix if necessary.
      void Validate ();
   };

//! Basic style parameters for element drawing
struct STYLEPARMS {
   public:
      UINT16 Mode;                           //!< Selection mode - STYLEMODE_...
      INT16 Table;                           //!< 'Style assignment' table number
      UNICODE *QueryStr;                     //!< Query string for styling by scipt
      RVC::OBJECTNAME TableName;             //!< 'Style Assignment' table name

      STYLEPARMS (                           //! Default constructor
         );
      STYLEPARMS (                           //! Copy constructor
         const STYLEPARMS& rhs
         );
      ~STYLEPARMS ();                        //! Destructor

      STYLEPARMS& operator= (                //! Assignment
         const STYLEPARMS& rhs
         );

      //! Check and validate for specified database and optionally fix mode if none valid.
      void CheckTable (
         const RVC::DBASE& db,               //!< Database object
         bool fixmode,                       //!< Fix selection mode if necessary
         const RVC::STYLE::TYPE styletype = RVC::STYLE::TYPE_NumTypes
         );

      //! Determine if need to have a valid database table.
      bool NeedTable (
         ) const { return ((Mode & STYLEMODE_NeedsTable) != 0); }

      //! Validate settings and fix if necessary.
      void Validate ();
   };

//! DataTip parameters.
struct DATATIPPARMS {
   public:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class FORM;
      #endif // GENERATING_DOXYGEN_OUTPUT

      RVC::OBJECTNAME TableName;             //!< Table name
      RVC::OBJECTNAME FieldName;             //!< Field name
      INT32 TableNum;                        //!< Table number
      INT32 FieldNum;                        //!< Field number
      UINT8 Visible;                         //!< Show this DataTip
      UINT8 IsNumeric;                       //!< Set if field is numeric
      UINT8 UnitType;                        //!< Field unit type, here for validation against DBFIELDINFO
      UINT8 UnitStored;                      //!< Copied from DBFIELDINFO so can use in conversion
      UINT8 UnitShown;                       //!< Unit to show field in
      UINT8 DecPlaces;                       //!< Decimal places for floating-point fields
      UINT8 NoChgField;                      //!< Set if user cannot change field (eg. for RGB raster)
      UINT8 spare;
      MISTRING Prefix;                       //!< Label to place before value in string, defaults to table.field name
      MISTRING Suffix;                       //!< Label to place after value in string, defaults to unit name

      //! Get serialization item definition array.
      static const SERIALIZER::ITEMDEF *GetSerialItemDef();

      //! Default constructor.
      DATATIPPARMS (
         );

      DATATIPPARMS (
         const DATATIPPARMS& rhs
         );

      DATATIPPARMS& operator= (
         const DATATIPPARMS& rhs
         );

      //! Set suffix to default based on unit type/shown.
      void SetDefaultSuffix (
         );

   };

//! Automatic labeling parameters
struct AUTOLABELPARMS {
   public:
      static const SERIALIZER::ITEMDEF *GetSerialItemDef();
      UINT8 SelectMode;                      //!< LABELSELECT_...
      UINT8 TextMode;                        //!< LABELTEXT_...
      UINT8 Posn;                            //!< LABELPOSN_... Label position relative to element
      UINT8 Optm;                            //!< AUTOLABELOPTM_... Optimization
      UINT8 Priority;                        //!< AUTOLABELPRIORITY_... priority mode
      RVC::OBJECTNAME TableName;             //!< Table name for LABELMODE_ByField
      RVC::OBJECTNAME FieldName;             //!< Field name for LABELMODE_ByField
      UNICODE *QueryStr;                     //!< Query string for LABELMODE_ByScript
      TEXTSTYLE Style;                       //!< Label style
      LABELFRAMEPARMS FrameParms;            //!< Label Frame Parameters
      RVC::OBJECTNAME PriorityTableName;     //!< Table name for AUTOLABELPRIORITY_ByField
      RVC::OBJECTNAME PriorityFieldName;     //!< Field name for AUTOLABELPRIORITY_ByField
      double m_MinScaleVisible;              //!< Minimum scale at which labels are visible
      double m_MaxScaleVisible;              //!< Maximum scale at which labels are visible

      //! Default constructor
      AUTOLABELPARMS (
         );

      //! Copy constructor
      AUTOLABELPARMS (
         const AUTOLABELPARMS& rhs
         );

      //! Destructor
      ~AUTOLABELPARMS (
         );

      //! Assignment
      AUTOLABELPARMS& operator= (
         const AUTOLABELPARMS& rhs
         );

      //! Check and validate for specified database and optionally fix mode if none valid.
      void CheckTable (
         const RVC::DBASE& db,               //!< Database object
         bool fixmode                        //!< Fix mode if necessary
         );

      //! Determine if labels are selected and visible at specified scale.
      bool IsSelected (
         double scale                  //!< Map scale
         ) const { return (SelectMode != LABELSELECT_None && scale >= m_MinScaleVisible && (m_MaxScaleVisible <= 0.0 || scale <= m_MaxScaleVisible)); }

      void Validate ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      void Copy (const AUTOLABELPARMS& rhs);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//! Parameters for LegendView associated with element
struct LEGENDPARMS {
   public:

      RVC::OBJECTNAME TableName;             //!< Table for legend labels
      RVC::OBJECTNAME FieldName;             //!< Field for legend labels
      MGD::STYLESAMPLEFLAGS SampleFlags;           //!< Flags for legend element drawing

      LEGENDPARMS (                          //! Default constructor
         ): SampleFlags(MGD::STYLESAMPLE_Default) { }
      // No allocated members so can use compiler generated dtor, copy ctor, assignment
   };

//! Point/Node element parameters.
struct POINTPARMS {
   public:

      struct POINTSTYLEPARMS : public STYLEPARMS {
         POINTSTYLE Normal;                  //!< Style to use in normal drawing
         };

      SELECTPARMS Select;
      POINTSTYLEPARMS Style;
      DATATIPPARMS DataTip;                  //!< DataTip parameters
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      RVC::OBJECTNAME LegendElemTableName;

      POINTPARMS ();
      POINTPARMS (const POINTPARMS& rhs);
      ~POINTPARMS ();

      POINTPARMS& operator= (const POINTPARMS& rhs);
      void Validate ();
   };

//! Line element parameters
struct LINEPARMS {
   public:

      struct LINESTYLEPARMS : public STYLEPARMS {
         LINESTYLE Normal;             //!< Style to use in normal drawing
         };

      SELECTPARMS Select;
      LINESTYLEPARMS Style;
      DATATIPPARMS DataTip;            //!< DataTip parameters
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      RVC::OBJECTNAME LegendElemTableName;

      LINEPARMS ();
      LINEPARMS (const LINEPARMS& rhs);
      ~LINEPARMS ();

      LINEPARMS& operator= (const LINEPARMS& rhs);
      void Validate ();
   };

//! Polygon/Area element parameters
struct POLYPARMS {
   public:

      struct POLYSTYLEPARMS : public STYLEPARMS {
         POLYSTYLE Normal;             //!< Style to use in normal drawing
         };

      SELECTPARMS Select;
      POLYSTYLEPARMS Style;
      DATATIPPARMS DataTip;            //!< DataTip parameters
      AUTOLABELPARMS AutoLabel;
      LEGENDPARMS Legend;
      LEGENDPARMS LegendInt;           //!< Label inside the polygon sample
      RVC::OBJECTNAME LegendElemTableName;
      bool ShowInteriorLabel;          //!< Show the label inside the polygon sample
      bool ShowLabel;                  //!< Show the label outside the polygon sample

      POLYPARMS ();
      POLYPARMS (const POLYPARMS& rhs);
      ~POLYPARMS ();

      POLYPARMS& operator= (const POLYPARMS& rhs);
      void Validate ();
   };

//! Label/Text element parameters
struct LABELPARMS {
   public:

      struct LABELSTYLEPARMS : public STYLEPARMS {
         TEXTSTYLE Normal;             //!< Style to use in normal drawing
         LABELFRAMEPARMS FrameParms;
         
         LABELSTYLEPARMS ();
         };

      SELECTPARMS Select;
      LABELSTYLEPARMS Style;
      DATATIPPARMS DataTip;            //!< DataTip parameters
      double MinScaleVisible;          //!< Minimum scale at which labels are visible
      double MaxScaleVisible;          //!< Maximum scale at which labels are visible

      LABELPARMS ();
      LABELPARMS (const LABELPARMS& rhs);
      ~LABELPARMS ();

      LABELPARMS& operator= (const LABELPARMS& rhs);

      //! Determine if labels are visible at specified scale.
      bool IsVisibleAtScale (
         double scale                  //!< Map scale
         ) const { return (scale >= MinScaleVisible && (MaxScaleVisible <= 0.0 || scale <= MaxScaleVisible)); }
      void Validate ();
   };

//! 3D parameters for 3d points
struct D3POINTPARMS {
   public:

      enum MODE {
         MODE_None      = 0,
         MODE_Height    = 1,
         MODE_Elevation = 2
         };

      MODE Mode;
      RVC::OBJECTNAME TableName; //!<  table for z value
      RVC::OBJECTNAME FieldName; //!< field for z value
      UINT8 Unit;             //!<  unit for distance
      LINEPARMS Line;
      POINTPARMS Point;
      bool UseColorStack;
      COLOR BelowColor;       //!<  Color to display wireframe below surface
      COLOR AboveColor;       //!<  Color to display wireframe above surface

      D3POINTPARMS ();
      D3POINTPARMS (const D3POINTPARMS& rhs);
      ~D3POINTPARMS ();

      D3POINTPARMS& operator= (const D3POINTPARMS& rhs);
   };

//! 3D parameters for 3d polygons
struct D3POLYPARMS {
   public:

      enum MODE {
         MODE_None      = 0,
         MODE_Height    = 1,
         MODE_Elevation = 2
         };
      enum BASE {
         BASE_Minimum   = 0,
         BASE_Maximum   = 1
         };

      MODE Mode;
      BASE Base;
      RVC::OBJECTNAME TableName;       //!<  table for z value
      RVC::OBJECTNAME FieldName;       //!< field for z value
      UINT8 Unit;             //!<  unit for distance
      POLYPARMS Poly;
      bool UseColorStack;
      COLOR BelowColor;       //!<  Color to display wireframe below surface
      COLOR AboveColor;       //!<  Color to display wireframe above surface

      D3POLYPARMS ();
      D3POLYPARMS (const D3POLYPARMS& rhs);
      ~D3POLYPARMS ();

      D3POLYPARMS& operator= (const D3POLYPARMS& rhs);
   };

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

#endif   // INC_GRE_BASE_H

---