Decorator.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 ROCKETCOREDECORATOR_H
00029 #define ROCKETCOREDECORATOR_H
00030 
00031 #include <Rocket/Core/ReferenceCountable.h>
00032 #include <vector>
00033 #include <Rocket/Core/Header.h>
00034 #include <Rocket/Core/Texture.h>
00035 #include <Rocket/Core/Types.h>
00036 
00037 namespace Rocket {
00038 namespace Core {
00039 
00040 class DecoratorInstancer;
00041 class Element;
00042 class PropertyDictionary;
00043 class Property;
00044 struct Texture;
00045 class TextureResource;
00046 
00053 class ROCKETCORE_API Decorator : public ReferenceCountable
00054 {
00055 public:
00056         Decorator();
00057         virtual ~Decorator();
00058 
00062         virtual DecoratorDataHandle GenerateElementData(Element* element) = 0;
00065         virtual void ReleaseElementData(DecoratorDataHandle element_data) = 0;
00066 
00070         void SetZIndex(float z_index);
00073         float GetZIndex() const;
00074 
00077         void SetSpecificity(int specificity);
00081         int GetSpecificity() const;
00082 
00086         virtual void RenderElement(Element* element, DecoratorDataHandle element_data) = 0;
00087 
00088 protected:
00090         virtual void OnReferenceDeactivate();
00091 
00096         int LoadTexture(const String& texture_name, const String& rcss_path);
00100         const Texture* GetTexture(int index = 0) const;
00101 
00107         float ResolveProperty(const PropertyDictionary& properties, const String& name, float base_value) const;
00108 
00109 private:
00110         DecoratorInstancer* instancer;
00111 
00112         // The z-index of this decorator, used to resolve render order when multiple decorators are rendered
00113         // simultaneously on the same element.
00114         float z_index;
00115         // The maximum specificity of the properties used to define the decorator.
00116         int specificity;
00117 
00118         // Stores a list of textures in use by this decorator.
00119         std::vector< Texture > textures;
00120 
00121         friend class Factory;
00122 };
00123 
00124 }
00125 }
00126 
00127 #endif