hyperidx.h

Go to the documentation of this file.

/**
 * \file rvc/hyperidx.h 
 * \brief interface for the RVC::HYPERINDEX class.
 *
 * \if NODOC
 * $Id: hyperidx.h_v 1.14 2003/10/07 17:32:45 scowan Exp $
 *
 * $Log: hyperidx.h_v $
 * Revision 1.14  2003/10/07 17:32:45  scowan
 * Object virtual method changes.
 *
 * Revision 1.13  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.12  2003/09/25 21:20:04  dwilliss
 * Fixed doxygen comment
 *
 * Revision 1.11  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.10  2003/05/12 20:40:30  scowan
 * Adjusted to document link nested class.
 *
 * Revision 1.9  2001/06/14 18:55:33  scowan
 * Added to RVC namespace.
 *
 * Revision 1.8  2001/01/03 17:49:53  mju
 * Add new LINKTO types.
 *
 * Revision 1.7  2000/12/01 17:52:59  scowan
 * *** empty log message ***
 *
 * Revision 1.6  2000/12/01 16:55:08  scowan
 * Fixed MAC errors, undid Mike's changes to private methods.
 *
 * Revision 1.5  2000/12/01 16:21:13  mju
 * Add new scale types.
 * Change nested class/enum names.
 *
 * Revision 1.3  2000/11/17 15:45:00  scowan
 * Fixed compile error.
 *
 * Revision 1.1  2000/09/29 16:40:26  scowan
 * Initial revision
 *
 * \endif
**/

//!   \class RVC::HYPERINDEX rvc/hyperidx.h
//!   \brief Manages RVC::OBJTYPE_HyperIndex RVC objects.  
//!   
//!   The interface currently wraps the MfHyper functions.
//!   
//!   This class inherits from RVC::OBJECT
//!   
//!   RVC Object Types that this class supports: RVC::OBJTYPE_HyperIndex
//!
//!   Default RVC Object Type for this class: RVC::OBJTYPE_HyperIndex
//!
//!   Valid parents for this class:
//!      - RVC::OBJTYPE_Vector
//!      RVC::OBJTYPE_TIN
//!      RVC::OBJTYPE_CAD
//!      RVC::OBJTYPE_Raster
//!      RVC::OBJTYPE_RasterSet
//!      RVC::OBJTYPE_Hyperspectral

#ifndef INC_RVC_HYPERIDX_H
#define INC_RVC_HYPERIDX_H

#ifndef INC_RVC_OBJECT_H
   #include <rvc/object.h>
#endif

#ifndef INC_MI32_ELEMTYPE_H
   #include <mi32/elemtype.h>
#endif

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

#ifndef INC_MI32_DOUBLEAR_H
   #include <mi32/doublear.h>
#endif

//Ignore
struct DRECT3D;
struct HYPERSHAPE;
struct HYPERLINK;
//End Ignore

namespace RVC {

class HYPERINDEX : public RVC::OBJECT {
   public:

      //Ignore
      class LINK;
      //End Ignore

      //! Default constructor
      HYPERINDEX (
         );

      //! Copy constructor
      HYPERINDEX (
         const RVC::HYPERINDEX& obj
         );

      //! Destructor
      virtual ~HYPERINDEX (
         );

      //! Assignment
      RVC::HYPERINDEX& operator= (
         const RVC::HYPERINDEX& rhs
         );

      //! Add a link to the rvc hyperindex object, do not use WriteLink() since multiple people 
      //! can be trying to add a link at the same time
      //!
      //! @return Index of new link object of error if < 0
      INT32 AddLink (
         const LINK& link                       //!< Link to add
         );

      //! Add a link to a hyper shape
      ERRVALUE AddLinkToShape (
         INT32 ShapeNum,                        //!< Shape number to add to
         INT32 LinkNum                          //!< Stored link to add
         );

      //! Change the characteristics of a hypershape
      ERRVALUE ChangeShape (
         INT32 ShapeNum,                        //!< Number of shape to change
         const HYPERSHAPE& shape,               //!< New description of shape
         const DOUBLE_ARRAY<DPOINT2D>& Points   //!< Shape boundary points, if needed
         );
         
      //! Delete given shape from the list of shapes
      //!
      //! This method deletes a shape by swapping the last shape with 'ShapeNum', 
      //! then it resizes the number of shapes by -1.
      ERRVALUE DeleteShape (
         INT32 ShapeNum                         //!< Shape number to delete
         );
         
      //! Find hyperindex shape that corresponds with the element given
      //!
      //! @return: Shape number if >= 0, -1 if none found, < -1 error.
      INT32 FindShape (
         ELEMTYPE ElemType,                     //!< Type of element to find shape for
         INT32 ElemNum                          //!< Element number to find shape for
         );

      //! Obtain the extents of the hyperindex rvc object
      ERRVALUE GetExtents (
         DRECT3D& rect                          //!< Extents of rvc hyperindex object shapes returned
         );

      //! Obtain the maximum shape size for the rvc hyperindex object
      //!
      //! @return Maximum shape size
      INT32 GetMaxShapeSize (
         );

      //! Obtain the number of links in a rvc hyperindex object
      //!
      //! @return number of links
      INT32 GetNumLinks (
         );

      //! Obtain the number of shapes in a rvc hyperindex object
      //!
      //! @return number of shapes
      INT32 GetNumShapes (
         );

