FontEffect.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREFONTEFFECT_H
00029 #define ROCKETCOREFONTEFFECT_H
00030 
00031 #include <Rocket/Core/FontGlyph.h>
00032 
00033 namespace Rocket {
00034 namespace Core {
00035 
00036 class FontEffectInstancer;
00037 
00042 class FontEffect : public ReferenceCountable
00043 {
00044 public:
00045         FontEffect();
00046         virtual ~FontEffect();
00047 
00050         const String& GetName() const;
00051 
00055         virtual bool HasUniqueTexture() const;
00056 
00062         virtual bool GetGlyphMetrics(Vector2i& origin, Vector2i& dimensions, const FontGlyph& glyph) const;
00063 
00070         virtual void GenerateGlyphTexture(byte* destination_data, const Vector2i& destination_dimensions, int destination_stride, const FontGlyph& glyph) const;
00071 
00074         void SetColour(const Colourb& colour);
00077         const Colourb& GetColour() const;
00078 
00082         void SetZIndex(float z_index);
00085         float GetZIndex() const;
00086 
00089         void SetSpecificity(int specificity);
00093         int GetSpecificity() const;
00094 
00097         const String& GetGenerationKey() const;
00098 
00099 protected:
00101         virtual void OnReferenceDeactivate();
00102 
00103 private:
00104         FontEffectInstancer* instancer;
00105 
00106         // The name of the effect.
00107         String name;
00108 
00109         // The colour of the effect's geometry.
00110         Colourb colour;
00111 
00112         // The z-index of this font effect, used to resolve render order when multiple font effects are rendered.
00113         float z_index;
00114         // The maximum specificity of the properties used to define the font effect.
00115         int specificity;
00116 
00117         // A string identifying the properties that affected the generation of the effect's geometry and texture data.
00118         String generation_key;
00119 
00120         friend class Factory;
00121 };
00122 
00123 typedef std::vector< FontEffect* > FontEffectList;
00124 typedef std::map< String, FontEffect* > FontEffectMap;
00125 
00126 }
00127 }
00128 
00129 #endif