Public Types |
enum | TextureEffectType {
ET_BUMP_MAP,
ET_ENVIRONMENT_MAP,
ET_SCROLL,
ET_ROTATE,
ET_TRANSFORM
} |
| Definition of the broad types of texture effect you can apply to a texture layer. More...
|
enum | EnvMapType { ENV_PLANAR,
ENV_CURVED
} |
| Enumeration to specify type of envmap. More...
|
enum | TextureTransformType {
TT_TRANSLATE_U,
TT_TRANSLATE_V,
TT_SCALE_U,
TT_SCALE_V,
TT_ROTATE
} |
| Useful enumeration when dealing with procedural transforms. More...
|
enum | TextureAddressingMode { TAM_WRAP,
TAM_MIRROR,
TAM_CLAMP
} |
| Texture addressing modes - default is TAM_WRAP. More...
|
enum | TextureCubeFace {
CUBE_FRONT = 0,
CUBE_BACK = 1,
CUBE_LEFT = 2,
CUBE_RIGHT = 3,
CUBE_UP = 4,
CUBE_DOWN = 5
} |
| Enum identifying the frame indexes for faces of a cube map (not the composite 3D type. More...
|
Public Methods |
| TextureLayer (bool deferLoad=false) |
| Default constructor. More...
|
| TextureLayer (const TextureLayer &oth) |
TextureLayer & | operator= (const TextureLayer &oth) |
| ~TextureLayer () |
| Default destructor. More...
|
| TextureLayer (const String &texName, int texCoordSet=0, bool deferLoad=false) |
| Name-based constructor. More...
|
void | setDeferredLoad (bool defer) |
| Mostly internal method to indicate a deferred load texture layer. More...
|
const String & | getTextureName (void) const |
| Get the name of current texture image for this layer. More...
|
void | setTextureName (const String &name) |
| Sets this texture layer to use a single texture, given the name of the texture to use on this layer. More...
|
void | setCubicTextureName (const String &name, bool forUVW=false) |
| Sets this texture layer to use a combination of 6 texture maps, each one relating to a face of a cube. More...
|
void | setCubicTextureName (const String *const names, bool forUVW=false) |
| Sets this texture layer to use a combination of 6 texture maps, each one relating to a face of a cube. More...
|
void | setAnimatedTextureName (const String &name, int numFrames, Real duration=0) |
| Sets the names of the texture images for an animated texture. More...
|
void | setAnimatedTextureName (const String *const names, int numFrames, Real duration=0) |
| Sets the names of the texture images for an animated texture. More...
|
std::pair< uint, uint > | getTextureDimensions (int frame=0) const |
| Returns the width and height of the texture in the given frame. More...
|
void | setCurrentFrame (int frameNumber) |
| Changes the active frame in an animated or multi-image texture. More...
|
int | getCurrentFrame (void) const |
| Gets the active frame in an animated or multi-image texture layer. More...
|
const String & | getFrameTextureName (int frameNumber) const |
| Gets the name of the texture associated with a frame. More...
|
int | getNumFrames (void) const |
| Gets the number of frames for a texture. More...
|
bool | isCubic (void) const |
| Returns true if this texture layer is a cubic texture, false otherwise. More...
|
bool | is3D (void) const |
| Returns true if this texture layer uses a composite 3D cubic texture. More...
|
int | getTextureCoordSet (void) const |
| Gets the index of the set of texture co-ords this layer uses. More...
|
void | setTextureCoordSet (int set) |
| Sets the index of the set of texture co-ords this layer uses. More...
|
void | setTextureTransform (const Matrix4 &xform) |
| Sets a matrix used to transform any texture coordinates on this layer. More...
|
const Matrix4 & | getTextureTransform (void) |
| Gets the current texture transformation matrix. More...
|
void | setTextureScroll (Real u, Real v) |
| Sets the translation offset of the texture, ie scrolls the texture. More...
|
void | setTextureUScroll (Real value) |
| As setTextureScroll, but sets only U value. More...
|
void | setTextureVScroll (Real value) |
| As setTextureScroll, but sets only V value. More...
|
void | setTextureUScale (Real value) |
| As setTextureScale, but sets only U value. More...
|
void | setTextureVScale (Real value) |
| As setTextureScale, but sets only V value. More...
|
void | setTextureScale (Real uScale, Real vScale) |
| Sets the scaling factor applied to texture coordinates. More...
|
void | setTextureRotate (Real degrees) |
| Sets the anticlockwise rotation factor applied to texture coordinates. More...
|
TextureAddressingMode | getTextureAddressingMode (void) const |
| Gets the texture addressing mode, i.e. More...
|
void | setTextureAddressingMode (TextureAddressingMode tam) |
| Sets the texture addressing mode, i.e. More...
|
void | setColourOperationEx (LayerBlendOperationEx op, LayerBlendSource source1=LBS_TEXTURE, LayerBlendSource source2=LBS_CURRENT, const ColourValue &arg1=ColourValue::White, const ColourValue &arg2=ColourValue::White, Real manualBlend=0.0) |
| Setting advanced blending options. More...
|
void | setColourOperation (const LayerBlendOperation op) |
| Determines how this texture layer is combined with the one below it (or the diffuse colour of the geometry if this is layer 0). More...
|
void | setColourOpMultipassFallback (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor) |
| Sets the multipass fallback operation for this layer, if you used TextureLayer::setColourOperationEx and not enough multitexturing hardware is available. More...
|
LayerBlendModeEx | getColourBlendMode (void) const |
| Get multitexturing colour blending mode. More...
|
LayerBlendModeEx | getAlphaBlendMode (void) const |
| Get multitexturing alpha blending mode. More...
|
SceneBlendFactor | getColourBlendFallbackSrc (void) const |
| Get the multipass fallback for colour blending operation source factor. More...
|
SceneBlendFactor | getColourBlendFallbackDest (void) const |
| Get the multipass fallback for colour blending operation destination factor. More...
|
void | setAlphaOperation (LayerBlendOperationEx op, LayerBlendSource source1=LBS_TEXTURE, LayerBlendSource source2=LBS_CURRENT, Real arg1=1.0, Real arg2=1.0, Real manualBlend=0.0) |
| Sets the alpha operation to be applied to this texture. More...
|
void | addEffect (TextureEffect &effect) |
| Generic method for setting up texture effects. More...
|
void | setEnvironmentMap (bool enable, bool planar=false) |
| Turns on/off texture coordinate effect that makes this layer an environment map. More...
|
void | setScrollAnimation (Real uSpeed, Real vSpeed) |
| Sets up an animated scroll for the texture layer. More...
|
void | setRotateAnimation (Real speed) |
| Sets up an animated texture rotation for this layer. More...
|
void | setTransformAnimation (const TextureTransformType ttype, const WaveformType waveType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1) |
| Sets up a general time-relative texture modification effect. More...
|
void | setAlphaRejectSettings (const CompareFunction func, unsigned char value) |
| Sets the way the layer will have use alpha to totally reject pixels from the pipeline. More...
|
CompareFunction | getAlphaRejectFunction (void) const |
| Gets the alpha reject function. More...
|
unsigned char | getAlphaRejectValue (void) const |
| Gets the alpha reject value. More...
|
void | removeAllEffects (void) |
| Removes all effects applied to this texture layer. More...
|
void | removeEffect (const TextureEffectType type) |
| Removes a single effect applied to this texture layer. More...
|
bool | isBlank (void) const |
| Determines if this texture layer is currently blank. More...
|
void | setBlank (void) |
| Sets this texture layer to be blank. More...
|
void | _load (void) |
| Internal method for dealing with deferred texture loading. More...
|
Protected Types |
typedef std::multimap< TextureEffectType,
TextureEffect > | EffectMap |
Protected Methods |
void | recalcTextureMatrix (void) |
| Internal method for calculating texture matrix. More...
|
void | createAnimController (void) |
| Internal method for creating animation controller. More...
|
void | createEffectController (TextureEffect &effect) |
| Internal method for creating texture effect controller. More...
|
Protected Attributes |
int | mNumFrames |
| Number of frames of animation, or frames making up cubic. More...
|
int | mCurrentFrame |
| The xurrent animation frame. More...
|
Real | mAnimDuration |
| Duration of animation in seconds. More...
|
Controller * | mAnimController |
bool | mCubic |
int | textureCoordSetIndex |
TextureAddressingMode | mAddressMode |
LayerBlendModeEx | colourBlendMode |
SceneBlendFactor | colourBlendFallbackSrc |
SceneBlendFactor | colourBlendFallbackDest |
LayerBlendModeEx | alphaBlendMode |
bool | mIsBlank |
bool | mDeferLoad |
bool | mRecalcTexMatrix |
Real | mUMod |
Real | mVMod |
Real | mUScale |
Real | mVScale |
Real | mRotate |
Matrix4 | mTexModMatrix |
CompareFunction | mAlphaRejectFunc |
unsigned char | mAlphaRejectVal |
Real | mUScrollAnim |
Real | mVScrollAnim |
Real | mRotateAnim |
String | mFrames [MAX_FRAMES] |
EffectMap | mEffects |
Friends |
class | RenderSystem |