khanat-opennel-code/code/nel/include/nel/3d/tile_element.h
2010-06-12 12:17:29 +02:00

136 lines
4.1 KiB
C++

// NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
// Copyright (C) 2010 Winch Gate Property Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifndef NL_TILE_ELEMENT_H
#define NL_TILE_ELEMENT_H
#include "nel/misc/types_nl.h"
#include "nel/misc/stream.h"
namespace NL3D
{
#define NL_TILE_ELM_MASK_ROTATE 0x03
#define NL_TILE_ELM_OFFSET_ROTATE 0
#define NL_TILE_ELM_SIZE_ROTATE 2
#define NL_TILE_ELM_MASK_UVINFO 0x07
#define NL_TILE_ELM_OFFSET_UVINFO 6
#define NL_TILE_ELM_SIZE_UVINFO 3
#define NL_TILE_ELM_MASK_SUBNOISE 0x0F
#define NL_TILE_ELM_OFFSET_SUBNOISE 9
#define NL_TILE_ELM_SIZE_SUBNOISE 4
/** Micro-veget specific. Tells whether it is disabled, above water (the default), under water, or if it intersects a water surface.
* This state is represented encoded as an enum in CTileElement
*/
#define NL_TILE_ELM_OFFSET_VEGETABLE 13 // start at the 14 th bit
#define NL_TILE_ELM_MASK_VEGETABLE 0X03 // takes 2 bits
#define NL_TILE_ELM_SIZE_VEGETABLE 2
#define NL_TILE_ELM_LAYER_EMPTY 0xffff
// ***************************************************************************
/**
* An Element for CPatchTexture. Temporary! since CPatchTexture should be compressed...
* NB: no default ctor => must init all fields.
* \author Lionel Berenguier
* \author Nevrax France
* \date 2000
*/
class CTileElement
{
private:
uint16 Flags; // Tile Orientation, and Tile 256x256 UV offset.
public:
/// Copy this tile flags from an other tile
void copyFlagsFromOther(const CTileElement &other) { Flags = other.Flags; }
/** The three tile ident. NL_TILE_ELM_LAYER_EMPTY means no Tile for this pass. Tile[0] should be !=NL_TILE_ELM_LAYER_EMPTY.
* Else cross are drawn...
*/
uint16 Tile[3];
/** Set the tile orientation of pass i, to "orient".
* orient E [0,3]. The rotation is CCW.
*/
void setTileOrient(sint i, uint8 orient);
/** Get the tile orientation of pass i.
* orient E [0,3]. The rotation is CCW.
*/
uint8 getTileOrient(sint i) const;
/** Set the tile 256x256 information of pass 0.
*
* NB: During UV computing, orient is applied first, then tile256x256 uvOffset (only if the tile is 256x256).
* \param is256x256 is this tile a part of a 256x256
* \param uvOff the UV offset of tile 256x256. uvOff E [0,3]. Meanings:
* ---------
* | 0 | 3 |
* |___|___|
* | | |
* | 1 | 2 |
* ---------
*
*/
void setTile256Info(bool is256x256, uint8 uvOff=0);
/** Get the tile 256x256 information.
*/
void getTile256Info(bool &is256x256, uint8 &uvOff) const;
/** Set the tile SubNoise. subNoise E [0, 15].
*/
void setTileSubNoise(uint8 subNoise);
/** Get the tile SubNoise information.
*/
uint8 getTileSubNoise() const
{
return ((Flags>>NL_TILE_ELM_OFFSET_SUBNOISE) & NL_TILE_ELM_MASK_SUBNOISE);
}
void serial(NLMISC::IStream &f);
/// Micro vegetation position. Above water is the default
enum TVegetableInfo { AboveWater = 0, UnderWater, IntersectWater, VegetableDisabled, VegetInfoLast };
/// Set the micro vegetation state
void setVegetableState(TVegetableInfo state);
/// Get the micro vegetable state for this tile
TVegetableInfo getVegetableState() const
{
return (TVegetableInfo) ((Flags >> NL_TILE_ELM_OFFSET_VEGETABLE) & NL_TILE_ELM_MASK_VEGETABLE);
}
};
} // NL3D
#endif // NL_TILE_ELEMENT_H
/* End of tile_element.h */