mi32/rvchyper.h

Go to the documentation of this file.

/**
 * \file rvchyper.h <mi32/rvchyper.h>
 * \brief Definitions for HyperIndex(R) objects
 *
 * \if NODOC
 * $Id: rvchyper.h_v 3.37 2005/09/26 16:45:10 scowan Exp $
 *
 * $Log: rvchyper.h_v $
 * Revision 3.37  2005/09/26 16:45:10  scowan
 * Added shape type.
 *
 * Revision 3.36  2005/03/31 16:57:20  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 3.35  2003/11/12 13:20:16  mju
 * Add new hypershape type values for cad, ShapeElem, TIN_Node.
 *
 * Revision 3.34  2003/10/20 23:43:04  scowan
 * Removed unused inlines.
 *
 * Revision 3.33  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 3.32  2003/01/02 18:43:37  scowan
 * Added sopme methods.
 *
 * Revision 3.31  2002/08/21 21:51:01  scowan
 * Fixed deprecated stuff.
 *
 * Revision 3.30  2002/08/20 15:06:35  mju
 * Use prevent_memfunc.
 *
 * Revision 3.29  2002/03/11 18:45:38  scowan
 * Fixed C linkage issue.
 *
 * Revision 3.28  2002/03/11 18:18:16  scowan
 * Added methods and deprecated mem... functions.
 *
 * Revision 3.27  2001/03/05 15:51:13  mju
 * Use const in Link copy.
 *
 * Revision 3.26  2001/01/03 17:50:25  mju
 * Add new link/shape types for linking via attribute.
 *
 * Revision 3.25  2000/12/20 18:18:28  mju
 * Fix return type of MfCopyHyperLink.
 *
 * Revision 3.24  2000/12/15 18:36:52  msmith
 * Genitor documentation.
 *
 * Revision 3.23  2000/11/30 18:09:23  mju
 * Change partialview to fracitonalview.
 *
 * Revision 3.22  2000/11/30 16:43:30  mju
 * Add HYPERLINK.ScaleValue.
 * Add more HYPERLINK_Scale... #defines.
 *
 * Revision 3.21  2000/08/11 16:47:27  scowan
 * More const.
 *
 * Revision 3.20  2000/03/27 22:01:42  scowan
 * More const.
 *
 * Revision 3.19  2000/03/22 00:07:17  scowan
 * inlcude color include file.
 *
 * Revision 3.18  1999/10/28 20:54:48  mju
 * Define HYPERLINK_ScaleTypeMax/PosnTypeMax.
 *
 * Revision 3.17  1999/10/28  20:09:12  mju
 * Add new HYPERLINK_ScaleView... defns.h
 *
 * Revision 3.16  1999/10/05  22:46:55  scowan
 * Changed header to inheritance.
 *
 * Revision 3.15  1999/07/02 17:16:41  mju
 * Update HYPERLINKOBJ_LAST.
 *
 * Revision 3.14  1999/06/02  16:35:36  scowan
 * *** empty log message ***
 *
 * Revision 3.13  1999/05/07 21:22:53  mju
 * Header restruct.
 *
 * Revision 3.12  1999/03/19  16:52:13  mju
 * Add HYPERLINKOBJ_TextFile and ExternalFile.
 *
 * Revision 3.11  1999/03/09  14:57:53  mju
 * Add #ifndef so doesn't get included multiple times.
 *
 * \endif
**/

#ifndef  INC_MI32_RVCHYPER_H
#define  INC_MI32_RVCHYPER_H

#ifndef INC_MI32_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

#ifndef INC_MI32_COLOR_H
#include <mi32/color.h>
#endif

//! Description of hyperlink object header.
struct RVCHYPERINFO : public RVCGENINFO {
   DPOINT3D min;                       //!< Min/max of points in shapes.
   DPOINT3D max;                       //!< Kept track of automatically
   UINT32 NumShapes;                   //!< Number of shapes
   UINT32 NumLinks;                    //!< Number of links
   UINT32 MaxShapeSize;                //!< Maximum shape size
   INT32 space;                        //!< Reserved
   
   RVCHYPERINFO (
      ) {Clear();}
   
   RVCHYPERINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCHYPERINFO& operator= (
      const RVCGENINFO& ginfo          //!< RVCGENINFO structure to copy from
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
      
   #ifdef RVCSYSDLL
   void CopyFrom (
      const RVCHYPERINFO& Source,
      size_t size
      ) { memcpy(static_cast<void*>(this), &Source, MIN(size, sizeof(*this))); }
   #endif
   
   //! Get object extents.
   //! @return extents of vector object
   DRECT3D GetExtents (
      ) const {
      DRECT3D rect;
      rect.xinit = min.x;     
      rect.yinit = min.y;     
      rect.zinit = min.z;     
      rect.xlast = max.x;
      rect.ylast = max.y;
      rect.zlast = max.z;
      return (rect);
      }

   //! Set extents of vector object.
   void SetExtents (
      const DRECT3D& rect
      ) {
      min.x = rect.xinit;     
      min.y = rect.yinit;     
      min.z = rect.zinit;     
      max.x = rect.xlast;
      max.y = rect.ylast;
      max.z = rect.zlast;
      return;
      }

   };

PREVENT_MEMFUNC(RVCHYPERINFO)

//! Hyperlink structure.
// This structure not stored in RVC files
// However, it is passed to a DLL, so items may only be added to the end.
struct HYPERLINK {
   MIUNICODE *filename;                //!< Name of file or URL linked to
   MIUNICODE *name;                       //!< Name of object linked to or table.field for HYPERLINKOBJ_Attrib...
   MIUNICODE *desc;                       //!< Link description
   MIUNICODE *HyperName;                  //!< OBSOLETE
   UINT16 otype;                       //!< HYPERLINKOBJ_... object type
   UINT16 PosnType;                    //!< Positioning type, HYPERLINK_Posn...
   UINT16 ScaleType;                   //!< Scaling type, HYPERLINK_Scale...
   UINT16 ScaleValue;                  //!< Scale value, meaning depends on ScaleType.
   UINT32 shape;                       //!< Temp: used by disphypr to keep track of stuff
   void *layer;                        //!< Temp: used by disphypr to keep track of stuff
   };

#define  HYPERLINKOBJ_DISP2DWINDOW  0  //!< Display 2D window
#define  HYPERLINKOBJ_RasterColor   1  //!< Raster color
#define  HYPERLINKOBJ_RasterGray    2  //!< Raster gray
#define  HYPERLINKOBJ_Vector        3  //!< Vector
#define  HYPERLINKOBJ_CAD           4  //!< CAD
#define  HYPERLINKOBJ_Layout        5  //!< Layout
#define  HYPERLINKOBJ_Group         6  //!< Group
#define  HYPERLINKOBJ_TIN           7  //!< TIN
#define  HYPERLINKOBJ_TextFile      8  //!< Text file
#define  HYPERLINKOBJ_ExternalFile  9  //!< External file
#define  HYPERLINKOBJ_URL           10 //!< URL
#define  HYPERLINKOBJ_AttribFile    11 //!< File specified by database attribute
#define  HYPERLINKOBJ_AttribURL     12 //!< URL specified by database attribute
#define  HYPERLINKOBJ_Shape         13 //!< Shape
#define  HYPERLINKOBJ_LAST          13 //!< Last

//! Hypershape structure.
struct HYPERSHAPE {
   DPOINT3D min;                       //!< Minimum value
   DPOINT3D max;                       //!< Maximum value
   COLOR color;                        //!< Color of shape
   INT32 elem;                         //!< Element number for vector links
   INT16 ShapeType;                    //!< 0 = square, 1 = Circle, 2 = polygon
   INT16 spare_word;                   // Align structure
   UINT32 NumPoints;                   //!< Square = 2, Circle = 2 (center, radius), poly = N
   UINT32 NumLinks;                    //!< Number of links
   };


#define HYPERSHAPEFLAG_Transparent     1

#define HYPERSHAPE_Deleted       -1    //!< Shape has been deleted
#define HYPERSHAPE_Rect          0     //!< 2 points, min and max
#define HYPERSHAPE_Circle        1     //!< Center (X,Y) followed by radius in meters (rx,ry)
#define HYPERSHAPE_Poly          2     //!< N points
#define HYPERSHAPE_VectPointAny  5     //!< Any (closest) vector point
#define HYPERSHAPE_VectLineAny   6     //!< Any (closest) vector line
#define HYPERSHAPE_VectPolyAny   7     //!< Any (closest) vector polygon
#define HYPERSHAPE_VectPoint     8     //!< Vector point
#define HYPERSHAPE_VectLine      9     //!< Vector line
#define HYPERSHAPE_VectPoly      10    //!< Vector polygon
#define HYPERSHAPE_CAD           11    //!< CAD
#define HYPERSHAPE_CAD_Any       12    //!< Any (closest) CAD element
#define HYPERSHAPE_ShapeElem     13    //!< Shape object element
#define HYPERSHAPE_ShapeElem_Any 14    //!< Any (closest) shape object element
#define HYPERSHAPE_TIN_Node      15    //!< TIN node
#define HYPERSHAPE_TIN_Node_Any  16    //!< Any (closest) TIN node


//! Values for PosnType
#define  HYPERLINK_PosnClick        0  //!< Center around mouse click
#define  HYPERLINK_PosnCenter       1  //!< Center of image
#define  HYPERLINK_PosnAsSaved      2  //!< As saved in layout (layouts only
#define  HYPERLINK_PosnTypeMax      2  //!< Maximum

//! Values for ScaleType
#define  HYPERLINK_Scale1X             0  //!< Display at 1X zoom
#define  HYPERLINK_ScaleFullView       1  //!< Display to fit window
#define  HYPERLINK_ScaleAsSaved        2  //!< Display as saved
#define  HYPERLINK_ScaleView2          3  //!< Display at 1/2 of full view
#define  HYPERLINK_ScaleView3          4  //!< Display at 1/3 of full view
#define  HYPERLINK_ScaleView4          5  //!< Display at 1/4 of full view
#define  HYPERLINK_ScaleView5          6  //!< Display at 1/5 of full view
#define  HYPERLINK_ScaleView6          7  //!< Display at 1/6 of full view
#define  HYPERLINK_ScaleView7          8  //!< Display at 1/7 of full view
#define  HYPERLINK_ScaleView8          9  //!< Display at 1/8 of full view
#define  HYPERLINK_ScaleFractionalView 10 //!< Display partial view where ScaleValue high byte is numerator and low byte is denominator
#define  HYPERLINK_ScaleMap            11 //!< Display at map scale of 1 to ScaleValue
#define  HYPERLINK_ScaleMap100         12 //!< Display at map scale of 1 to 100*ScaleValue
#define  HYPERLINK_ScaleMap1000        13 //!< Display at map scale of 1 to 1000*ScaleValue
#define  HYPERLINK_ScaleTypeMax        13 //!< Maximum

//!:Associate with "RVC HyperIndex object functions"
//!\addtogroup hyper RVC HyperIndex object functions
//!@{

#ifndef GENERATING_DOXYGEN_OUTPUT

#if defined(__cplusplus)
extern "C" {
#endif

RVCAPPLIBEXPORT int _MfHyperClose (
   int id,
   RVCHYPERINFO *info,
   int HeaderSize
   );

RVCAPPLIBEXPORT int _MfHyperHeaderReadOpen (
   int id, 
   RVCHYPERINFO *newinfo,
   int HeaderSize
   );

RVCAPPLIBEXPORT int _MfHyperHeaderWriteOpen (
   int id, 
   RVCHYPERINFO *newinfo,
   int HeaderSize
   );

RVCAPPLIBEXPORT void _MfHyperLinkCopy (
   HYPERLINK *dest, 
   const HYPERLINK *src,
   int LinkSize
   );

RVCAPPLIBEXPORT void _MfHyperLinkFree (
   HYPERLINK *link,
   int LinkSize
   );

RVCAPPLIBEXPORT int _MfHyperLinkRead (
   int id, 
   INT32 num, 
   HYPERLINK *newlink,
   int LinkSize
   );

RVCAPPLIBEXPORT int _MfHyperLinkWrite (
   int id, 
   INT32 num, 
   HYPERLINK *newlink,
   int LinkSize
   );

RVCAPPLIBEXPORT int _MfHyperMake (
   int fileindex,
   RVCHYPERINFO *info,
   int HeaderSize,
   UINT32 flags
   );

RVCAPPLIBEXPORT int _MfHyperOpen (
   int fileindex, 
   INT32 inode, 
   RVCHYPERINFO *newinfo, 
   int HeaderSize,
   UINT32 flags
   );

RVCAPPLIBEXPORT int _MfHyperShapeChange (
   int id, 
   INT32 num, 
   const HYPERSHAPE *newshape, 
   int ShapeSize,
   const DPOINT2D *points
   );

RVCAPPLIBEXPORT int _MfHyperShapeRead (
   int id, 
   INT32 num, 
   HYPERSHAPE *newshape, 
   int ShapeSize,
   DPOINT2D **points_p, 
   INT32 **links_p
   );

RVCAPPLIBEXPORT int _MfHyperShapeWrite (
   int id, 
   INT32 num, 
   const HYPERSHAPE *newshape, 
   int ShapeSize,
   const DPOINT2D *points, 
   const INT32 *links
   );

#endif //!< GENERATING_DOXYGEN_OUTPUT

//! Find a shape in a hyperlink object.
RVCAPPLIBEXPORT INT32 MfFindHyperShape (
   int id,                             //!< Object handle
   INT32 element,                      //!< Element to find
   int ShapeType                       //!< Type to find
   );

//! Return number of shapes in a hyperlink object.
//!
//! @return number of shapes
RVCAPPLIBEXPORT INT32 MfHyperNumShapes (
   int id                              //!< Object handle
   );

//! Return number of links in a hyperlink object.
RVCAPPLIBEXPORT INT32 MfHyperNumLinks (
   int id                              //!< Object handle
   );

//! Remove a link from a hyperlink shape.
RVCAPPLIBEXPORT int MfHyperShapeRemoveLink (
   int id,                             //!< Object handle
   INT32 num,                          //!< Item number
   INT32 link                          //!< Link to remove
   );

//! Add a link to a hyperlink shape.
RVCAPPLIBEXPORT int MfHyperShapeAddLink (
   int id,                             //!< Object handle
   INT32 num,                          //!< Item number
   INT32 link                          //!< Link to add
   );

//! Resize a HypderIndex shape list.
RVCAPPLIBEXPORT int MfResizeHyperShape (
   int id,                             //!< Object handle
   INT32 numshapes                     //!< Number of shapes
   );

//! Swap two hyperlink shapes
RVCAPPLIBEXPORT int MfSwapHyperShapes (
   int id,                             //!< Object handle
   INT32 item1,                        //!< Shape 1
   INT32 item2                         //!< Shape 2
   );

//! Close a previously opened hyperlink object.
inline int MfCloseHyper (
   int id,                             //!< Open hyper handle
   RVCHYPERINFO *info                  //!< Hyper info structure (can be NULL)
   ) {
   return _MfHyperClose(id, info, sizeof(RVCHYPERINFO));
   }

//! Create a new RVC hyperlink object.
inline int MfMakeHyper (
   int fileindex,                      //!< Open file handle
   RVCHYPERINFO *info,                 //!< Hyper info structure
   UINT32 flags                        //!< Flags
   ) {
   return _MfHyperMake(fileindex, info,sizeof(RVCHYPERINFO), flags);
   }

//! Open an existing RVC hyperlink object.
inline int MfOpenHyper (
   int fileindex,                      //!< Open file handle
   INT32 inode,                        //!< Hyper object inode
   RVCHYPERINFO *newinfo,              //!< Hyper info structure
   UINT32 flags                        //!< Flags
   ) {
   return _MfHyperOpen(fileindex, inode, newinfo, sizeof(RVCHYPERINFO), flags);
   }

//! Read the header for an open hyperlink given a handle.
inline int MfReadOpenHyperHeader (
   int id,                             //!< Hyperlink object handle
   RVCHYPERINFO *newinfo               //!< Header to read into
   ) {
   return _MfHyperHeaderReadOpen(id, newinfo, sizeof(RVCHYPERINFO));
   }

//! Read a hyperlink shape.
inline int MfReadHyperShape (
   int id,                             //!< hyperlink object handle
   INT32 num,                          //!< Item number
   HYPERSHAPE *newshape,               //!< Hyper shape object to read into
   DPOINT2D **points_p,                //!< Point list returned
   INT32 **links_p                     //!< Link list returned
   ) {
   return _MfHyperShapeRead(id, num, newshape, sizeof(HYPERSHAPE), points_p, links_p);
   }

//! Write a hyperlink shape.
inline int MfWriteHyperShape (
   int id,                             //!< hyperlink object handle
   INT32 num,                          //!< Item number
   const HYPERSHAPE *newshape,         //!< Hyper shape object to write from
   const DPOINT2D *points,             //!< Point list
   const INT32 *links                  //!< Link list
   ) {
   return _MfHyperShapeWrite(id, num, newshape, sizeof(HYPERSHAPE), points, links);
   }

//! Change a hyperlink shape.
inline int MfHyperChangeShape (
   int id,                             //!< hyperlink object handle
   INT32 num,                          //!< Item number
   const HYPERSHAPE *newshape,         //!< Hyper shape object to change
   const DPOINT2D *points              //!< Point list
   ) {
   return _MfHyperShapeChange(id, num, newshape, sizeof(HYPERSHAPE), points);
   }

//! Read a hyperlink.
inline int MfReadHyperLink (
   int id,                             //!< Hyperlink object handle
   INT32 num,                          //!< Item number
   HYPERLINK *newlink                  //!< Hyperlink structure to read into
   ) {
   return _MfHyperLinkRead(id, num, newlink, sizeof(HYPERLINK));
   }

//! Write a hyperlink.
inline int MfWriteHyperLink (
   int id,                             //!< Hyperlink object handle
   INT32 num,                          //!< Item number
   HYPERLINK *newlink                  //!< Hyperlink structure to write from
   ) {
   return (_MfHyperLinkWrite(id, num, newlink,sizeof(HYPERLINK)));
   }

//! Free a hyperlink.
inline void MfFreeHyperLink (
   HYPERLINK *link                     //!< Hyperlink structure to free
   ) {
   _MfHyperLinkFree(link, sizeof(HYPERLINK));
   return;
   }

//! Copy a hyperlink.
inline void MfCopyHyperLink (
   HYPERLINK *dest,                    //!< Destination hyperlink structure 
   const HYPERLINK *src                //!< Source hyperlink structure
   ) {
   _MfHyperLinkCopy(dest, src, sizeof(HYPERLINK));
   return;
   }


#if defined(__cplusplus)
}
#endif

//!@}

#endif   //!< #ifndef INC_MI32_RVCHYPER_H

---