/********************************************************************************
*                                                                               *
*   Copyright (C) Golaem S.A.  All Rights Reserved.                             *
*                                                                               *
*   Original code & license:                                                    *
*                                                                               *
*   OpenSteer -- Steering Behaviors for Autonomous Characters                   *
*                                                                               *
*   Copyright (c) 2002-2003, Sony Computer Entertainment America                *
*   Original author: Craig Reynolds <craig_reynolds@playstation.sony.com>       *
*                                                                               *
*   Permission is hereby granted, free of charge, to any person obtaining a     *
*   copy of this software and associated documentation files (the "Software"),  *
*   to deal in the Software without restriction, including without limitation   *
*   the rights to use, copy, modify, merge, publish, distribute, sublicense,    *
*   and/or sell copies of the Software, and to permit persons to whom the       *
*   Software is furnished to do so, subject to the following conditions:        *
*                                                                               *
*   The above copyright notice and this permission notice shall be included in  *
*   all copies or substantial portions of the Software.                         *
*                                                                               *
*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  *
*   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,    *
*   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL    *
*   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  *
*   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING     *
*   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER         *
*   DEALINGS IN THE SOFTWARE.                                                   *
*                                                                               *
********************************************************************************/

#pragma once

#include <glmSimuEntityHandle.h>
#include <glmArray.h>

namespace glm
{
	class Simulation;
	class EntitiesManager;
	class Vector3;

	/// A AbstractProximityDatabase-style wrapper for the LQ bin lattice system
	class AbstractProximityDatabase
	{
	public:

		GLM_ABSTRACTCLASS_STAT_ID( glm::MemoryStatIds::Simulation);

		virtual ~AbstractProximityDatabase();

		// "token" to represent objects stored in the database
		class AbstractTokenType
		{
		public:

			GLM_ABSTRACTCLASS_STAT_ID( glm::MemoryStatIds::Simulation);

			// constructor
			AbstractTokenType();

			// destructor
			virtual ~AbstractTokenType();

			SimuEntityHandle _entityHandle;

		};

		virtual void registerToken(AbstractTokenType* token) = 0;
		virtual void unregisterToken(AbstractTokenType* token) = 0;

		// the client object calls this each time its position changes
		virtual void updateForNewPosition(AbstractTokenType* token) = 0;

		// find all neighbors within the given sphere (as center and radius)
		virtual void findNeighbors(const Vector3& position, const float radius, glm::Array<SimuEntityHandle>& neighbors) = 0;

		virtual void allocateTokens(int typeIndex, int64_t count) = 0;
		virtual AbstractTokenType* getToken(int typeIndex, int64_t index) = 0;

	protected:

		AbstractProximityDatabase(Simulation* simulation);

		Simulation* _simulation;
	};
}
