u_global_retriever.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL 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 2, or (at your option)
 * any later version.

 * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_U_GLOBAL_RETRIEVER_H
#define NL_U_GLOBAL_RETRIEVER_H

#include "nel/misc/types_nl.h"

#include "u_retriever_bank.h"
#include "u_global_position.h"

namespace NLMISC
{
class CVector;
class CVectorD;
class CAABBox;
class CLine;
}

namespace NLPACS
{

class UGlobalPosition;

class UGlobalRetriever
{
public:
    virtual ~UGlobalRetriever() {}

    virtual bool                    testRaytrace (const NLMISC::CVectorD &v0, const NLMISC::CVectorD &v1) =0;

    virtual const NLMISC::CAABBox   &getBBox() const=0;

    virtual float                   getMeanHeight(const UGlobalPosition &pos) const =0;

    virtual sint32                  getIdentifier(const std::string &id) const =0;

    virtual const std::string       &getIdentifier(const UGlobalPosition &pos) const =0;

    virtual sint32                  getLocalRetrieverId(const UGlobalPosition &position) const =0;

    virtual bool                    buildInstance(const std::string &id, const NLMISC::CVectorD &position, sint32 &instanceId) =0;

    virtual void                    removeInstance(sint32 instanceId) =0;

    virtual uint32                  getMaterial(const UGlobalPosition &pos) const =0;

    UGlobalPosition                 retrievePosition(const NLMISC::CVectorD &estimated, double threshold, UGlobalPosition::TType retrieveSpec) const;

    virtual UGlobalPosition         retrievePosition(const NLMISC::CVector &estimated) const =0;

    virtual UGlobalPosition         retrievePosition(const NLMISC::CVectorD &estimated) const =0;

    virtual UGlobalPosition         retrievePosition(const NLMISC::CVector &estimated, float threshold) const =0;

    virtual UGlobalPosition         retrievePosition(const NLMISC::CVectorD &estimated, double threshold) const =0;

    virtual bool                    testPosition(UGlobalPosition &pos) const =0;

    virtual bool                    insurePosition(UGlobalPosition &pos) const =0;

    virtual bool                    isInterior(const UGlobalPosition &pos) const =0;
    virtual bool                    isWaterPosition(const UGlobalPosition &pos, float &waterHeight) const =0;

    virtual float                   distanceToBorder(const UGlobalPosition &pos) const =0;
    virtual void                    getBorders(const UGlobalPosition &pos, std::vector<std::pair<NLMISC::CLine, uint8> > &edges) =0;
    virtual void                    getBorders(const NLMISC::CAABBox &box, std::vector<std::pair<NLMISC::CLine, uint8> > &edges) =0;

//  virtual void                    snapToInteriorGround(UGlobalPosition &pos) const = 0;

    virtual NLMISC::CVector         getGlobalPosition(const UGlobalPosition &global) const =0;

    virtual NLMISC::CVectorD        getDoubleGlobalPosition(const UGlobalPosition &global) const =0;

    virtual void                    refreshLrAround(const NLMISC::CVector &position, float radius) =0;

    virtual void                    refreshLrAroundNow(const NLMISC::CVector &position, float radius) =0;

    static UGlobalRetriever *       createGlobalRetriever (const char* globalRetriever, const URetrieverBank* retrieverBank);

    static void                     deleteGlobalRetriever (UGlobalRetriever *retriever);
};


} // NLPACS


#endif // NL_U_GLOBAL_RETRIEVER_H

/* End of u_global_retriever.h */