hypermgr.h

Go to the documentation of this file.

/**
 * \file hypermgr.h <gre/hypermgr.h>
 * \brief GRE HyperIndex Link Manager definitions
 *
 * \if NODOC
 * $Id: hypermgr.h_v 1.8 2005/03/31 16:57:05 fileserver!dwilliss Exp $
 *
 * $Log: hypermgr.h_v $
 * Revision 1.8  2005/03/31 16:57:05  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.7  2004/06/28 17:53:17  mju
 * Convert to spatref.
 *
 * Revision 1.6  2003/11/12 13:21:29  mju
 * Add HyperShapeTypeToElemType.
 *
 * Revision 1.5  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.4  2003/07/30 15:00:09  mju
 * Ignore stuff we don't want doc'd.
 *
 * Revision 1.3  2003/05/14 21:24:21  mju
 * Add HasLinks using viewable.
 *
 * Revision 1.2  2003/05/01 20:55:00  mju
 * Move MFC GTOOL defn to implementatiaon file.
 *
 * Revision 1.1  2003/04/30 21:40:24  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_HYPERMGR_H
#define  INC_GRE_HYPERMGR_H

#ifndef  INC_MI32_GRE_H
   #include <mi32/gre.h>
#endif

#ifndef  INC_MI32_RVCHYPER_H
   #include <mi32/rvchyper.h>
#endif

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

namespace GRE {

class HYPERIDXMGR {
   public:
      enum FINDFLAGS {
         FINDFLAG_Default =         0x00,
         FINDFLAG_SearchAllElem =   0x01,
         FINDFLAG_FirstOnly =       0x02
         };
   };
DEFINE_ENUM_OP_BITWISE(HYPERIDXMGR::FINDFLAGS);

}  //! End namespace GRE

//===================================================================================================================
// Legacy definitions - Begin

#define  HYPERDRAWFLAG_Highlight          0x01
#define  HYPERDRAWFLAG_Unhighlight        0x02
#define  HYPERDRAWFLAG_ShowTransparent    0x04
#define  HYPERDRAWFLAG_NoDraw             0x08

struct MDISPHYPERSHAPE {
   DPOINT2D min;                       //!< Minimum extents in object coordinates
   DPOINT2D max;                       //!< Maximum extents in object coordinates
   COLOR color;                        //!< Color to draw shape in
   INT32 elem;                         //!< Element number for vector links
   UINT32 NumPoints;                   //!< Number of points used to define shape
   INT32 NumLinks;                     //!< Number of links to this shape
   INT16 ShapeType;                    //!< HYPERSHAPE_...
   UINT8 Highlighted;                  //!< Set if shape is currently highlighted
   DPOINT2D *points;                   //!< Array of points if appropriate
   HYPERLINK *Links;                   //!< Array of links (defined in rvchyper.h)
   };

struct MDISPHYPERSHAPELIST {
   int NumShapes;                      //!< Number of shapes in array
   int NumAllocated;                   //!< Number of shapes allocated
   MDISPHYPERSHAPE *Shapes;            //!< Array of shapes
   };

struct MDISPHYPERLINKLIST {
   int NumLinks;                       //!< Number of links in array
   int NumAllocated;                   //!< Number of links allocated
   HYPERLINK *Links;                   //!< Array of links (defined in rvchyper.h)
   MDISPHYPERLINKLIST ()
      { memset(this,0,sizeof(*this)); }
   };


//===================================================================================================================
// Legacy definitions - Begin

#ifndef GENERATING_DOXYGEN_OUTPUT
#if defined(WIN32_MFC)
//! HyperIndex Navigator tool (MFC only).
class GRE_MFC_TOOL_HYPERNAV : public GRE_TOOL {
   public:

      //! Constructor.
      explicit GRE_MFC_TOOL_HYPERNAV (
         GRE_MFC_VIEW *view
         );

      //! Destructor.
      virtual ~GRE_MFC_TOOL_HYPERNAV ();

      //! Get setting for 'verify selection' option.
      bool GetVerifySelection (
         ) const { return (m_VerifySelection); }

      //! Back up to previous level.
      ERRVALUE GoBack ();

      //! Return to home level.
      ERRVALUE GoHome ();

      //! Set whether to verify selection.
      void SetVerifySelection (
         bool VerifySelection
         ) { m_VerifySelection = VerifySelection; }

   private:

      struct ARROWSHAPE {
         INT32 num;              //!< Index into array of sibling shapes
         double dist;            //!< Distance for sorting
         };

      struct ARROWLIST {
         int NumShapes;
         int NumAllocated;
         ARROWSHAPE *Shapes;
         void *ToolTip; 
         };

      struct HYPERSTACK {
         MIUNICODE filename[FILENAME_MAX];      //!< File containing saved layout/group for previous level
         INT32 inode;                        //!< Inode of saved layout/group for previous level
         HYPERLINK link;                     //!< Link that was used for _this_ level
         MDISPHYPERSHAPELIST SiblingList;    //!< List of siblings to current level
         INT32 CurrentSiblingNum;            //!< Current sibling shape number (for center button ToolTip)
         MIUNICODE layoutfname[FILENAME_MAX];   //!< Filename from MDISP...->savefilename
         INT32 layoutinode;                  //!< Inode from MDISP...->saveinode
         HYPERSTACK *prev;
         };

      class GTOOL;

      GRE_MFC_VIEW *m_mfcview;
      GTOOL *m_pgtool;
      HYPERSTACK *m_Stack;
      MDISPHYPERLINKLIST m_LinkList;
//!      MDISPHYPERLINKLIST m_LateralList;
      DPOINT2D m_MapPoint;
      SPATREF::COORDREFSYS m_MapCoordRefSys;
//!      ARROWLIST m_ArrowList[9];
      bool m_ShowLinks;
      bool m_ShowHiddenLinks;
      bool m_VerifySelection;

      void Apply ();
      int CreateSiblingList (GRE_GROUP*);
      virtual bool DoActivate ();
      virtual void DoDeactivate ();
      virtual void DoResume ();
      virtual void DoSuspend ();
      void FindNeighbors ();
      void FreeList ();
      void FreeStackTop ();
      void ReplaceLevel (const HYPERLINK& link, bool push = true);
      void SelectLink ();
      void UpdatePosition ();

      friend class GRE_MFC_TOOL_HYPERNAV::GTOOL;
   };
#endif
#endif //!< GENERATING_DOXYGEN_OUTPUT

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

//! Draw specified HyperIndex shape for layer.
ERRVALUE MdispHyperDrawShape (
   GRE_VIEW *view, 
   GRE_LAYER *layer, 
   int obj, 
   const TRANS2D_MAPGEN& LayerToDisp,
   INT32 shapenum, 
   UINT32 drawflags
   );

//! Draw specified HyperIndex shape for layer.
ERRVALUE MdispHyperDrawShape (
   GRE_VIEW *view, 
   GRE_LAYER *layer, 
   int obj, 
   INT32 shapenum, 
   UINT32 drawflags
   );

//! Draw all HyperIndex link shapes for view.
int MdispHyperDrawShapes (
   GRE_VIEW *view, 
   UINT32 drawflags
   );

//! Convert ellipse to rectangle corner points.
void MdispHyperEllipseToRect (
   DPOINT2D *pt, 
   double rx, 
   double ry, 
   double theta, 
   DPOINT2D *c
   );

//! Find shape corresponding to given layer element.
//!
//! @return Shape number, -1 if no shape, < -1 if error.
int MdispHyperFindLayerElemShape (
   GRE_LAYER *layer, 
   int ShapeType, 
   INT32 ElemNum
   );

//! Return list of shape numbers for given layer object.
//!
//! @return Number of shapes or error < 0.
int MdispHyperFindLayerObjShapes (
   GRE_VIEW *view, 
   GRE_LAYER *layer, 
   int obj,                            //!< Layer object number
   const DPOINT2D& lpoint,             //!< Point in layer's object coordinates 
   INT32 **ShapeList,                  //!< Shape numbers (within HyperIndex object) returned 
   GRE::HYPERIDXMGR::FINDFLAGS flags = GRE::HYPERIDXMGR::FINDFLAG_Default
   );

//! Find hyper links for view given point.
int MdispHyperFindLinks (
   GRE_VIEW *view, 
   const DPOINT2D *spoint,             //!< Point in "screen" coordinates
   MDISPHYPERLINKLIST *linklist,
   GRE::HYPERIDXMGR::FINDFLAGS flags = GRE::HYPERIDXMGR::FINDFLAG_Default
   );

//! Find hyper links for view given point.
int MdispHyperFindLinksView (
   GRE_VIEW *view, 
   const DPOINT2D *lpoint,             //!< Point in "view" coordinates
   MDISPHYPERLINKLIST *linklist, 
   GRE::HYPERIDXMGR::FINDFLAGS flags = GRE::HYPERIDXMGR::FINDFLAG_Default
   );

//! Free linked list.
void MdispHyperFreeLinkList (
   MDISPHYPERLINKLIST *linkedlist
   );

//! Find neighbor links/shapes for given layout.
int MdispHyperFindNeighbors (
   GRE_LAYOUT *layout,                 //!< Layout, NULL if point is in Lat-Lon
   GRE_LAYOUT *playout, 
   const DPOINT2D& point,              //!< Point in layout or Lat-Lon coordinates
   const FILEPATH& parentfilename,     //!< Name of parent file (previous navigation step)
   const MIUNICODE *parentobjname,     //!< Name of parent object
   const FILEPATH& curfilename,        //!< Name of current file to exclude from neighbor list
   const MIUNICODE *curobjname,        //!< Name of current object to exclude from neighbor list
   HYPERLINK neighbors[8]              //!< Array of neighbors returned
   );

//! Free shape list.
void MdispHyperFreeShapeList (
   MDISPHYPERSHAPELIST *shapelist
   );

//! Get shape list for specified layer.
int MdispHyperGetLayerObjShapeList (
   GRE_LAYER *layer, 
   int obj, 
   MDISPHYPERSHAPE **pShapes,          //!< Pointer returned, DO NOT FREE
   INT32 *pNumShapes
   );

//! Get RVC object type for HyperIndex link type.
int MdispHyperGetLinkObjType (
   int linktype
   );

//! Determine if has any hyperlinks for specified viewable.
bool MdispHyperHasLinks (
   GRE_VIEWABLE *viewable
   );

//! Determine if has any hyperlinks for specified point.
bool MdispHyperHasLinks (
   GRE_VIEW *view, 
   const DPOINT2D& spoint,             //!< Point in "screen" coordinates
   GRE::HYPERIDXMGR::FINDFLAGS flags = GRE::HYPERIDXMGR::FINDFLAG_Default
   );

//! Initialize HyperIndex module.
void MdispHyperInit (void);

//! Close HyperIndex object for specified layer object.
int MdispHyperObjectClose (
   GRE_LAYER *layer, 
   int obj, 
   int CloseFile
   );

//! Return HyperIndex object handle for specified layer object.
int MdispHyperObjectGetHandle (
   GRE_LAYER *layer, 
   int obj
   );

//! Open HyperIndex object for specified layer object.
//!
//! @return TRUE if opened file, FALSE if file was already open, < 0 if error.
int MdispHyperObjectOpen (
   GRE_LAYER *layer, 
   int obj, 
   RVCHYPERINFO *hyperinfo, 
   int writemode
   );

//! Convert rectangle (corner points) to ellipse.
void MdispHyperRectToEllipse (
   DPOINT2D *pt,                       //!< Center of ellipse returned
   double *rx,                         //!< X Radius returned
   double *ry,                         //!< Y Radius returned
   double *theta,                      //!< Rotation angle returned
   DPOINT2D *c                         //!< Rectangle corners
   );
   
//! Add HyperIndex shape to array of shapes for layer.
int MdispHyperShapeAddToLayer (
   GRE_LAYER *layer, 
   int obj,                            //!< Layer object
   INT32 shapenum
   );

//! Delete HyperIndex shape from layer.
int MdispHyperShapeDelete (
   GRE_LAYER *layer, 
   int obj,                            //!< Layer object
   INT32 shapenum
   );

//! Determine ELEMTYPE for HyperIndex ShapeType (HYPERSHAPE...)
//! @return Element type, ELEMTYPE_Empty if can't convert.
ELEMTYPE MdispHyperShapeTypeToElemType (
   GRE_LAYER *layer,                   //!< Layer
   INT16 ShapeType                     //!< HYPERSHAPE_... shape type
   );

//! Update after any change to shape (except deletion)/
int MdispHyperShapeUpdate (
   GRE_LAYER *layer, 
   int obj,                            //!< Layer object
   INT32 shapenum
   );

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

#endif   //!< INC_GRE_HYPERMGR_H

---