u_water.h

Go to the documentation of this file.

/* Copyright, 2000, 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_WATER_INSTANCE_H
#define NL_U_WATER_INSTANCE_H

#include "nel/misc/types_nl.h"
#include "u_instance.h"


namespace NLMISC
{
    class CVector2f;
    class CVector;
};


namespace NL3D {

class UDriver;

class UWaterHeightMap;


class UWaterInstance : public UInstance
{
public:
    uint32  getWaterHeightMapID() const;

    float   getHeightFactor() const;

    float   getHeight(const NLMISC::CVector2f &pos);

    float   getAttenuatedHeight(const NLMISC::CVector2f &pos, const NLMISC::CVector &viewer);


    UWaterInstance() { _Object = NULL; }
    UWaterInstance(class CWaterModel *object) { _Object = (ITransformable*)object; };
    void            attach(class CWaterModel *object) { _Object = (ITransformable*)object; };
    void            detach() { _Object = NULL; }
    bool            empty() const {return _Object==NULL;}
    class CWaterModel   *getObjectPtr() const {return (CWaterModel*)_Object;}
};


class UWaterHeightMapManager
{
public:
    static UWaterHeightMap &getWaterHeightMapFromID(uint32 ID);

    static void     setBlendFactor(UDriver *driver, float value);
    static void     releaseBlendTextures();

};

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

    virtual float   getUnitSize() const =0;

    virtual void    perturbate(const NLMISC::CVector2f &pos, float strenght, float radius) =0;

    virtual void    perturbatePoint(const NLMISC::CVector2f &pos, float strenght) =0;

    virtual float   getHeight(const NLMISC::CVector2f &pos) =0;
};





} // NL3D


#endif // NL_U_WATER_INSTANCE_H

/* End of u_water_instance.h */