PageRenderTime 83ms CodeModel.GetById 40ms app.highlight 4ms RepoModel.GetById 36ms app.codeStats 0ms

/Dlls/Delta.ContentSystem.UserInterfaces.xml

#
XML | 267 lines | 267 code | 0 blank | 0 comment | 0 complexity | 190d20484b8994cf289f4e19285ec424 MD5 | raw file
  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>Delta.ContentSystem.UserInterfaces</name>
  5    </assembly>
  6    <members>
  7        <member name="T:Delta.ContentSystem.UserInterfaces.BaseUIScreenData">
  8            <summary>
  9            The basic content class which is the base of all UI screen classes. 
 10            </summary>
 11        </member>
 12        <member name="F:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.VersionNumber">
 13            <summary>
 14            The newest version number of the screen data.
 15            </summary>
 16        </member>
 17        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Get(System.String)">
 18            <summary>
 19            Get and load content based on the content name. This method makes sure
 20            we do not load the same content twice (the constructor is protected).
 21            </summary>
 22            <param name="contentName">Content name we want to load, this is
 23            passed onto the Content System, which will do the actual loading with
 24            help of the Load method in this class.</param>
 25            <returns>The loaded Content object, always unique for the same
 26            name, this helps comparing data.</returns>
 27        </member>
 28        <member name="F:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.drawArea">
 29            <summary>
 30            Draw area
 31            </summary>
 32        </member>
 33        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.#ctor(System.String)">
 34            <summary>
 35            Create scene content based on the content system. Loading happens in
 36            the Load method, all content is loaded right away.
 37            </summary>
 38            <param name="setContentName">Name of the scene name to load.</param>
 39        </member>
 40        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Load(System.IO.BinaryReader)">
 41            <summary>
 42            Loads all data of the object again which were previously saved.
 43            </summary>
 44            <param name="dataReader">
 45            The container object which contains the data which were saved before.
 46            </param>
 47        </member>
 48        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Save(System.IO.BinaryWriter)">
 49            <summary>
 50            Saves all necessary data of the object into a binary stream.
 51            </summary>
 52            <param name="dataWriter">
 53            The container object which will store all the saved data.
 54            </param>
 55        </member>
 56        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Load(Delta.ContentSystem.Content)">
 57            <summary>
 58            Native load method, will just load the data.
 59            </summary>
 60            <param name="alreadyLoadedNativeData">
 61            The first instance that has already loaded the required content data
 62            of this content class or just 'null' if there is none loaded yet (or
 63            anymore).
 64            </param>
 65        </member>
 66        <member name="P:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.DrawArea">
 67            <summary>
 68            By default we render to Rectangle.One, which will be converted
 69            to Graphic.Instance.DrawArea, else use this size as a draw area!
 70            Note: Only used for UIScene.BackgroundDesign.Draw
 71            </summary>
 72        </member>
 73        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Dispose">
 74            <summary>
 75            Dispose
 76            </summary>
 77        </member>
 78        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Load(System.IO.BinaryReader)">
 79            <summary>
 80            Load the design data.
 81            </summary>
 82            <param name="reader">Reader</param>
 83        </member>
 84        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Save(System.IO.BinaryWriter)">
 85            <summary>
 86            Save the design data.
 87            </summary>
 88            <param name="writer">Writer</param>
 89        </member>
 90        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIThemeData.Get(System.String)">
 91            <summary>
 92            Get and load content based on the content name. This method makes sure
 93            we do not load the same content twice (the constructor is protected).
 94            </summary>
 95            <param name="contentName">Content name we want to load, this is
 96            passed onto the Content System, which will do the actual loading with
 97            help of the Load method in this class.</param>
 98            <returns>The loaded Content object, always unique for the same
 99            name, this helps comparing data.</returns>
