/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

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

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef plLOSDispatch_H
#define plLOSDispatch_H

#include <vector>
#include <string_theory/string>

#include "hsGeometry3.h"

#include "pnKeyedObject/hsKeyedObject.h"

#include "plPhysical/plSimDefs.h"

class plLOSRequestMsg;
struct hsMatrix44;
class plSceneObject;
class plStatusLog;

/** \class plLOSDispatch
    Line-of-sight requests are sent to this guy, who then hands them
    to the appropriate solvers, which can vary depending on such
    criteria as which subworld the player is currently in.
    Eventually we will have more variants of requests, such as 
    "search all subworlds," etc.  */
class plLOSDispatch : public hsKeyedObject
{
protected:
    enum class LOSResult
    {
        kHit,
        kCull,
        kMiss,
    };

private:
    friend class plPXRaycastQueryFilter;

    struct LOSRequest
    {
        ST::string fName;
        uint32_t fID;
        LOSResult fResult;
        plKey fHit;
        plKey fCull;

        LOSRequest(ST::string name, uint32_t id, LOSResult result, plKey hit=nullptr, plKey cull=nullptr)
            : fName(std::move(name)), fID(id), fResult(result), fHit(std::move(hit)), fCull(std::move(cull))
        { }
    };

    plStatusLog* fDebugDisplay;
    std::vector<LOSRequest> fRequests;

public:
    plLOSDispatch();
    ~plLOSDispatch();

    CLASSNAME_REGISTER(plLOSDispatch);
    GETINTERFACE_ANY(plLOSDispatch, hsKeyedObject);

    bool MsgReceive(plMessage* msg) override;

protected:
    bool ITestHit(const plSceneObject* obj) const;

    struct RaycastResult
    {
        LOSResult fResult;
        plKey fHitObj;
        hsPoint3 fPoint;
        hsVector3 fNormal;
        float fDistance;

        RaycastResult(LOSResult result, plKey hit = {}, const hsPoint3& point = { 0.f, 0.f, 0.f },
                      const hsVector3& normal = { 0.f, 0.f, 0.f }, float dist = 0.f)
            : fResult(result), fHitObj(std::move(hit)), fPoint(point),
              fNormal(normal), fDistance(dist)
        { }
    };

    RaycastResult IRaycast(hsPoint3 origin, hsPoint3 destination, const plKey& world, plSimDefs::plLOSDB db,
                           bool closest, plSimDefs::plLOSDB cullDB = plSimDefs::kLOSDBNone);
};

#endif
