scriptcontext.h

Go to the documentation of this file.

/**
 * \file scriptcontext.h <gre/scriptcontext.h>
 * \brief GRE_SCRIPTCONTEXT classes
 *
 * \if NODOC
 * $Id: scriptcontext.h_v 1.2 2005/03/31 16:57:07 fileserver!dwilliss Exp $
 *
 * $Log: scriptcontext.h_v $
 * Revision 1.2  2005/03/31 16:57:07  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.1  2005/01/20 16:58:21  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_SCRIPTCONTEXT_H
#define  INC_GRE_SCRIPTCONTEXT_H

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

#ifndef INC_MI32_SML_H
   #include <mi32/sml.h>
#endif

#ifndef INC_MI32_MGD2_H
   #include <mi32/mgd2.h>
#endif

#ifndef INC_RVC_CAD_H
   #include <rvc/cad.h>
#endif

namespace RVC {
   class STYLE;
   }

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

class GRE_SCRIPTCONTEXT_DRAW {
   public:

      //! Constructor.
      GRE_SCRIPTCONTEXT_DRAW (
         );

      //! Destructor.
      virtual ~GRE_SCRIPTCONTEXT_DRAW (
         );

      //! Attach SML context.
      //! After attachment the SCRIPTCONTEXT_DRAW 'owns' the context and will destroy it when
      //! necessary.  The context pointer is passed by reference and set to NULL on return to
      //! prevent external use of the context.
      void AttachContext (
         SMLCONTEXT *& context               //!< Context to attach, will set to NULL on return
         );

      //! Create SML context using RVC::GEOMETRIC object.
      ERRVALUE CreateContext (
         RVC::GEOMETRIC& GeoObj              //!< Geometric object (VECTOR, TIN, CAD, etc)
         );

      //! Destroy attached SML context if any.
      void DestroyContext (
         ) { if (m_context != 0) { m_context->Destroy(); m_context = 0; } }

      //! Get attached SMLCONTEXT pointer.
      //! Do not free or Destroy() the returned pointer.
      SMLCONTEXT * GetContext (
         ) const { return (m_context); }

      //! Determine if have SMLCONTEXT attached.
      bool HasContext (
         ) const { return (m_context != 0); }

      //! Initialize context variables for drawing.
      ERRVALUE InitDraw (
         GRE_LAYER *layer,                   //!< Layer
         MGD::CONTEXT *gc,                   //!< Drawing device context
         const TRANS2D_MAPGEN& trans,
         bool Is3D = false                   //!< 3D setting for CartoScript
         );

      //! Initialize using layer drawing context.
      ERRVALUE InitDraw (
         GRE_LAYERDC& layerdc
         );

   protected:

      virtual void CreateSymbols (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! SML symbol pointers for standard symbols.
      struct DRAWSYMS {
         SMLSYMBOL *CurMapScale;       //!< Current Mapscale at time of drawing
         SMLSYMBOL *LayoutMapScale;    //!< Layout Mapscale at time of drawing
         SMLSYMBOL *DesignScale;       //!< Design scale at time of drawing
         };

      SMLCONTEXT *m_context;
      DRAWSYMS m_drawsym;

      GRE_SCRIPTCONTEXT_DRAW (const GRE_SCRIPTCONTEXT_DRAW&);
      GRE_SCRIPTCONTEXT_DRAW& operator= (const GRE_SCRIPTCONTEXT_DRAW&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class GRE_SCRIPTCONTEXT_STYLE : public GRE_SCRIPTCONTEXT_DRAW {
   public:

      //! Constructor.
      GRE_SCRIPTCONTEXT_STYLE (
         );

      //! Destructor.
      virtual ~GRE_SCRIPTCONTEXT_STYLE (
         );

      //! Create script segment for element and parse specified script.
      //! @return SML 'Segment' for parsed script or error < 0.
      int CreateSegment (
         ELEMTYPE elemtype,                  //!< Element type
         const MIUNICODE *scriptstr          //!< Script string
         );

      ERRVALUE Evaluate (
         int segment,                        //!< SML segment
         INT32 ElemNum,                      //!< Element number, type determined from 'segment'
         const RVC::STYLE& StyleObj,         //!< RVC Style object
         POINTSTYLE& style,                  //!< Style passed/returned
         const DPOINT2D* pt = 0,             //!< Sample point for style sample
         bool bDrawingLegendView = false     //!< true if drawing sample for legend view
         ) const;

      ERRVALUE Evaluate (
         int segment,                        //!< SML segment
         INT32 ElemNum,                      //!< Element number, type determined from 'segment'
         const RVC::STYLE& StyleObj,         //!< RVC Style object
         LINESTYLE& style,                   //!< Style passed/returned
         const SIMPLE_ARRAY<DPOINT2D>* pt = 0,     //!< Sample points for style sample
         bool bDrawingLegendView = false     //!< true if drawing sample for legend view
         ) const;

      ERRVALUE Evaluate (
         int segment,                        //!< SML segment
         INT32 ElemNum,                      //!< Element number, type determined from 'segment'
         const RVC::STYLE& StyleObj,         //!< RVC Style object
         POLYSTYLE& style,                   //!< Style passed/returned
         const SIMPLE_ARRAY<DPOINT2D>* pt = 0,     //!< Sample points for style sample
         bool bDrawingLegendView = false     //!< true if drawing sample for legend view
         ) const;

      ERRVALUE Evaluate (
         int segment,                        //!< SML segment
         RVC::CAD::ELEMENT& Element,         //!< CAD element
         const RVC::STYLE& StyleObj,         //!< RVC Style object
         const SIMPLE_ARRAY<DPOINT2D>* pt = 0,     //!< Sample points for style sample
         bool bDrawingLegendView = false     //!< true if drawing sample for legend view
         ) const;

      //! Sets the value of the sample rectangle
      void SetSampleRect (
         const DRECT2D& rect
         ) { m_stylesym.rect = rect; }

   protected:

      virtual void CreateSymbols (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! SML symbol pointers for standard symbols.
      struct STYLESYMS {
         SMLSYMBOL *Style;             //!< Style name (string)
         SMLSYMBOL *Symbol;            //!< Point symbol name (string)
         SMLSYMBOL *DrawPatt;          //!< Pattern for line drawing (string)
         SMLSYMBOL *FillPatt;          //!< Pattern for filling (string)
         SMLSYMBOL *DrawColor;         //!< Line or Point color (string)
         SMLSYMBOL *FillColor;         //!< Fill color (string)
         SMLSYMBOL *LineScale;         //!< Line Scaling (number)
         SMLSYMBOL *XScale;            //!< X scaling (number)
         SMLSYMBOL *YScale;            //!< Y scaling (number)
         SMLSYMBOL *Angle;             //!< Rotation angle (number)
         SMLSYMBOL *UseStyle;          //!< Flag to use specified style (number)
         SMLSYMBOL *DrawSymbol;        //!< Flag to use point symbol (number)
         SMLSYMBOL *DrawLinePatt;      //!< Flag to use line pattern for drawing (number)
         SMLSYMBOL *DrawBitmapPatt;    //!< Flag to use bitmap pattern for drawing (line or symbol) (number)
         SMLSYMBOL *FillBitmapPatt;    //!< Flag to use bitmap pattern for filling (number)
         SMLSYMBOL *FillHatchPatt;     //!< Flag to use hatch pattern for filling (number)
         SMLSYMBOL *FillInside;        //!< Flag set to fill inside (number)
         SMLSYMBOL *DrawBorder;        //!< Flag set to draw border (number)
         SMLSYMBOL *MapScale;          //!< Mapscale for relative sizes
         SMLSYMBOL *DrawDone;          //!< Flag shows that drawing was already done by query
         SMLSYMBOL *DrawTransPct;      //!< Transparency percentage for "DrawColor"
         SMLSYMBOL *FillTransPct;      //!< Transparency percentage for "FillColor"
         SMLSYMBOL *DrawingSample;     //!< Drawing Sample
         SMLSYMBOL *DrawingLegendView;    //!< Drawing Sample
         SMLSYMBOL *SampleRect;        //!< Symbol when drawing a style sample
         DRECT2D rect;                 //!< The rectangle that SampleRect points to
         };

      STYLESYMS m_stylesym;

      void GetColor (
         SMLSYMBOL*,
         SMLSYMBOL*,
         COLOR& color
         ) const;

      GRE_SCRIPTCONTEXT_STYLE (const GRE_SCRIPTCONTEXT_STYLE&);
      GRE_SCRIPTCONTEXT_STYLE& operator= (const GRE_SCRIPTCONTEXT_STYLE&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class GRE_SCRIPTCONTEXT_LABEL : public GRE_SCRIPTCONTEXT_DRAW {
   public:

      //! Constructor.
      GRE_SCRIPTCONTEXT_LABEL (
         );

      //! Destructor.
      virtual ~GRE_SCRIPTCONTEXT_LABEL (
         );

      void GetFrameParms (
         LABELFRAMEPARMS& parms
         ) const;

      double GetPriority (
         ) const;

      void SetFrameParms (
         const LABELFRAMEPARMS& parms
         );

      void SetPriority (
         double priority
         );

   protected:

      virtual void CreateSymbols (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! SML symbol pointers for standard symbols.
      struct LABELSYMS {
         SMLSYMBOL *Priority;          //!< Label priority for optimization
         SMLSYMBOL *Frame;             //!< Label frame parameters
         };

      LABELSYMS m_labelsym;
      LABELFRAMEPARMS* m_FrameParms;

      GRE_SCRIPTCONTEXT_LABEL (const GRE_SCRIPTCONTEXT_LABEL&);
      GRE_SCRIPTCONTEXT_LABEL& operator= (const GRE_SCRIPTCONTEXT_LABEL&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };

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

#endif   // INC_GRE_SCRIPTCONTEXT_H

---