1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUIFalFrameComponent.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIFalFrameComponent.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIFalFrameComponent.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Mon Jul 18 2005</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner <paul@cegui.org.uk></span>
<a name="l00005"></a>00005 <span class="comment">*************************************************************************/</span>
<a name="l00006"></a>00006 <span class="comment">/***************************************************************************</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00010"></a>00010 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00011"></a>00011 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00012"></a>00012 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00013"></a>00013 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00014"></a>00014 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00015"></a>00015 <span class="comment"> * the following conditions:</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00018"></a>00018 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00021"></a>00021 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00023"></a>00023 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00024"></a>00024 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00025"></a>00025 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00027"></a>00027 <span class="comment"> ***************************************************************************/</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _CEGUIFalFrameComponent_h_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIFalFrameComponent_h_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "CEGUIFalComponentBase.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "../CEGUIXMLSerializer.h"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00035"></a>00035 <span class="keyword">namespace </span>CEGUI
<a name="l00036"></a>00036 {
<a name="l00045"></a><a class="code" href="classCEGUI_1_1FrameComponent.html">00045</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1FrameComponent.html" title="Class that encapsulates information for a frame with background (9 images in total)">FrameComponent</a> : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection.">FalagardComponentBase</a>
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00052"></a>00052 <a class="code" href="classCEGUI_1_1FrameComponent.html" title="Class that encapsulates information for a frame with background (9 images in total)">FrameComponent</a>();
<a name="l00053"></a>00053
<a name="l00061"></a>00061 <a class="code" href="namespaceCEGUI.html#abcc051c9002a0c4b5aef7b3c275d1d98" title="Enumeration of possible values to indicate the vertical formatting to be used for an image component...">VerticalFormatting</a> getBackgroundVerticalFormatting() <span class="keyword">const</span>;
<a name="l00062"></a>00062
<a name="l00073"></a>00073 <span class="keywordtype">void</span> setBackgroundVerticalFormatting(<a class="code" href="namespaceCEGUI.html#abcc051c9002a0c4b5aef7b3c275d1d98" title="Enumeration of possible values to indicate the vertical formatting to be used for an image component...">VerticalFormatting</a> fmt);
<a name="l00074"></a>00074
<a name="l00082"></a>00082 <a class="code" href="namespaceCEGUI.html#afc5f3c788be3972de90bf6f386613b08" title="Enumeration of possible values to indicate the horizontal formatting to be used for an image componen...">HorizontalFormatting</a> getBackgroundHorizontalFormatting() <span class="keyword">const</span>;
<a name="l00083"></a>00083
<a name="l00094"></a>00094 <span class="keywordtype">void</span> setBackgroundHorizontalFormatting(<a class="code" href="namespaceCEGUI.html#afc5f3c788be3972de90bf6f386613b08" title="Enumeration of possible values to indicate the horizontal formatting to be used for an image componen...">HorizontalFormatting</a> fmt);
<a name="l00095"></a>00095
<a name="l00106"></a>00106 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a>* getImage(<a class="code" href="namespaceCEGUI.html#a5ad9da1f6296813a89c26ad88d8b8793" title="Enumeration of values referencing available images forming a frame component.">FrameImageComponent</a> part) <span class="keyword">const</span>;
<a name="l00107"></a>00107
<a name="l00121"></a>00121 <span class="keywordtype">void</span> setImage(<a class="code" href="namespaceCEGUI.html#a5ad9da1f6296813a89c26ad88d8b8793" title="Enumeration of values referencing available images forming a frame component.">FrameImageComponent</a> part, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a>* image);
<a name="l00122"></a>00122
<a name="l00139"></a>00139 <span class="keywordtype">void</span> setImage(<a class="code" href="namespaceCEGUI.html#a5ad9da1f6296813a89c26ad88d8b8793" title="Enumeration of values referencing available images forming a frame component.">FrameImageComponent</a> part, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& imageset, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& image);
<a name="l00140"></a>00140
<a name="l00152"></a>00152 <span class="keywordtype">void</span> writeXMLToStream(<a class="code" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a>& xml_stream) <span class="keyword">const</span>;
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">protected</span>:
<a name="l00155"></a>00155 <span class="comment">// implemets abstract from base</span>
<a name="l00156"></a>00156 <span class="keywordtype">void</span> render_impl(<a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>& srcWindow, <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& destRect, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">CEGUI::ColourRect</a>* modColours, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>* clipper, <span class="keywordtype">bool</span> clipToDisplay) <span class="keyword">const</span>;
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// renders the background image (basically a clone of render_impl from ImageryComponent - maybe we need a helper class?)</span>
<a name="l00159"></a>00159 <span class="keywordtype">void</span> doBackgroundRender(<a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>& srcWindow, <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& destRect, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>& colours, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>* clipper, <span class="keywordtype">bool</span> clipToDisplay) <span class="keyword">const</span>;
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">// formatting options for background</span>
<a name="l00162"></a><a class="code" href="classCEGUI_1_1FrameComponent.html#ac41edbcd5a2362d248177d637b496319">00162</a> <a class="code" href="namespaceCEGUI.html#abcc051c9002a0c4b5aef7b3c275d1d98" title="Enumeration of possible values to indicate the vertical formatting to be used for an image component...">VerticalFormatting</a> <a class="code" href="classCEGUI_1_1FrameComponent.html#ac41edbcd5a2362d248177d637b496319" title="Vertical formatting to be applied when rendering the background for the component.">d_vertFormatting</a>;
<a name="l00163"></a><a class="code" href="classCEGUI_1_1FrameComponent.html#a4322d62730195b9cc3424f6807cbbe55">00163</a> <a class="code" href="namespaceCEGUI.html#afc5f3c788be3972de90bf6f386613b08" title="Enumeration of possible values to indicate the horizontal formatting to be used for an image componen...">HorizontalFormatting</a> <a class="code" href="classCEGUI_1_1FrameComponent.html#a4322d62730195b9cc3424f6807cbbe55" title="Horizontal formatting to be applied when rendering the background for the component.">d_horzFormatting</a>;
<a name="l00164"></a>00164 <span class="comment">// images for the frame</span>
<a name="l00165"></a><a class="code" href="classCEGUI_1_1FrameComponent.html#a8db3cda87414b5c68e7f17bb6e454864">00165</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a>* d_frameImages[<a class="code" href="namespaceCEGUI.html#a5ad9da1f6296813a89c26ad88d8b8793a0ce06f9708a2f9befb78cfa6eb8f2a31" title="Max number of images for a frame.">FIC_FRAME_IMAGE_COUNT</a>];
<a name="l00166"></a>00166 };
<a name="l00167"></a>00167
<a name="l00168"></a>00168 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00169"></a>00169
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="preprocessor">#endif // end of guard _CEGUIFalFrameComponent_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
