rvc/quadtree.h

Go to the documentation of this file.

#ifndef INC_RVC_QUADTREE_H
#define INC_RVC_QUADTREE_H

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

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

#ifndef  INC_MI32_RECT_H
   #include <mi32/rect.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
class UNSIGNEDSET;
namespace RVC {
   class DESCRIPTOR;
   class GEOMETRIC;
   class QUADTREEHANDLE;
   }
#endif


namespace RVC {

class QSEARCHTREE : public RVC::OBJECT {
   public:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class MAKEPARMS;
      class FILTER_EXISTING;
      class FILTER_EXISTING_CURRENT;
      class FILTER_EXISTING_LEGACY;
      class FILTER_VALID;
      #endif // GENERATING_DOXYGEN_OUTPUT

      static void GenerateDftDescriptor (
         ELEMTYPE ElemType,
         OBJTYPE ParentObjType,
         DESCRIPTOR& Descriptor,
         const char* Source = 0
         );

      QSEARCHTREE ();

      QSEARCHTREE (
         const RVC::QSEARCHTREE& rhs
         );

      virtual ~QSEARCHTREE ();

      RVC::QSEARCHTREE& operator= (
         const RVC::QSEARCHTREE& rhs
         );

      ERRVALUE AddElement (
         INT32 ElemNum,                
         const DRECT2D& Extents           
         );

      ERRVALUE AddElement (
         INT32 ElemNum,                
         const DPOINT2D& Point         
         );

      ERRVALUE ChangeElement (
         INT32 OldElemNum,                      
         INT32 NewElemNum,                      
         const DRECT2D& Extents           
         );

      ERRVALUE ChangeElement (
         INT32 OldElemNum,                      
         INT32 NewElemNum,                      
         const DPOINT2D& Point               
         );

      ERRVALUE Clear (
         const MAKEPARMS& MakeParms
         );
         
      ERRVALUE CreateFromLegacy (
         QSEARCHTREE& DestObj
         );
         
      ERRVALUE DeleteElement (
         INT32 ElemNum,                      
         const DRECT2D& Extents           
         );

      ERRVALUE DeleteElement (
         INT32 ElemNum,                      
         const DPOINT2D& Point               
         );

      ELEMTYPE GetElemType (
         ) const { return (m_ElemType); } 

      ERRVALUE Make (
         const RVC::OBJECT& parent,
         const RVC::DESCRIPTOR& Descriptor,
         const MAKEPARMS& MakeParms,
         const CREDENTIALS *pCredentials RVC_DEFAULT_CREDENTIALS           
         );

      ERRVALUE Make (
         RVC::OBJITEM& ObjItem,                       
         const MAKEPARMS& MakeParms,
#ifdef RVC_CREDENTIALS_MANDATORY
         const char *Source,                    
         const CREDENTIALS *pCredentials 
#else
         const char *Source = 0,                   
         const CREDENTIALS *pCredentials = 0          
#endif
         );

      ERRVALUE Search (
         const DRECT2D& Extents,                
         SIMPLE_ARRAY<INT32>& ElemArray         
         ) const;

      ERRVALUE Search (
         const DRECT2D& Extents,                
         UNSIGNEDSET& ElemSet                   
         ) const;

      ERRVALUE Validate (
         ) const;
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual ERRVALUE v_CloseObject ();
      virtual OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsMultiObject () const;
      virtual bool v_IsObjectOpen () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenMode, MDLGPARENT parent, const CREDENTIALS *pCredentials);
      virtual bool v_ValidateObjectType (const OBJTYPE otype) const;

      QUADTREEHANDLE* m_QTreeHandle;
      ELEMTYPE m_ElemType;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class QSEARCHTREE::MAKEPARMS {
   public:
      MAKEPARMS (
         ELEMTYPE ElemType,               
         const DRECT2D& Extents,
         INT32 InitialNumItems
         ) :
         m_ElemType(ElemType),
         m_Extents(Extents),
         m_NumItems(InitialNumItems)
         {}

      ELEMTYPE GetElemType (
         ) const { return (m_ElemType); }
   
      const DRECT2D& GetExtents (
         ) const { return (m_Extents); }
   
      INT32 GetNumItems (
         ) const { return (m_NumItems); }
   
      void SetElemType (
         ELEMTYPE ElemType
         ) { m_ElemType = ElemType; }
   
      void SetExtents (
         const DRECT2D& Extents
         ) { m_Extents  = Extents; }
   
      void SetNumItems (
         INT32 NumItems
         ) { m_NumItems = NumItems; }
   
   private:
      ELEMTYPE m_ElemType;
      DRECT2D m_Extents;
      INT32 m_NumItems;
   };

class QSEARCHTREE::FILTER_EXISTING : public RVC::OBJECT::FILTER {
   public:

      FILTER_EXISTING (
         OBJTYPE ObjTypeSearchTree,       
         ELEMTYPE ElemType                
         ) : m_ObjTypeSearchTree(ObjTypeSearchTree), m_ElemType(ElemType) {}

      void SetElemType (
         ELEMTYPE ElemType
         ) { m_ElemType = ElemType; }
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      OBJTYPE m_ObjTypeSearchTree;
      ELEMTYPE m_ElemType;

      virtual bool Filter (const RVC::OBJECT& obj);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
class QSEARCHTREE::FILTER_EXISTING_CURRENT : public QSEARCHTREE::FILTER_EXISTING {
   public:

      explicit FILTER_EXISTING_CURRENT (
         ELEMTYPE ElemType
         ) : FILTER_EXISTING(OBJTYPE_QuadSearchTree_List,ElemType) { }

   };
   
class QSEARCHTREE::FILTER_VALID : public RVC::OBJECT::FILTER {
   public:
      FILTER_VALID (
         ELEMTYPE ElemType
         ) : m_ElemType(ElemType) { }

      void SetElemType (
         ELEMTYPE ElemType
         ) { m_ElemType = ElemType; }
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      ELEMTYPE m_ElemType;
      
      virtual bool Filter (const RVC::OBJECT& obj);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
}     // End of RVC namespace

#endif   // INC_RVC_QSEARCHTREE_H

---