Class exposing an interface to a blend map for a given layer. More...
#include <OgreTerrainLayerBlendMap.h>
Public Member Functions | |
TerrainLayerBlendMap (Terrain *parent, uint8 layerIndex, HardwarePixelBuffer *buf) | |
Constructor. More... | |
virtual | ~TerrainLayerBlendMap () |
void | blit (const PixelBox &src, const Box &dstBox) |
Blits a set of values into a region on the blend map. More... | |
void | blit (const PixelBox &src) |
Blits a set of values into the entire map. More... | |
void | convertImageToTerrainSpace (size_t x, size_t y, Real *outX, Real *outY) |
Convert image space (0, imageSize) to terrain space values (0,1). More... | |
void | convertImageToUVSpace (size_t x, size_t y, Real *outX, Real *outY) |
Convert image space (0, imageSize) to local space values (0,1). More... | |
void | convertTerrainToImageSpace (Real x, Real y, size_t *outX, size_t *outY) |
Convert terrain space values (0,1) to image space (0, imageSize). More... | |
void | convertUVToImageSpace (Real x, Real y, size_t *outX, size_t *outY) |
Convert local space values (0,1) to image space (0, imageSize). More... | |
void | convertUVToWorldSpace (Real x, Real y, Vector3 *outWorldPos) |
Helper method - convert a point in local space to worldspace based on the terrain settings. More... | |
void | convertWorldToUVSpace (const Vector3 &worldPos, Real *outX, Real *outY) |
Helper method - convert a point in world space to UV space based on the terrain settings. More... | |
void | dirty () |
Indicate that all of the blend data is dirty and needs updating. More... | |
void | dirtyRect (const Rect &rect) |
Indicate that a portion of the blend data is dirty and needs updating. More... | |
float * | getBlendPointer () |
Get a pointer to the whole blend data. More... | |
float | getBlendValue (size_t x, size_t y) |
Get a single value of blend information, in image space. More... | |
uint8 | getLayerIndex () const |
Get the index of the layer this is targeting. More... | |
Terrain * | getParent () const |
Get the parent terrain. More... | |
void | loadImage (const Image &img) |
Load an image into this blend layer. More... | |
void | loadImage (DataStreamPtr &stream, const String &ext=StringUtil::BLANK) |
Load an image into this blend layer. More... | |
void | loadImage (const String &filename, const String &groupName) |
Load an image into this blend layer. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | setBlendValue (size_t x, size_t y, float val) |
Set a single value of blend information (0 = transparent, 255 = solid) More... | |
void | update () |
Publish any changes you made to the blend data back to the blend map. More... | |
Protected Member Functions | |
void | download () |
void | upload () |
Protected Attributes | |
HardwarePixelBuffer * | mBuffer |
uint8 | mChannel |
uint8 | mChannelOffset |
float * | mData |
bool | mDirty |
Box | mDirtyBox |
uint8 | mLayerIdx |
Terrain * | mParent |
Class exposing an interface to a blend map for a given layer.
Each layer after the first layer in a terrain has a blend map which expresses how it is alpha blended with the layers beneath. Internally, this blend map is packed into one channel of an RGB or RGBA texture in order to use the smallest number of samplers, but this class allows a caller to manipulate the data more easily without worrying about this packing. Also, the values you use to interact with the blend map are floating point, which gives you full precision for updating, but in fact the values are packed into 8-bit integers in the actual blend map.
Definition at line 61 of file OgreTerrainLayerBlendMap.h.
Ogre::TerrainLayerBlendMap::TerrainLayerBlendMap | ( | Terrain * | parent, |
uint8 | layerIndex, | ||
HardwarePixelBuffer * | buf | ||
) |
Constructor.
parent | The parent terrain |
layerIndex | The layer index (should be 1 or higher) |
buf | The buffer holding the data |
|
virtual |
Blits a set of values into a region on the blend map.
src | PixelBox containing the source pixels and format |
dstBox | Image::Box describing the destination region in this map |
void Ogre::TerrainLayerBlendMap::blit | ( | const PixelBox & | src | ) |
void Ogre::TerrainLayerBlendMap::convertImageToTerrainSpace | ( | size_t | x, |
size_t | y, | ||
Real * | outX, | ||
Real * | outY | ||
) |
Convert image space (0, imageSize) to terrain space values (0,1).
void Ogre::TerrainLayerBlendMap::convertImageToUVSpace | ( | size_t | x, |
size_t | y, | ||
Real * | outX, | ||
Real * | outY | ||
) |
Convert image space (0, imageSize) to local space values (0,1).
void Ogre::TerrainLayerBlendMap::convertTerrainToImageSpace | ( | Real | x, |
Real | y, | ||
size_t * | outX, | ||
size_t * | outY | ||
) |
Convert terrain space values (0,1) to image space (0, imageSize).
void Ogre::TerrainLayerBlendMap::convertUVToImageSpace | ( | Real | x, |
Real | y, | ||
size_t * | outX, | ||
size_t * | outY | ||
) |
Convert local space values (0,1) to image space (0, imageSize).
Helper method - convert a point in local space to worldspace based on the terrain settings.
x,y | Local position, ranging from 0 to 1, top/bottom, left/right. |
outWorldPos | Pointer will be filled in with the world space value |
void Ogre::TerrainLayerBlendMap::convertWorldToUVSpace | ( | const Vector3 & | worldPos, |
Real * | outX, | ||
Real * | outY | ||
) |
Helper method - convert a point in world space to UV space based on the terrain settings.
worldPos | World position |
outX,outY | Pointers to variables which will be filled in with the local UV space value. Note they are deliberately signed Real values, because the point you supply may be outside of image space and may be between texels. The values will range from 0 to 1, top/bottom, left/right. |
void Ogre::TerrainLayerBlendMap::dirty | ( | ) |
Indicate that all of the blend data is dirty and needs updating.
void Ogre::TerrainLayerBlendMap::dirtyRect | ( | const Rect & | rect | ) |
Indicate that a portion of the blend data is dirty and needs updating.
rect | Rectangle in image space |
|
protected |
float* Ogre::TerrainLayerBlendMap::getBlendPointer | ( | ) |
Get a pointer to the whole blend data.
float Ogre::TerrainLayerBlendMap::getBlendValue | ( | size_t | x, |
size_t | y | ||
) |
Get a single value of blend information, in image space.
x,y | Coordinates of the point of data to get, in image space (top down) |
|
inline |
Get the index of the layer this is targeting.
Definition at line 87 of file OgreTerrainLayerBlendMap.h.
|
inline |
Get the parent terrain.
Definition at line 85 of file OgreTerrainLayerBlendMap.h.
void Ogre::TerrainLayerBlendMap::loadImage | ( | const Image & | img | ) |
Load an image into this blend layer.
void Ogre::TerrainLayerBlendMap::loadImage | ( | DataStreamPtr & | stream, |
const String & | ext = StringUtil::BLANK |
||
) |
Load an image into this blend layer.
stream | Stream containing the image data |
ext | Extension identifying the image type, if the stream data doesn't identify |
Load an image into this blend layer.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::TerrainLayerBlendMap::setBlendValue | ( | size_t | x, |
size_t | y, | ||
float | val | ||
) |
Set a single value of blend information (0 = transparent, 255 = solid)
x,y | Coordinates of the point of data to get, in image space (top down) |
val | The blend value to set (0..1) |
void Ogre::TerrainLayerBlendMap::update | ( | ) |
Publish any changes you made to the blend data back to the blend map.
|
protected |
|
protected |
Definition at line 70 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 66 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 67 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 71 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 69 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 68 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 65 of file OgreTerrainLayerBlendMap.h.
|
protected |
Definition at line 64 of file OgreTerrainLayerBlendMap.h.