gre/elemparms.h

Go to the documentation of this file.

/**
 * \file gre/elemparms.h <gre/elemparms.h>
 * \brief GRE element parameter definitions
 *
 * \if NODOC
 * $Id: elemparms.h_v 1.4 2006/09/28 13:14:57 mju Exp $
 *
 * $Log: elemparms.h_v $
 * Revision 1.4  2006/09/28 13:14:57  mju
 * Use legendparms hdr.
 *
 * Revision 1.3  2006/09/28 13:04:04  mju
 * Use datatip hdr.
 *
 * Revision 1.2  2006/09/27 16:17:39  mju
 * Move extruded parm classes to own hdr.
 *
 * Revision 1.1  2006/09/21 22:00:32  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_ELEMPARMS_H
#define  INC_GRE_ELEMPARMS_H

#ifndef  INC_GRE_BASE_H
#include <gre/base.h>
#endif

#ifndef  INC_MI32_SERIALIZERBASE_H
   #include <mi32/serializerbase.h>
#endif

#ifndef  INC_RVC_STYLETYPE_H
   #include <rvc/styletype.h>
#endif

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

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

#ifndef  INC_GRE_DATATIP_H
   #include <gre/datatip.h>
#endif

#ifndef  INC_GRE_LEGENDPARMS_H
   #include <gre/legendparms.h>
#endif


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


namespace GRE {
//===================================================================================================================

#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

#define  LABELPOSN_Default             0

#define  LABELPOSN_PointAboveLeft      1
#define  LABELPOSN_PointAboveCenter    2
#define  LABELPOSN_PointAboveRight     3
#define  LABELPOSN_PointCenterLeft     4
#define  LABELPOSN_PointCenter         5
#define  LABELPOSN_PointCenterRight    6
#define  LABELPOSN_PointBelowLeft      7
#define  LABELPOSN_PointBelowCenter    8
#define  LABELPOSN_PointBelowRight     9

#define  AUTOLABELOPTM_None            0x00
#define  AUTOLABELOPTM_Fast            0x01
#define  AUTOLABELOPTM_Full            0x02
#define  AUTOLABELOPTM_HideOverlap     0x04

#define  AUTOLABELPRIORITY_AllSame     0
#define  AUTOLABELPRIORITY_ByField     1
#define  AUTOLABELPRIORITY_ByScript    2


//===================================================================================================================
//    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
      MIUNICODE *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
      MIUNICODE *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::STYLETYPE styletype = RVC::STYLETYPE_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 ();
   };

//! Automatic labeling parameters
struct AUTOLABELPARMS {
   public:
      static const SERIALIZERITEM *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
      MIUNICODE *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
   };

//! 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 ();
   };

//===================================================================================================================
}  // End namespace GRE
#endif   // INC_GRE_ELEMPARMS_H

---