lablstyl.h

Go to the documentation of this file.

/**
 * \file mi32/lablstyl.h
 * \brief Definitions of LABELSTYLE
 *
 * \if NODOC
 * $Id: lablstyl.h_v 1.14 2004/10/14 16:58:26 dwilliss Exp $
 *
 * $Log: lablstyl.h_v $
 * Revision 1.14  2004/10/14 16:58:26  dwilliss
 * Added UsesTransparency and UsesAntialiasing methods
 *
 * Revision 1.13  2004/08/06 15:48:30  dwilliss
 * *** empty log message ***
 *
 * Revision 1.12  2004/06/14 16:06:17  scowan
 * Uses mgd enum include file.
 *
 * Revision 1.11  2003/10/03 22:08:52  dwilliss
 * *** empty log message ***
 *
 * Revision 1.10  2003/10/01 22:37:46  dwilliss
 * Added margin and arrow members
 *
 * Revision 1.9  2003/09/23 13:11:19  mju
 * Call base copy ctor in labelstyle copy ctor.
 *
 * Revision 1.8  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/06/25 23:03:32  dwilliss
 * *** empty log message ***
 *
 * Revision 1.6  2003/06/25 14:19:16  dwilliss
 * *** empty log message ***
 *
 * Revision 1.5  2003/06/24 16:06:30  dwilliss
 * Oops.  Had a "Set" method named as a "Get" method
 *
 * Revision 1.4  2003/06/24 15:15:31  dwilliss
 * *** empty log message ***
 *
 * Revision 1.3  2003/06/24 14:56:41  dwilliss
 * *** empty log message ***
 *
 * Revision 1.2  2003/06/18 22:58:23  dwilliss
 * Finished defining the structure
 *
 * Revision 1.1  2003/06/18 22:45:00  dwilliss
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_LABLSTYL_H
#define  INC_MI32_LABLSTYL_H

#ifndef  INC_MI32_ELEMSTYL_H
#include <mi32/elemstyl.h>
#endif

#ifndef  INC_RVC_STYLE_H
#include <rvc/style.h>
#endif

#ifndef INC_MI32_MG2ENUMS_H
#include <mi32/mg2enums.h>
#endif

struct SMLCONTEXT;

//! In-memory structure for labels with frames and leaders.  This is the
//! serializable part of the structure.
class LABELFRAMEPARMS {
   public:
      enum FRAMESHAPE {
         FRAMESHAPE_None = 0,
         FRAMESHAPE_Rectangle,
         FRAMESHAPE_RoundedRectangle,
         FRAMESHAPE_Ellipse,
         FRAMESHAPE_Circle
         };

      //! Default constructor
      LABELFRAMEPARMS (
         ) :
         m_FrameShape(FRAMESHAPE_None),
         m_Margin(0.0),
         m_bCartoonBalloonLeaders(false),
         m_TMargin(0.0),
         m_BMargin(0.0),
         m_LMargin(0.0),
         m_RMargin(0.0),
         m_Arrow(0)
         {
         }
      
      //! Copy constructor.
      LABELFRAMEPARMS (                         
         const LABELFRAMEPARMS& rhs
         ) { Copy(rhs); }

      //! Destructor.
      ~LABELFRAMEPARMS() {}
      
      //! Assignment 
      LABELFRAMEPARMS& operator= (              
         const LABELFRAMEPARMS& rhs
         ) { if (this != &rhs) { Copy(rhs); } return (*this); }

      static const SERIALIZER::ITEMDEF* SerialGetItemDef ();

      //! Helper method for copying.
      void Copy (                         
         const LABELFRAMEPARMS& rhs
         );

      bool GetCartoonBalloonLeaders (
         ) const {
         return m_bCartoonBalloonLeaders;
         }

      FRAMESHAPE GetFrameShape (
         ) const {
         return m_FrameShape;
         }

      const POLYSTYLE& GetFrameStyle (
         ) const {
         return m_FrameStyle;
         }

      const LINESTYLE& GetLeaderStyle (
         ) const {
         return m_LeaderStyle;
         }

      // Begin phased out, but old data will have it
      double GetMargin (
         ) const {
         return m_Margin;
         }

      double GetTopMargin (
         ) const {
         return m_TMargin + m_Margin;
         }

      double GetBottomMargin (
         ) const {
         return m_BMargin + m_Margin;
         }

      double GetLeftMargin (
         ) const {
         return m_LMargin + m_Margin;
         }

      double GetRightMargin (
         ) const {
         return m_RMargin + m_Margin;
         }

      void SetCartoonBalloonLeaders (
         bool value
         ) {
         m_bCartoonBalloonLeaders = value;
         }

      void SetFrameShape (
         FRAMESHAPE shape
         ) {
         m_FrameShape = shape;
         }

      void SetFrameStyle (
         const POLYSTYLE& style
         ) {
         m_FrameStyle = style;
         }

      void SetLeaderStyle (
         const LINESTYLE& style
         ) {
         m_LeaderStyle = style;
         }

      void SetMargin (
         double margin
         ) {
         m_Margin = margin;
         }
      
      void SetTopMargin (
         double margin
         ) {
         m_TMargin = margin;
         }
      
      void SetBottomMargin (
         double margin
         ) {
         m_BMargin = margin;
         }
      
      void SetLeftMargin (
         double margin
         ) {
         m_LMargin = margin;
         }
      
      void SetRightMargin (
         double margin
         ) {
         m_RMargin = margin;
         }

      bool UsesTransparency (
         ) const {
         if (m_FrameShape != FRAMESHAPE_None && m_FrameStyle.UsesTransparency()) return (true);
         return (m_LeaderStyle.UsesTransparency());
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      POLYSTYLE m_FrameStyle;
      LINESTYLE m_LeaderStyle;
      FRAMESHAPE m_FrameShape;
      double m_Margin;        //!< Units: % of font ascent 
      bool m_bCartoonBalloonLeaders;
      double m_TMargin;       //!< Units: % of font ascent
      double m_BMargin;       //!< Units: % of font ascent
      double m_LMargin;       //!< Units: % of font ascent
      double m_RMargin;       //!< Units: % of font ascent
      int m_Arrow;

      friend class SML_LABELFRAMEPARMS;   // SML Implementation 
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//! In-memory structure for labels with frames and leaders
class LABELSTYLE : public LABELFRAMEPARMS {
   public:

      //! Default constructor
      LABELSTYLE (
         ) :
         LABELFRAMEPARMS(),
         m_DesignScale(0.0),
         m_bClipUnderPass(false),
         m_BaselineFlag(MGD::BASELINE_Straight)
         {
         }
      
      //! Construct from base class
      LABELSTYLE (
         const LABELFRAMEPARMS& rhs
         ) :
         LABELFRAMEPARMS(rhs),
         m_DesignScale(0.0),
         m_bClipUnderPass(false),
         m_BaselineFlag(MGD::BASELINE_Straight)
         {
         }
      
      //! Copy constructor.
      LABELSTYLE (                           
         const LABELSTYLE& rhs
         ): LABELFRAMEPARMS(rhs) { MyCopy(rhs); }

      //! Destructor.
      ~LABELSTYLE() {}
      
      //! Assignment 
      LABELSTYLE& operator= (             
         const LABELSTYLE& rhs
         ) { if (this != &rhs) { MyCopy(rhs); } return (*this); }


      MGD::BASELINE GetBaselineFlag (
         ) const {
         return m_BaselineFlag;
         }

      const RVC::STYLE::LINEPATTERN& GetBorderPattern (
         ) const {
         return m_BorderPattern;
         }

      bool GetClipUnderPass (
         ) const {
         return m_bClipUnderPass;
         }

      double GetDesignScale (
         ) const {
         return m_DesignScale;
         }

      const RVC::STYLE::BASEPATTERN& GetFramePattern (
         ) const {
         if (GetFrameStyle().StyleFlags & STYLEFLAG_UseHatchPatt) return m_FramePatternH;
         return m_FramePatternB;
         }

      const RVC::STYLE::LINEPATTERN& GetLeaderPattern (
         ) const {
         return m_LeaderPattern;
         }

      const TEXTSTYLE& GetTextStyle (
         ) const {
         return m_TextStyle;
         }

      void SetBaselineFlag (
         MGD::BASELINE flags
         ) {
         m_BaselineFlag = flags;
         }

      void SetBorderPattern (
         const RVC::STYLE::LINEPATTERN& pattern
         ) {
         m_BorderPattern = pattern;
         }

      void SetClipUnderPass (
         bool state
         ) {
         m_bClipUnderPass = state;
         }

      void SetDesignScale (
         double scale
         ) {
         m_DesignScale = scale;
         }

      void SetFramePattern (
         const RVC::STYLE::BITMAPPATTERN& pattern
         ) {
         m_FramePatternB = pattern;
         }

      void SetFramePattern (
         const RVC::STYLE::HATCHPATTERN& pattern
         ) {
         m_FramePatternH = pattern;
         }

      void SetLeaderPattern (
         const RVC::STYLE::LINEPATTERN& pattern
         ) {
         m_LeaderPattern = pattern;
         }

      void SetTextStyle (
         const TEXTSTYLE& style
         ) {
         m_TextStyle = style;
         }

      //! Returns true if the text style is set to do antialiasing
      bool UsesAntialiasing (
         ) const {
         return (m_TextStyle.UsesAntialiasing());
         }

      //! Returns true any part of the style (text, frame or leader) uses
      //! transparency.
      //! Does not account for antialiasing text.
      bool UsesTransparency (
         ) const {
         return (m_TextStyle.UsesTransparency() || LABELFRAMEPARMS::UsesTransparency());
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      TEXTSTYLE m_TextStyle;
      double m_DesignScale;
      RVC::STYLE::BITMAPPATTERN m_FramePatternB;
      RVC::STYLE::HATCHPATTERN m_FramePatternH;
      RVC::STYLE::LINEPATTERN m_BorderPattern;
      RVC::STYLE::LINEPATTERN m_LeaderPattern;
      bool m_bClipUnderPass;
      MGD::BASELINE m_BaselineFlag;
      friend class SML_LABELSTYLE;  // SML Implementation 
      
      //! Helper method for copying.
      void MyCopy (                          
         const LABELSTYLE& rhs
         );
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

PREVENT_MEMFUNC(LABELSTYLE)

#endif   //!< INC_MI32_ELEMSTYL_H

---