oa2DSpace.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oa2DSpace.h
//
// This file contains the definitions for classes that support searching within
// a two-dimensional space.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2004-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#ifndef oa2DSpace_P
#define oa2DSpace_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaXYTree.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaBox;
template<class T, class M, class UD>
class oaXYTree;
template<class T, class M, class UD>
class oaXYTreeProd;



// template<class T, class UD>
// class Measurer {
// public:
//     typedef UD           measurerArgumentType; // optional
//
//     static void          getObjBBox(T        object,
//                                     UD       argument,
//                                     const oaBox &bBox);
//     ...
// };


template<class T, class M, class UD>
class oa2DSearch;

// *****************************************************************************
// oa2DSpace<>
//
// This class template can be used to create a searchable two-dimensional space
// of objects of nearly arbitrary type.  The measurer class argument M defines
// the interface for measuring the objects.
// *****************************************************************************
template<class T, class M, class UD>
class oa2DSpace {
public:
                            oa2DSpace(UD measurerArgument = 0);

    void                    add(T object);
    void                    remove(T object);
    void                    clear();

    oaBoolean               findNearestNeighborToObj(T  to,
                                                     T  &result);
    oaBoolean               findNearestNeighborToArea(const oaBox   &to,
                                                      T             &result);

private:
    oaXYTree<T, M, UD>      m_tree;
    friend class oa2DSearch<T, M, UD>;
};



// *****************************************************************************
// oa2DSearch<>
//
// This class template can be used to search a two-dimensional space represented
// by oa2DSpace<>.
// *****************************************************************************
template<class T, class M, class UD>
class oa2DSearch : public oaXYTreeProd<T, M, UD> {
public:
                            oa2DSearch(oa2DSpace<T, M, UD>  *space,
                                       oaUInt4              filterSize = 0);


    virtual void            process(T) = 0;
    void                    stop();
    oaBoolean               search(const oaBox &searchArea);
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.