/* Copyright (c) 2016 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>
#import "GQTBounds.h"
#import "GQTPointQuadTreeItem.h"

@interface GQTPointQuadTree : NSObject

/**
 * Create a QuadTree with bounds. Please note, this class is not thread safe.
 *
 * @param bounds The bounds of this PointQuadTree. The tree will only accept items that fall
                 within the bounds. The bounds are inclusive.
 */
- (id)initWithBounds:(GQTBounds)bounds;

/**
 * Create a QuadTree with the inclusive bounds of (-1,-1) to (1,1).
 */
- (id)init;

/**
 * Insert an item into this PointQuadTree.
 *
 * @param item The item to insert. Must not be nil.
 * @return |NO| if the item is not contained within the bounds of this tree.
 *         Otherwise adds the item and returns |YES|.
 */
- (BOOL)add:(id<GQTPointQuadTreeItem>)item;

/**
 * Delete an item from this PointQuadTree.
 *
 * @param item The item to delete.
 * @return |NO| if the items was not found in the tree, |YES| otherwise.
 */
- (BOOL)remove:(id<GQTPointQuadTreeItem>)item;

/**
 * Delete all items from this PointQuadTree.
 */
- (void)clear;

/**
 * Retreive all items in this PointQuadTree within a bounding box.
 *
 * @param bounds The bounds of the search box.
 * @return The collection of items within |bounds|, returned as an NSArray
 *         of id<GQTPointQuadTreeItem>.
 */
- (NSArray *)searchWithBounds:(GQTBounds)bounds;

/**
 * The number of items in this entire tree.
 *
 * @return The number of items.
 */
- (NSUInteger)count;

@end