Public API Reference

csgeom/csrectrg.h

Go to the documentation of this file.

/*
    Copyright (C) 2001 by Christopher Nelson

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSRECTREGION_H__
#define __CS_CSRECTREGION_H__

#include "csextern.h"

#include "csgeom/csrect.h"
#include "csutil/array.h"

#ifdef CS_DEBUG     
// defining this causes the csRectRegionDebug class to be compiled in  
//#define CS_DEBUG_RECT_REG 
#endif

#ifdef CS_DEBUG_RECT_REG
  class csRandomGen;
#endif

class CS_CRYSTALSPACE_EXPORT csRectRegion
{
protected:
  static const size_t FRAGMENT_BUFFER_SIZE=64;

  csArray<csRect> region;
  csRect fragment[FRAGMENT_BUFFER_SIZE];
  size_t gather_mark;

  void fragmentRect(csRect&, csRect&, int mode);
  void nkSplit(csRect& r1, csRect& r2);
  void fragmentContainedRect(csRect &r1, csRect &r2);
  void markForGather();
  void gatherFragments();

public:
  csRectRegion();
  ~csRectRegion();

  void Include(const csRect &rect);
  void Exclude(const csRect &rect);
  void ClipTo(csRect &clip);

  inline size_t Count() const { return region.GetSize(); }
  inline const csRect& RectAt(size_t i) const { return region[i]; }
  void MakeEmpty();
};



#ifdef CS_DEBUG_RECT_REG

// this class is an alternate implementation of rectRegion 
// it uses a 100 x 100 bool array to represent which pixels
// in that area are contained in a rectangle. This class is
// intended solely to aid in debugging the csRectRegion class.

#define CS_RECT_REG_SIZE 100

class CS_CRYSTALSPACE_EXPORT csRectRegionDebug
{
private:
  bool area[CS_RECT_REG_SIZE][CS_RECT_REG_SIZE];
  csRandomGen* rand;

  // these values ought to help someone with a debugger
  // quickly locate and reproduce failed tests.
  unsigned int rand_seed;
  int num_tests_complete;

public:
  csRectRegionDebug();
  ~csRectRegionDebug();

  void Include(const csRect &rect);

  void Exclude(const csRect &rect);

  void ClipTo(const csRect &clip);
  
  void MakeEmpty();

  void AssertEqual(const csRectRegion &r);

  bool CheckBounds(const csRect &clip);

  void UnitTest();

  csRect RandRect();

  csRect RandNonEmptyRect();
};

#endif // CS_DEBUG

#endif // __CS_CSRECTREGION_H__

---