Crazy Eddie's GUI System  0.8.7
ComponentBase.h
1 /***********************************************************************
2  created: Mon Jul 18 2005
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIFalComponentBase_h_
28 #define _CEGUIFalComponentBase_h_
29 
30 #include "CEGUI/falagard/Dimensions.h"
31 #include "CEGUI/Window.h"
32 #include "CEGUI/ColourRect.h"
33 
34 namespace CEGUI
35 {
37 class CEGUIEXPORT FalagardComponentBase :
38  public AllocatedObject<FalagardComponentBase>
39 {
40 public:
42  virtual ~FalagardComponentBase();
43 
58  void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0,
59  const Rectf* clipper = 0, bool clipToDisplay = false) const;
60 
79  void render(Window& srcWindow, const Rectf& baseRect,
80  const CEGUI::ColourRect* modColours = 0,
81  const Rectf* clipper = 0, bool clipToDisplay = false) const;
82 
91 
99  void setComponentArea(const ComponentArea& area);
100 
109  const ColourRect& getColours() const;
110 
118  void setColours(const ColourRect& cols);
119 
128 
136  void setColoursPropertySource(const String& property);
137 
139  virtual bool handleFontRenderSizeChange(Window& window,
140  const Font* font) const;
141 
142 protected:
152  void initColoursRect(const Window& wnd,
153  const ColourRect* modCols,
154  ColourRect& cr) const;
155 
157  virtual void render_impl(Window& srcWindow, Rectf& destRect,
158  const CEGUI::ColourRect* modColours,
159  const Rectf* clipper, bool clipToDisplay) const = 0;
160 
175  bool writeColoursXML(XMLSerializer& xml_stream) const;
176 
183 };
184 
185 }
186 
187 #endif
188 
Definition: MemoryAllocatedObject.h:110
Class that holds details of colours for the four corners of a rectangle.
Definition: ColourRect.h:45
Class that represents a target area for a widget or imagery component.
Definition: Dimensions.h:782
Common base class used for renderable components within an ImagerySection.
Definition: ComponentBase.h:39
void initColoursRect(const Window &wnd, const ColourRect *modCols, ColourRect &cr) const
Helper function to initialise a ColourRect with appropriate values according to the way the component...
void setComponentArea(const ComponentArea &area)
Set the conponent's ComponentArea.
bool writeColoursXML(XMLSerializer &xml_stream) const
Writes xml for the colours to a OutStream. Will prefer property colours before explicit.
void setColoursPropertySource(const String &property)
Set the name of the property where colour values will be obtained, if set.
void render(Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
Render this component. More correctly, the component is cached for rendering.
void setColours(const ColourRect &cols)
Set the colours to be used by this component.
ComponentArea d_area
Destination area for this component.
Definition: ComponentBase.h:178
virtual bool handleFontRenderSizeChange(Window &window, const Font *font) const
perform any processing required due to the given font having changed.
const ComponentArea & getComponentArea() const
Return the ComponentArea of this component.
const ColourRect & getColours() const
Return the ColourRect used by this component.
const String & getColoursPropertySource() const
Returns the name of the property from which the colour values will be obtained, if set.
ColourRect d_colours
base colours to be applied when rendering the image component.
Definition: ComponentBase.h:180
void render(Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
Render this component. More correctly, the component is cached for rendering.
virtual void render_impl(Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const =0
Function to do main render caching work.
String d_colourPropertyName
name of property to fetch colours from.
Definition: ComponentBase.h:182
Class that encapsulates a typeface.
Definition: Font.h:62
String class used within the GUI system.
Definition: String.h:64
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
Class used to create XML Document.
Definition: XMLSerializer.h:87
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1