100        </member>
101        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIThemeData.#ctor(System.String)">
102            <summary>
103            The content constructor just searches for the ContentMetaData entry
104            with the ContentManager.Add method and links it up for this object.
105            </summary>
106            <param name="setName">Name for this content object, should not contain
107            any path, project, scene or any special character! If this is empty
108            or starts with an &gt; character, we assume this is code generated
109            content (e.g. "&gt;IntroScene&lt;" or "") and no loading will happen!
110            </param>
111        </member>
112        <member name="T:Delta.ContentSystem.UserInterfaces.SceneData">
113            <summary>
114            Scene data content class, which loads all the required data for a scene.
115            Most importantly we always have only one scene active. All content that
116            is loaded during the time that scene is open will automatically be
117            disposed when closing the scene. This way we can open new scenes and
118            make sure all content from the previous scenes has been unloaded. If
119            you load new scenes while the old one is still open (stack add), you can
120            load additional content, but nothing gets disposed automatically.
121            <para />
122            Note: This class is not publicly available in the namespace
123            Delta.ContentSystem.UserInterfaces because it is sealed and only used
124            in the also sealed and protected Scene class (in Delta.Scenes).
125            </summary>
126        </member>
127        <member name="F:Delta.ContentSystem.UserInterfaces.SceneData.VersionNumber">
128            <summary>
129            The current version of the implementation of this class.
130            </summary>
131        </member>
132        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Get(System.String)">
133            <summary>
134            This is the only method to load SceneData content. If a content object
135            has already been loaded, it will be returned again.
136            </summary>
137            <param name="contentName">Name of the Scene content to load</param>
138            <returns>The loaded SceneData object (or fallback if it failed)
139            </returns>
140        </member>
141        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.#ctor">
142            <summary>
143            Create scene data, used for the Scene Editor to define the data.
144            </summary>
145        </member>
146        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.#ctor(System.String)">
147            <summary>
148            Create scene content based on the content system. Loading happens in
149            the Load method, all content is loaded right away.
150            </summary>
151            <param name="setContentName">Name of the scene name to load.</param>
152        </member>
153        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Load(System.IO.BinaryReader)">
154            <summary>
155            Loads and restores all previously saved values that belongs to this
156            class only from the given data reader.
157            </summary>
158            <param name="dataReader">The reader which contains the stream with the
159            saved data which needs to be loaded now.</param>
160        </member>
161        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Save(System.IO.BinaryWriter)">
162            <summary>
163            Save data
164            </summary>
165            <param name="dataWriter">Writer</param>
166        </member>
167        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Load(Delta.ContentSystem.Content)">
168            <summary>
169            Native load method, will load all the scene data.
170            </summary>
171            <param name="alreadyLoadedNativeData">
172            The first instance that has already loaded the required content data
173            of this content class or just 'null' if there is none loaded yet (or
174            anymore).
175            </param>
176        </member>
177        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.LoadingBackgroundImageName">
178            <summary>
179            Name of the loading background image that will be shown when a scene
180            is loading (optional).
181            </summary>
182        </member>
183        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.Screens">
184            <summary>
185            The list of screen data which represents the screens which are used in
186            the scene if it get loaded.
187            </summary>
188        </member>
189        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.Theme">
190            <summary>
191            Theme to be used for this scene and all UI Screens.
192            </summary>
193        </member>
194        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.MusicName">
195            <summary>
196            Music name
197            </summary>
198        </member>
199        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.VideoName">
200            <summary>
201            Video name
202            </summary>
203        </member>
204        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.CameraName">
205            <summary>
206            Camera name
207            </summary>
208        </member>
209        <member name="T:Delta.ContentSystem.UserInterfaces.BaseControlData">
210            <summary>
211            The data container class which contains the basic data of a control.
212            </summary>
213        </member>
214        <member name="F:Delta.ContentSystem.UserInterfaces.BaseControlData.VersionNumber">
215            <summary>
216            The version number of the class implementation.
217            </summary>
218        </member>
219        <member name="F:Delta.ContentSystem.UserInterfaces.BaseControlData.rotation">
220            <summary>
221            Rotation
222            </summary>
223        </member>
224        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Save(System.IO.BinaryWriter)">
225            <summary>
226            Saves all necessary data of the object into a binary stream.
227            </summary>
228            <param name="dataWriter">
229            The container object which will store all the saved data.
230            </param>
231        </member>
232        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Load(System.IO.BinaryReader)">
233            <summary>
234            Loads all data of the object again which were previously saved.
235            </summary>
236            <param name="dataReader">
237            The container object which contains the data which were saved before.
238            </param>
239        </member>
240        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Dispose">
241            <summary>
242            Dispose
243            </summary>
244        </member>
245        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.Name">
246            <summary>
247            Name of this element.
248            </summary>
249        </member>
250        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.Rotation">
251            <summary>
252            Faster, but we need to update Parent Rotation ourself
253            </summary>
254        </member>
255        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.ToolTipText">
256            <summary>
257            The info text about this element.
258            </summary>
259            <value>The tool tip text.</value>
260        </member>
261        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.DataBag">
262            <summary>
263            The "bag" to store any custom data for this element.
264            </summary>
265        </member>
266    </members>
267</doc>