source: OGRE/trunk/ogrenew/Docs/manual/manual_34.html @ 692

Revision 692, 10.1 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<HTML>
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3<!-- Created on , 12 2006 by texi2html 1.64 -->
4<!--
5Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
6            Karl Berry  <karl@freefriends.org>
7            Olaf Bachmann <obachman@mathematik.uni-kl.de>
8            and many others.
9Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
10Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
11 
12-->
13<HEAD>
14<TITLE>OGRE Manual v1.2.0 ('Dagon'): OverlayElement Attributes</TITLE>
15
16<META NAME="description" CONTENT="OGRE Manual v1.2.0 ('Dagon'): OverlayElement Attributes">
17<META NAME="keywords" CONTENT="OGRE Manual v1.2.0 ('Dagon'): OverlayElement Attributes">
18<META NAME="resource-type" CONTENT="document">
19<META NAME="distribution" CONTENT="global">
20<META NAME="Generator" CONTENT="texi2html 1.64">
21<LINK TYPE="text/css" rel="stylesheet" href="../style.css"> 
22</HEAD>
23
24<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
25
26<A NAME="SEC206"></A>
27<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_33.html#SEC200"> &lt; </A>]</TD>
29<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_33.html#SEC200"> Up </A>]</TD>
30<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_35.html#SEC217"> &gt; </A>]</TD>
31<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
32<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
33<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
34<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
35</TR></TABLE>
36<HR SIZE=1>
37<H3> 3.4.1 OverlayElement Attributes </H3>
38<!--docid::SEC206::-->
39<P>
40
41These attributes are valid within the braces of a 'container' or 'element' block in an overlay script. They must each be on their own line. Ordering is unimportant.<BR><BR>
42</P><P>
43
44<A NAME="metrics_mode"></A>
45<A NAME="SEC207"></A>
46<H3> metrics_mode </H3>
47<!--docid::SEC207::-->
48<P>
49
50Sets the units which will be used to size and position this element.<BR><BR>
51</P><P>
52
53Format: metrics_mode &#60;pixels|relative&#62;<BR>
54Example: metrics_mode pixels<BR>
55</P><P>
56
57This can be used to change the way that all measurement attributes in the rest of this element are interpreted. In relative mode, they are interpreted as being a parametric value from 0 to 1, as a proportion of the width / height of the screen. In pixels mode, they are simply pixel offsets.<BR><BR>
58</P><P>
59
60Default: metrics_mode relative<BR>
61</P><P>
62
63<A NAME="horz_align"></A>
64<A NAME="SEC208"></A>
65<H3> horz_align </H3>
66<!--docid::SEC208::-->
67<P>
68
69Sets the horizontal alignment of this element, in terms of where the horizontal origin is.<BR><BR>
70</P><P>
71
72Format: horz_align &#60;left|center|right&#62;<BR>
73Example: horz_align center<BR><BR>
74</P><P>
75
76This can be used to change where the origin is deemed to be for the purposes of any horizontal positioning attributes of this element. By default the origin is deemed to be the left edge of the screen, but if you change this you can center or right-align your elements. Note that setting the alignment to center or right does not automatically force your elements to appear in the center or the right edge, you just have to treat that point as the origin and adjust your coordinates appropriately. This is more flexible because you can choose to position your element anywhere relative to that origin. For example, if your element was 10 pixels wide, you would use a 'left' property of -10 to align it exactly to the right edge, or -20 to leave a gap but still make it stick to the right edge.<BR><BR>
77</P><P>
78
79Note that you can use this property in both relative and pixel modes, but it is most useful in pixel mode.<BR><BR>
80</P><P>
81
82Default: horz_align left<BR>
83</P><P>
84
85<A NAME="vert_align"></A>
86<A NAME="SEC209"></A>
87<H3> vert_align </H3>
88<!--docid::SEC209::-->
89<P>
90
91Sets the vertical alignment of this element, in terms of where the vertical origin is.<BR><BR>
92</P><P>
93
94Format: vert_align &#60;top|center|bottom&#62;<BR>
95Example: vert_align center<BR><BR>
96</P><P>
97
98This can be used to change where the origin is deemed to be for the purposes of any vertical positioning attributes of this element. By default the origin is deemed to be the top edge of the screen, but if you change this you can center or bottom-align your elements. Note that setting the alignment to center or bottom does not automatically force your elements to appear in the center or the bottom edge, you just have to treat that point as the origin and adjust your coordinates appropriately. This is more flexible because you can choose to position your element anywhere relative to that origin. For example, if your element was 50 pixels high, you would use a 'top' property of -50 to align it exactly to the bottom edge, or -70 to leave a gap but still make it stick to the bottom edge.<BR><BR>
99</P><P>
100
101Note that you can use this property in both relative and pixel modes, but it is most useful in pixel mode.<BR><BR>
102</P><P>
103
104Default: vert_align top<BR>
105</P><P>
106
107<A NAME="left"></A>
108<A NAME="SEC210"></A>
109<H3> left </H3>
110<!--docid::SEC210::-->
111<P>
112
113Sets the horizontal position of the element relative to it's parent.<BR><BR>
114</P><P>
115
116Format: left &#60;value&#62;<BR>
117Example: left 0.5<BR><BR>
118</P><P>
119
120Positions are relative to the parent (the top-left of the screen if the parent is an overlay, the top-left of the parent otherwise) and are expressed in terms of a proportion of screen size. Therefore 0.5 is half-way across the screen.<BR><BR>
121</P><P>
122
123Default: left 0<BR>
124</P><P>
125
126<A NAME="top"></A>
127<A NAME="SEC211"></A>
128<H3> top </H3>
129<!--docid::SEC211::-->
130<P>
131
132Sets the vertical position of the element relative to it's parent.<BR><BR>
133</P><P>
134
135Format: top &#60;value&#62;<BR>
136Example: top 0.5<BR><BR>
137</P><P>
138
139Positions are relative to the parent (the top-left of the screen if the parent is an overlay, the top-left of the parent otherwise) and are expressed in terms of a proportion of screen size. Therefore 0.5 is half-way down the screen.<BR><BR>
140</P><P>
141
142Default: top 0<BR>
143</P><P>
144
145<A NAME="width"></A>
146<A NAME="SEC212"></A>
147<H3> width </H3>
148<!--docid::SEC212::-->
149<P>
150
151Sets the width of the element as a proportion of the size of the screen.<BR><BR>
152</P><P>
153
154Format: width &#60;value&#62;<BR>
155Example: width 0.25<BR><BR>
156</P><P>
157
158Sizes are relative to the size of the screen, so 0.25 is a quarter of the screen. Sizes are not relative to the parent; this is common in windowing systems where the top and left are relative but the size is absolute.<BR><BR>
159</P><P>
160
161Default: width 1<BR>
162</P><P>
163
164<A NAME="height"></A>
165<A NAME="SEC213"></A>
166<H3> height </H3>
167<!--docid::SEC213::-->
168<P>
169
170Sets the height of the element as a proportion of the size of the screen.<BR><BR>
171</P><P>
172
173Format: height &#60;value&#62;<BR>
174Example: height 0.25<BR><BR>
175</P><P>
176
177Sizes are relative to the size of the screen, so 0.25 is a quarter of the screen. Sizes are not relative to the parent; this is common in windowing systems where the top and left are relative but the size is absolute.<BR><BR>
178</P><P>
179
180Default: height 1<BR>
181</P><P>
182
183<A NAME="overlay_material"></A>
184<A NAME="SEC214"></A>
185<H3> material   </H3>
186<!--docid::SEC214::-->
187<P>
188
189Sets the name of the material to use for this element.<BR><BR>
190</P><P>
191
192Format: material &#60;name&#62;<BR>
193Example: material Examples/TestMaterial<BR><BR>
194</P><P>
195
196This sets the base material which this element will use. Each type of element may interpret this differently; for example the OGRE element 'Panel' treats this as the background of the panel, whilst 'BorderPanel' interprets this as the material for the center area only. Materials should be defined in .material scripts.<BR><BR>
197Note that using a material in an overlay element automatically disables lighting and depth checking on this material. Therefore you should not use the same material as is used for real 3D objects for an overlay.<BR><BR>
198</P><P>
199
200Default: none<BR>
201</P><P>
202
203<A NAME="caption"></A>
204<A NAME="SEC215"></A>
205<H3> caption </H3>
206<!--docid::SEC215::-->
207<P>
208
209Sets a text caption for the element.<BR><BR>
210</P><P>
211
212Format: caption &#60;string&#62;<BR>
213Example: caption This is a caption<BR><BR>
214</P><P>
215
216Not all elements support captions, so each element is free to disregard this if it wants. However, a general text caption is so common to many elements that it is included in the generic interface to make it simpler to use. This is a common feature in GUI systems.<BR><BR>
217</P><P>
218
219Default: blank<BR>
220</P><P>
221
222<A NAME="rotation"></A>
223<A NAME="SEC216"></A>
224<H3> rotation </H3>
225<!--docid::SEC216::-->
226<P>
227
228Sets the rotation of the element.<BR><BR>
229</P><P>
230
231Format: rotation &#60;angle_in_degrees&#62; &#60;axis_x&#62; &#60;axis_y&#62; &#60;axis_z&#62;
232Example: rotation 30 0 0 1
233</P><P>
234
235Default: none
236</P><P>
237
238<A NAME="Standard OverlayElements"></A>
239<HR SIZE=1>
240<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
241<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_33.html#SEC200"> &lt; </A>]</TD>
242<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_33.html#SEC200"> Up </A>]</TD>
243<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_35.html#SEC217"> &gt; </A>]</TD>
244<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
245<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
246<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
247<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
248</TR></TABLE>
249<BR> 
250<FONT SIZE="-1">
251This document was generated
252by <I>Steve Streeting</I> on <I>, 12 2006</I>
253using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
254"><I>texi2html</I></A>
255
256</BODY>
257</HTML>
Note: See TracBrowser for help on using the repository browser.