viewable.h

Go to the documentation of this file.

/**
 * \file viewable.h <gre/viewable.h>
 * \brief GRE::VIEWABLE class definition
 *
 * \if NODOC
 * $Id: viewable.h_v 1.28 2005/09/15 16:40:17 mju Exp $
 *
 * $Log: viewable.h_v $
 * Revision 1.28  2005/09/15 16:40:17  mju
 * Fix unref parm warning.
 *
 * Revision 1.27  2005/07/11 19:33:40  mju
 * Add mainscript.destroy method.
 *
 * Revision 1.26  2005/05/02 17:44:47  mju
 * Add getTopViewable and highlightMode methods.
 *
 * Revision 1.25  2005/02/24 14:42:55  mju
 * Add mainscript.callFunction variant to allow passing arg ptrs directly.
 *
 * Revision 1.23  2004/09/07 15:11:58  dwilliss
 * Added two new script functions
 *
 * Revision 1.22  2004/09/03 22:50:25  dwilliss
 * Added some methods to MAINSCRIPT
 *
 * Revision 1.21  2004/08/10 13:20:42  mju
 * Add control script fns for onGroupDrawLabelsBegin/End.
 *
 * Revision 1.20  2004/02/19 22:03:25  mju
 * Add func_onViewDataTipShowText for ctrl script.
 *
 * Revision 1.19  2004/02/09 21:11:20  mju
 * Add ifdef for getcontrolscript.
 *
 * Revision 1.18  2004/02/09 18:53:03  mju
 * Make mainscript class public and add Has/CallFunction methods.
 *
 * Revision 1.17  2004/01/23 20:53:03  scowan
 * Fixed for non-mgui.
 *
 * Revision 1.16  2004/01/16 21:59:38  mju
 * More ControlScript stuff.
 *
 * Revision 1.15  2004/01/12 21:20:52  mju
 * Add MAINSCRIPT.
 *
 * Revision 1.14  2003/11/10 18:43:55  mju
 * Add SaveObjItem and methods to manage.
 *
 * Revision 1.13  2003/11/04 18:43:19  mju
 * Add DlgObjMgr methods.
 *
 * Revision 1.12  2003/09/19 19:45:26  mju
 * Add pFallbackPixel to RenderToRaster.
 *
 * Revision 1.11  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.10  2003/08/29 20:13:27  mju
 * Add rect ptr to RenderToRaster.
 * Add v_GetExtents.
 *
 * Revision 1.9  2003/08/26 21:02:17  dwilliss
 * Added static SMLClassInstall method
 *
 * Revision 1.8  2003/07/30 15:48:28  mju
 * Ignore private sections.
 *
 * Revision 1.7  2003/07/29 15:45:26  mju
 * Don't define scriptlist prototypes unless X.
 *
 * Revision 1.6  2003/07/29 15:34:58  mju
 * Add UpdateViewScriptUI and Clear...ScriptList.
 *
 * Revision 1.5  2003/06/24 16:25:01  mju
 * Support saving macro/toolscripts with viewable.
 *
 * Revision 1.4  2003/06/18 13:56:49  mju
 * Include stuff for MFC.
 *
 * Revision 1.3  2003/06/17 13:40:18  mju
 * Fix for MFC.
 *
 * Revision 1.2  2003/06/17 13:23:56  mju
 * Include simplear.h.
 *
 * Revision 1.1  2003/06/16 19:40:43  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_VIEWABLE_H
#define  INC_GRE_VIEWABLE_H

#if !defined(INC_MI32_STDAFX_H) && defined(WIN32_MFC)
#include <mi32/stdafx.h>
#endif

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

#ifndef  INC_GRE_VIEWSCRIPT_H
   #include <gre/viewscript.h>
#endif

#ifndef INC_MI32_SERIALIZ_H
   #include <mi32/serializ.h>
#endif

#ifndef  INC_MI32_MISTRING_H
   #include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

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

#if defined(X_NATIVE) && !defined(INC_MI32_XDEFNS_H)
   #include <mi32/xdefns.h>
#endif

#if defined(USE_MGUI) && !defined(INC_MI32_SML_H)
   #include <mi32/sml.h>
#endif

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

//! Base class for objects that can have "views" (GRE_LAYOUT, GRE_GROUP).
class GRE_VIEWABLE : public GRE_OBJECT {
   public:

   #ifdef USE_MGUI
      class MAINSCRIPT : public SERIALIZABLE {
         public:
            //! Externally callable functions.
            enum FUNC {
               FUNC_OnViewDataTipShowRequest,            //!< parm[GRE_VIEW,POINT2D,TOOLTIP] ret[-1=noshow,0=builtin,1=show]
               FUNC_OnViewDataTipShowText,               //!< parm[GRE_VIEW,POINT2D,TOOLTIP] ret[-1=noshow,0=builtin,1=show]
               FUNC_OnGroupDrawLabelsBegin,              //!< parm[GRE_GROUP,GRE_VIEW]
               FUNC_OnGroupDrawLabelsEnd,                //!< parm[GRE_GROUP,GRE_VIEW]
               FUNC_OnLayerDrawLabelsBegin,              //!< parm[GRE_LAYER,GRE_VIEW]
               FUNC_OnLayerDrawLabelsEnd,                //!< parm[GRE_LAYER,GRE_VIEW]
               FUNC_OnDrawLabel,                         //!< parm[LABELPLACE, GRE_LAYERDC,COLOR,Num] ret[0=builtin,1=drawn by script]
               FUNC_COUNT
               };

            MAINSCRIPT (GRE_VIEWABLE *viewable);
            virtual ~MAINSCRIPT ();
            int CallFunction (
               FUNC func,
               SMLARG *ArgIn,
               int NumArg,
               SMLARG *ArgRet = 0
               );
            int CallFunction (
               FUNC func,
               int NumArg,
               void *ArgPtr1,
               void *ArgPtr2 = 0,
               void *ArgPtr3 = 0
               );
            void Destroy ();
            int DlgEdit (MDLGPARENT dlgparent);
            bool HasFunction (FUNC func) const;
            bool HasScript () const;
            ERRVALUE Initialize ();
            void Terminate ();
         private:
            class CONTEXT;
            GRE_VIEWABLE *m_viewable;
            CONTEXT *m_pContext;
            MISTRING m_String;

            ERRVALUE CreateSMLContext (SMLCONTEXT *& smlcontext);
            static void GRECB_CtrlScript (const GRE_CALLBACK_MSG *pMsg, void *vpCtrlScript);
            static const SERIALIZER::ITEMDEF* SerialGetItemDef ();
            virtual ERRVALUE SerialRead (SERIALIZER& serializer);
            virtual ERRVALUE SerialWrite (SERIALIZER& serializer, const char *tagname = 0) const;
            friend class MAINSCRIPT::CONTEXT;
         };
   #endif

      //! Install SML class, called by internal SML function.
      static void SMLClassInstall (
         SMLCONTEXT* context
         );

      //! Destructor.
      virtual ~GRE_VIEWABLE (
         );

   #ifdef X_NATIVE
      //! Clear MacroScript list.
      void ClearMacroScriptList (
         ) { m_MacroScripts.Clear(); }
   #endif

      //! Clear save location specification.
      void ClearSaveLocation (
         ) { m_SaveObjItem.Clear(); }

   #ifdef X_NATIVE
      //! Clear ToolScript list.
      void ClearToolScriptList (
         ) { m_ToolScripts.Clear(); }
   #endif

      // Open dialog to edit 'control script' if allowed.
      ERRVALUE ControlScriptEdit (
         MDLGPARENT dlgparent
         );

      //! Destroy all views of this object.
      void DestroyAllViews (
         );

   #ifdef X_NATIVE
      void DlgObjMgrClose (
         ) { v_DlgObjMgrClose(); }

      ERRVALUE DlgObjMgrCreate (
         MDLGPARENT dlgparent
         ) { return (v_DlgObjMgrCreate(dlgparent,MISTRING::GetEmpty())); }

      ERRVALUE DlgObjMgrCreate (
         MDLGPARENT dlgparent,
         const MISTRING& title
         ) { return (v_DlgObjMgrCreate(dlgparent,title)); }

      void DlgObjMgrDestroy (
         ) { v_DlgObjMgrDestroy(); }

      bool DlgObjMgrIsOpen (
         ) const { return (v_DlgObjMgrIsOpen()); }

      void DlgObjMgrOpen (
         ) { v_DlgObjMgrOpen(); }
   #endif

      //! Draw all views of this object.
      ERRVALUE DrawAllViews (
         GRE::DRAWCONDITION condition = GRE::DRAWCONDITION_Always
         ) { return (v_DrawAllViews(condition)); }

   #ifdef USE_MGUI
      //! Get reference to "display control script".
      MAINSCRIPT& GetControlScript (
         ) { return (m_CtrlScript); }
   #endif

      //! Get overall viewable extents.
      const DRECT2D& GetExtents (
         ) const { return (v_GetExtents()); }

      //! Find layer using unique ID.
      virtual GRE_LAYER *FindLayerByID (
         UINT32 LayerID
         ) const = 0;

      //! Get 'design scale' for layout or group.
      double GetDesignScale (
         ) const { return (v_GetDesignScale()); }

      //! Get parent for dialogs relating to this object.
      MDLGPARENT GetDialogParent (
         ) const { return (m_DialogParent); }

      //! Get element highlighting mode.
      GRE::HIGHLIGHTMODE GetElemHighlightMode (
         ) const { return (GetTopViewable()->m_ElemHighlightMode); }

      //! Get first view of this object.
      //! @return Pointer to view or NULL if no views of this object.
      //!
      //! To loop through all views for an object use this method to get the first view.
      //! Then use the GRE_VIEW::GetNext() to obtain the next view, checking for NULL as shown:
      //!
      //!      for (GRE_VIEW *view = object->GetFirstView(); (view != 0); view = view->GetNext()) {
      //!         ...
      //!         }
      GRE_VIEW* GetFirstView (
         ) const;

      //! Get full object name.
      virtual void GetFullName (
         MISTRING& name                         //!< Name returned
         ) const = 0;

      //! Get name of object to use in Ini file access.
      const char* GetIniName (
         ) const { return (m_IniName); }

   #ifdef X_NATIVE
      //! Get MacroScript list.
      GRE::MACROSCRIPTLIST& GetMacroScriptList (
         ) { return (m_MacroScripts); }
   #endif

      //! Get next available unique ID.
      virtual UINT32 GetNextLayerID (
         ) const = 0;

      //! Get path to file where viewable saved.
      const FILEPATH& GetSaveFilePath (
         ) const { return (m_SaveObjItem.GetFilePath()); }

      //! Get object item reference to save location.
      const RVC::OBJITEM& GetSaveObjItem (
         ) const { return (m_SaveObjItem); }

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

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

      //! Compute dimensions of object based on scale and georeference.
      virtual ERRVALUE GetSizeMeters (
         DPOINT2D& sizemeters                   //!< Size returned in meters
         ) = 0;

   #ifdef X_NATIVE
      //! Get ToolScript list.
      GRE::TOOLSCRIPTLIST& GetToolScriptList (
         ) { return (m_ToolScripts); }
   #endif

      //! Get topmost containing viewable (const).
      const GRE_VIEWABLE* GetTopViewable (
         ) const;

      //! Get topmost containing viewable (non-const).
      GRE_VIEWABLE* GetTopViewable (
         );

      //! Get view of this object given view number.
      //! @return Pointer to view or NULL if no matching view.
      GRE_VIEW* GetView (
         int ViewNum
         ) const;

      //! Determine if object has any layers.
      virtual bool HasLayers (
         ) const = 0;

      //! Determine if save location has been specified.
      bool HasSaveLocation (
         ) const;

      //! Determine if changes have been made since last save.
      bool IsModified (
         ) const { return (m_IsModified); }

   #ifdef X_NATIVE
      //! Create "object manager" container (RowColumn) widget.
      //! @return Frame widget surrounding container.
      Widget ObjMgrCreate (
         Widget pwidget,
         Arg *arglist,
         int argcount
         );
   #endif

   #ifdef X_NATIVE
      //! Get RowColumn widget for creating items in object manager.
      Widget ObjMgrGetContainer (
         ) const { return (m_ObjMgrRC); }
   #endif

   #ifdef X_NATIVE
      //! Scroll to make specified widget visible in object manager.
      void ObjMgrMakeVisible (
         Widget widget
         );
   #endif

   #ifdef X_NATIVE
      //! Set position of item in object manager.
      //! @return Next position after item.
      short ObjMgrSetPosition (
         Widget widget,
         short newindex
         );
   #endif

      //! Render to raster.
      ERRVALUE RenderToRaster (
         RVC::OBJITEM& objitem,
         COLORSPACE colorspace,
         INT32 rastcols,
         INT32 rastlins,
         double cellsize,
         const COLOR& bgcolor,
         int viewnum = 1,
         bool savegeoref = true,
         const SIMPLE_ARRAY<COLOR>* pColors = 0,   //!< Colormap to use for COLORSPACE_Indexed
         const DRECT2D *pRect = 0,                 //!< Rectangle in viewable coordinates to limit extent
         MGD::PIXEL *pFallbackPixel = 0            //! Pointer to fallback pixel, NULL to use 'transparent'
         );

      //! Reset "is modified" status to "false".
      void ResetModified (
         ) { m_IsModified = false; }

      //! Set 'design scale' for layout or group.
      void SetDesignScale (
         double DesignScale,                    //!< Design scale to set
         bool notify = true                     //!< Send notification if changed
         ) { v_SetDesignScale(DesignScale,notify); }

      //! Set parent for dialogs relating to this object.
      void SetDialogParent (
         MDLGPARENT DialogParent
         ) { m_DialogParent = DialogParent; }

      //! Set element highlighting mode.
      void SetElemHighlightMode (
         GRE::HIGHLIGHTMODE HighlightMode
         );

      //! Set base name of object for use in Ini file acces.
      void SetIniBase (
         const char* name
         );

   #ifdef X_NATIVE
      void SetMacroScriptList (
         const GRE::MACROSCRIPTLIST& ScriptList
         ) { m_MacroScripts = ScriptList; m_IsModified = true; }
   #endif

      //! Set path to file where viewable saved.
      //! Also resets object such that expects to save to non-RVC file.
      void SetSaveFilePath (
         const FILEPATH& SaveFilePath
         );

      //! Set object item reference to save location.
      void SetSaveObjItem (
         const RVC::OBJITEM& SaveObjItem
         ) { m_SaveObjItem = SaveObjItem; }

      //! Set whether to show internal tables in table lists.
      void SetShowInternalTables (
         bool ShowInternalTables
         );

      //! Set whether to show scale ranges in layer lists.
      void SetShowScaleRanges (
         bool ShowScaleRanges
         );

   #ifdef X_NATIVE
      void SetToolScriptList (
         const GRE::TOOLSCRIPTLIST& ScriptList
         ) { m_ToolScripts = ScriptList; m_IsModified = true; }
   #endif

   #ifdef X_NATIVE
      //! Update user interface for changes to view scripts.
      void UpdateViewScriptUI (
         );
   #endif

   protected:

      bool m_IsModified;                     //!< Changes have been made since last save

      //! Constructor.
      explicit GRE_VIEWABLE (
         GRE_OBJTYPE type,                   //!< Object type
         GRE_VIEWABLE *container             //!< Containing viewable
         );

      // Initialize 'control script' if exists and is allowed.
      ERRVALUE ControlScriptInitialize (
         );

      //! Get unique index for building Ini name.
      UINT8 GetIniIndex (
         ) const { return (m_IniIndex); }

   #ifdef X_NATIVE
      //! Create initial set of items in object manager.
      virtual void ObjMgrInitItems (
         ) = 0;
   #endif

      //! Get serialization item definition array.
      static const SERIALIZER::ITEMDEF* SerialGetItemDef (
         SERIALIZER&
         ) { return (TemplateGetItemDef()); }

      //! Set index for building Ini name.
      void SetIniIndex (
         UINT8 IniIndex
         );

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

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      GRE_VIEWABLE *m_Container;             // Container viewable, 0 if at top
      bool m_ShowInternalTables;             // Show "internal" tables in table lists
      bool m_ShowScaleRanges;                // Show scale ranges in layer lists
      char m_IniName[20];                    // Name of object for use in Ini file access
      UINT8 m_IniIndex;                      // Unique index of object for use in Ini file access
      UINT8 m_IniBaseLen;                    // Length of base name not including appended index number
      MDLGPARENT m_DialogParent;             // Parent for dialogs related to this object
      RVC::OBJITEM m_SaveObjItem;            // Object item where saved
      GRE::HIGHLIGHTMODE m_ElemHighlightMode;
   #ifdef USE_MGUI
      MAINSCRIPT m_CtrlScript;
   #endif
   #ifdef X_NATIVE
      GRE::TOOLSCRIPTLIST m_ToolScripts;     // ToolScripts saved with this object
      GRE::MACROSCRIPTLIST m_MacroScripts;   // MacroScripts saved with this object
      Widget m_ObjMgrRC;                     // RowColumn container widget for "object manager"
   #endif

   #ifdef X_NATIVE
      static void CB_NotifyGreObjMgr (const GRE_CALLBACK_MSG *msg, void *vviewable);
      virtual void OnNotifyGreObjMgr (const GRE_CALLBACK_MSG& msg) = 0;
      static ERRVALUE SerialCB_MacroScript (SERIALIZER&, const SERIALIZER::ITEMDEF*, GRE_VIEWABLE *viewable, SERIALIZER::ITEMDEF::ACTION);
      static ERRVALUE SerialCB_ToolScript (SERIALIZER&, const SERIALIZER::ITEMDEF*, GRE_VIEWABLE *viewable, SERIALIZER::ITEMDEF::ACTION);
   #endif

      // GRE_VIEWABLE overridables.
   #ifdef X_NATIVE
      virtual void v_DlgObjMgrClose () = 0;
      virtual ERRVALUE v_DlgObjMgrCreate (MDLGPARENT dlgparent, const MISTRING& title) = 0;
      virtual void v_DlgObjMgrDestroy () = 0;
      virtual bool v_DlgObjMgrIsOpen () const = 0;
      virtual void v_DlgObjMgrOpen () = 0;
   #endif
      virtual ERRVALUE v_DrawAllViews (GRE::DRAWCONDITION condition) = 0;
      virtual double v_GetDesignScale () const = 0;
      virtual const DRECT2D& v_GetExtents () const = 0;
      virtual void v_SetDesignScale (double DesignScale, bool notify) = 0;

      GRE_VIEWABLE (const GRE_VIEWABLE&);
      GRE_VIEWABLE& operator= (const GRE_VIEWABLE&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   }; // End of GRE_VIEWABLE

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

#ifndef GENERATING_DOXYGEN_OUTPUT
#ifdef WIN32_MFC

class GRE_MFC_VIEWABLE : public CDocument {
   protected:

      GRE_MFC_VIEWABLE (
         GRE_VIEWABLE *viewable = 0
         );

      DECLARE_DYNCREATE(GRE_MFC_VIEWABLE)

   public:
      GRE_VIEWABLE *GetViewable (
         ) const {
         return (m_viewable);
         }

      virtual ~GRE_MFC_VIEWABLE();

   protected:

      GRE_VIEWABLE *m_viewable;

   protected:
      DECLARE_MESSAGE_MAP()
   };

#endif
#endif // GENERATING_DOXYGEN_OUTPUT


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

#endif   // INC_GRE_VIEWABLE_H

---