      //! Read a rvc hyperindex object link element
      ERRVALUE ReadLink (
         INT32 LinkNum,                         //!< The link index to read
         LINK& link                             //!< The link storage instance
         );

      //! Read a rvc hyperindex object shape element
      ERRVALUE ReadShape (
         INT32 ShapeNum,                        //!< Shape to read
         HYPERSHAPE& shape                      //!< Shape parmeters returned
         );

      //! Read a rvc hyperindex object shape element
      ERRVALUE ReadShape (
         INT32 ShapeNum,                        //!< Shape to read
         HYPERSHAPE& shape,                     //!< Shape parmeters returned
         DOUBLE_ARRAY<DPOINT2D>& Points         //!< Shape points read in
         );
         
      //! Read a rvc hyperindex object shape element
      ERRVALUE ReadShape (
         INT32 ShapeNum,                        //!< Shape to read
         HYPERSHAPE& shape,                     //!< Shape parmeters returned
         SIMPLE_ARRAY<INT32>& Links             //!< HyperLink indexes returned
         );
         
      //! Read a rvc hyperindex object shape element
      ERRVALUE ReadShape (
         INT32 ShapeNum,                        //!< Shape to read
         HYPERSHAPE& shape,                     //!< Shape parmeters returned
         DOUBLE_ARRAY<DPOINT2D>& Points,        //!< Shape points read in
         SIMPLE_ARRAY<INT32>& Links             //!< HyperLink indexes returned
         );
         
      //! Write a rvc hyperindex object link, use AddLink() to add a link
      ERRVALUE WriteLink (
         INT32 LinkNum,                         //!< Link index to write
         const LINK& link                       //!< Link to write
         );

      //! Read a rvc hyperindex object shape element
      ERRVALUE WriteShape (
         INT32 ShapeNum,                        //!< Shape to write
         const HYPERSHAPE& shape                //!< Shape parmeters to write
         );

      //! Write a rvc hyperindex object shape
      ERRVALUE WriteShape (
         INT32 ShapeNum,                        //!< Shape index to write
         const HYPERSHAPE& shape,               //!< Shape parameters to write
         const DOUBLE_ARRAY<DPOINT2D>& Points   //!< Shape boundary
         );

      //! Write a rvc hyperindex object shape
      ERRVALUE WriteShape (
         INT32 ShapeNum,                        //!< Shape index to write
         const HYPERSHAPE& shape,               //!< Shape parameters to write
         const SIMPLE_ARRAY<INT32>& Links       //!< Link indexes for this shape to contain
         );

      //! Write a rvc hyperindex object shape
      ERRVALUE WriteShape (
         INT32 ShapeNum,                        //!< Shape index to write
         const HYPERSHAPE& shape,               //!< Shape parameters to write
         const DOUBLE_ARRAY<DPOINT2D>& Points,  //!< Shape boundary
         const SIMPLE_ARRAY<INT32>& Links       //!< Link indexes for this shape to contain
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! Implementation of RVC::OBJECT virtual methods
      virtual ERRVALUE v_CloseObject ();
      virtual OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent);

      int m_HyperID;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class HYPERINDEX::LINK {
   public:

      //! Type or object or file link is to.
      enum LINKTO {
         LINKTO_DISP2DWINDOW = 0,
         LINKTO_RasterColor,
         LINKTO_RasterGray,
         LINKTO_Vector,
         LINKTO_CAD,
         LINKTO_Layout,
         LINKTO_Group,
         LINKTO_TIN,
         LINKTO_TextFile,
         LINKTO_ExternalFile,
         LINKTO_URL,
         LINKTO_FileByAttrib,
         LINKTO_URLByAttrib,
         LINKTO_LAST
         };

      enum POSITION {
         POSITION_Click = 0,     //!< Center around mouse click
         POSITION_Center,        //!< Center of image
         POSITION_AsSaved,       //!< As saved in layout (layouts only
         POSITION_Max
         };

      //! Values for how to scale view after following link.
      //! These do not numerically correspond to the HYPERLINK_Scale... values.
      enum SCALE {
         SCALE_1X = 0,           //!< Display at 1X zoom
         SCALE_FullView,         //!< Display to fit window
         SCALE_AsSaved,          //!< Display at scale saved with layout
         SCALE_Zoomed,           //!< Display at specified zoom factor
         SCALE_ToMap             //!< Display at specified "map scale"
         };

      FILEPATH m_Filename;
      MISTRING m_Name;
      MISTRING m_Desc;
      MISTRING m_URL;
      LINKTO m_LinkTo;           //!< Type of object/document to link to
      POSITION m_PosnType;
      SCALE m_ScaleType;
      double m_ZoomFactor;       //!< Zoom factor if m_ScaleType is SCALE_Zoomed
      double m_MapScale;         //!< Map scale if m_ScaleType is SCALE_ToMap

      // CONSTRUCTORS

      //! Default constructor
      LINK (
         );

      // Default copy constructor, destructor and operator=() are used

      //! Clear all entries in the instance
      void Clear (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      ERRVALUE GetHyperLink (HYPERLINK& hlink, const FILEPATH& objfilepath) const;
      void SetHyperLink (const HYPERLINK& hlink, const FILEPATH& objfilepath);

      friend class HYPERINDEX;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     //! End of RVC namespace

#endif         //!< INC_RVC_HYPERIDX_H

---