PageRenderTime 58ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 1ms

/Dlls/Delta.Scenes.xml

#
XML | 1026 lines | 1025 code | 1 blank | 0 comment | 0 complexity | 871267ff2b89db21a5fa78325c9fd5f7 MD5 | raw file
Possible License(s): Apache-2.0
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.Scenes</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.Scenes.BaseControl">
  8. <summary>
  9. This is the base class for all UI elements of the Delta Engine and takes
  10. care about the basic functionality like state handling, events and input
  11. handling.
  12. </summary>
  13. </member>
  14. <member name="T:Delta.Scenes.AlignableElement">
  15. <summary>
  16. This is a hierarchal and more "logical" class which contains the logic
  17. to allow visual elements to arrange and align with each other. For that
  18. reason this is the base class for all UI controls.
  19. TODO: Decide which things are needed and which can be deleted
  20. </summary>
  21. </member>
  22. <member name="F:Delta.Scenes.AlignableElement.DrawArea">
  23. <summary>
  24. The final draw area (in absolute Quadratic Space coordinates) which
  25. will get automatically computed and updated by the 'Update()' method.
  26. </summary>
  27. <remarks>
  28. The correct value will be accessible after the first (update) tick.
  29. </remarks>
  30. </member>
  31. <member name="F:Delta.Scenes.AlignableElement.drawPos">
  32. <summary>
  33. The draw position which will get automatically computed and updated
  34. by the 'Update()' method.
  35. </summary>
  36. </member>
  37. <member name="F:Delta.Scenes.AlignableElement.isRecomputePositionRequired">
  38. <summary>
  39. The internal "flag" which tells if this element requires a
  40. re-computation of its (local and draw) position based on the current
  41. set alignment mode.
  42. </summary>
  43. </member>
  44. <member name="F:Delta.Scenes.AlignableElement.isRuntimeValueChange">
  45. <summary>
  46. This value is just used to indicate by 'false' if a change is done
  47. the first time (initialization / creation) or by 'true' if a change
  48. was done while the application is running e.g. by an user interaction.
  49. </summary>
  50. </member>
  51. <member name="F:Delta.Scenes.AlignableElement.IsSavingAllowed">
  52. <summary>
  53. Indicates if saving of this element is allowed. Useful for typical
  54. helper elements which don't need to be saved because they will created
  55. dynamically by its parents.
  56. </summary>
  57. <remarks>
  58. The default value is 'true'.
  59. </remarks>
  60. </member>
  61. <member name="F:Delta.Scenes.AlignableElement.DebugShowColor">
  62. <summary>
  63. The color which is used to visualize this element if "visual debugging"
  64. is enabled.
  65. </summary>
  66. </member>
  67. <member name="M:Delta.Scenes.AlignableElement.#ctor">
  68. <summary>
  69. Creates a dockable element.
  70. </summary>
  71. </member>
  72. <member name="M:Delta.Scenes.AlignableElement.Add(Delta.Scenes.AlignableElement)">
  73. <summary>
  74. Adds an element as new child.
  75. </summary>
  76. <param name="newChild">New child</param>
  77. <returns>
  78. 'True' if the given element was added as child, otherwise just 'false'.
  79. </returns>
  80. </member>
  81. <member name="M:Delta.Scenes.AlignableElement.Remove(Delta.Scenes.AlignableElement)">
  82. <summary>
  83. Removes a child element again.
  84. </summary>
  85. <param name="existingChild">Existing child</param>
  86. <returns>
  87. 'True' if the given element was a child and could be removed,
  88. otherwise just 'false'.
  89. </returns>
  90. </member>
  91. <member name="M:Delta.Scenes.AlignableElement.Update">
  92. <summary>
  93. Updates the element inclusive its children elements.
  94. </summary>
  95. </member>
  96. <member name="M:Delta.Scenes.AlignableElement.Draw">
  97. <summary>
  98. Draws the element and its children elements.
  99. </summary>
  100. </member>
  101. <member name="M:Delta.Scenes.AlignableElement.Save(System.IO.BinaryWriter)">
  102. <summary>
  103. Saves all necessary data of the object into a binary stream.
  104. </summary>
  105. <param name="dataWriter">
  106. The container object which will store all the saved data.
  107. </param>
  108. </member>
  109. <member name="M:Delta.Scenes.AlignableElement.Load(System.IO.BinaryReader)">
  110. <summary>
  111. Loads all data of the object again which were previously saved.
  112. </summary>
  113. <param name="dataReader">
  114. The container object which contains the data which were saved before.
  115. </param>
  116. </member>
  117. <member name="M:Delta.Scenes.AlignableElement.Dispose">
  118. <summary>
  119. Disposes the whole element data (inclusive children).
  120. </summary>
  121. </member>
  122. <member name="M:Delta.Scenes.AlignableElement.ToString">
  123. <summary>
  124. To string
  125. </summary>
  126. <returns>string</returns>
  127. </member>
  128. <member name="M:Delta.Scenes.AlignableElement.OnParentChanging(Delta.Scenes.AlignableElement)">
  129. <summary>
  130. On parent changing
  131. </summary>
  132. <param name="oldParent">Old parent</param>
  133. </member>
  134. <member name="M:Delta.Scenes.AlignableElement.OnSizeChanging(Delta.Utilities.Datatypes.Size)">
  135. <summary>
  136. On size changing
  137. </summary>
  138. <param name="oldSize">Old size</param>
  139. <returns>
  140. 'True' if the new value can be used or 'false' if the change should be
  141. aborted.
  142. </returns>
  143. </member>
  144. <member name="M:Delta.Scenes.AlignableElement.OnParentSizeChanged(Delta.Scenes.AlignableElement)">
  145. <summary>
  146. On parent size changed
  147. </summary>
  148. <param name="sender">Sender</param>
  149. <param name="newSize">New size</param>
  150. </member>
  151. <member name="M:Delta.Scenes.AlignableElement.UpdateDrawData">
  152. <summary>
  153. Updates all data of this element which are required for the following
  154. draw call.
  155. </summary>
  156. <remarks>
  157. This method will only be called if the element is in an enabled state.
  158. </remarks>
  159. </member>
  160. <member name="M:Delta.Scenes.AlignableElement.DetectChanges">
  161. <summary>
  162. This method implements the checks of the changes which are should be
  163. detected in this element. It also cares about triggering the events and
  164. the event handler methods.
  165. </summary>
  166. </member>
  167. <member name="M:Delta.Scenes.AlignableElement.DrawData">
  168. <summary>
  169. Draws all data of this element which needs to be visualized.
  170. </summary>
  171. <remarks>
  172. This method will only be called if the element is in a visible state.
  173. </remarks>
  174. </member>
  175. <member name="M:Delta.Scenes.AlignableElement.DrawDebugInfo">
  176. <summary>
  177. Draw debug info
  178. </summary>
  179. </member>
  180. <member name="M:Delta.Scenes.AlignableElement.ShortElementInfo">
  181. <summary>
  182. Short info of the this element (instance).
  183. Note: Helper function for the "ToString()" override.
  184. </summary>
  185. <returns>The short info of this element as string.</returns>
  186. </member>
  187. <member name="P:Delta.Scenes.AlignableElement.LocalArea">
  188. <summary>
  189. The local displaying area of this element based on the parent element.
  190. </summary>
  191. </member>
  192. <member name="P:Delta.Scenes.AlignableElement.LocalPosition">
  193. <summary>
  194. The top-left position of this element in the "parent space".
  195. </summary>
  196. </member>
  197. <member name="P:Delta.Scenes.AlignableElement.Size">
  198. <summary>
  199. The size of this element.
  200. </summary>
  201. </member>
  202. <member name="P:Delta.Scenes.AlignableElement.State">
  203. <summary>
  204. Represents the current state of this element.
  205. </summary>
  206. </member>
  207. <member name="P:Delta.Scenes.AlignableElement.HorizontalAlignment">
  208. <summary>
  209. The current set horizontal alignment, if the mode is set to
  210. 'HorizontalAlignment.None' the alignment functionality is disabled.
  211. </summary>
  212. </member>
  213. <member name="P:Delta.Scenes.AlignableElement.VerticalAlignment">
  214. <summary>
  215. The current set vertical alignment, if the mode is set to
  216. 'VerticalAlignment.None' the alignment functionality is disabled.
  217. </summary>
  218. </member>
  219. <member name="P:Delta.Scenes.AlignableElement.Margin">
  220. <summary>
  221. Margin
  222. </summary>
  223. <returns>Spacing</returns>
  224. </member>
  225. <member name="P:Delta.Scenes.AlignableElement.Parent">
  226. <summary>
  227. The parent element where this element is a child from.
  228. </summary>
  229. </member>
  230. <member name="P:Delta.Scenes.AlignableElement.Screen">
  231. <summary>
  232. Represents the owner screen where this element belongs to.
  233. </summary>
  234. <value>
  235. The scene.
  236. </value>
  237. </member>
  238. <member name="P:Delta.Scenes.AlignableElement.LastState">
  239. <summary>
  240. The last state which was set before the current state. Useful if the
  241. last state wants to be restored for some reason.
  242. </summary>
  243. </member>
  244. <member name="E:Delta.Scenes.AlignableElement.SizeChanged">
  245. <summary>
  246. Occurs every time when the size of the element changes.
  247. </summary>
  248. </member>
  249. <member name="T:Delta.Scenes.AlignableElement.ControlSizeEvent">
  250. <summary>
  251. The delegate declaration for the "Control.SizeChanged" event.
  252. </summary>
  253. <param name="sender">
  254. The element instance which has raised this event.
  255. </param>
  256. </member>
  257. <member name="F:Delta.Scenes.BaseControl.DefaultPosition">
  258. <summary>
  259. The default location for all UI controls which is in the middle of the
  260. screen. So we can use the .NET 3.5 like constructors and give the
  261. artists the chance to move the control to the correct position.
  262. </summary>
  263. </member>
  264. <member name="F:Delta.Scenes.BaseControl.DefaultSize">
  265. <summary>
  266. The default size of a control when no (valid) size is explicitely set.
  267. </summary>
  268. </member>
  269. <member name="F:Delta.Scenes.BaseControl.DefaultMinSize">
  270. <summary>
  271. Returns the default minimum possible size of the control.
  272. </summary>
  273. </member>
  274. <member name="F:Delta.Scenes.BaseControl.IsVisible">
  275. <summary>
  276. Returns if the control is currently visible. If this is false, no
  277. update or drawing will be done (like if the control was not there)!
  278. </summary>
  279. </member>
  280. <member name="M:Delta.Scenes.BaseControl.Clone">
  281. <summary>
  282. Clone
  283. </summary>
  284. <returns>The cloned instance of this instance.</returns>
  285. </member>
  286. <member name="M:Delta.Scenes.BaseControl.GetControl(Delta.Utilities.Datatypes.Point)">
  287. <summary>
  288. Gets the topmost control by the (absolute) QuadraticSpace
  289. position or "null" if the position isn't on one of the Children.
  290. </summary>
  291. <param name="absCursorPos">Absolute cursor position</param>
  292. <returns>
  293. The found control located by the given position or just 'null' if no
  294. control could be found at the specified position.
  295. </returns>
  296. </member>
  297. <member name="M:Delta.Scenes.BaseControl.GetControl(System.String)">
  298. <summary>
  299. Tries to get the control looking by its name or returns 'null' if it
  300. couldn't be found.
  301. </summary>
  302. <param name="controlName">Control name</param>
  303. <returns>
  304. The found control identified by the name or just 'null' if a control
  305. with the given name couldn't be found.
  306. </returns>
  307. </member>
  308. <member name="M:Delta.Scenes.BaseControl.Save(System.IO.BinaryWriter)">
  309. <summary>
  310. Saves all necessary data of the object into a binary stream.
  311. </summary>
  312. <param name="dataWriter">
  313. The container object which will store all the saved data.
  314. </param>
  315. </member>
  316. <member name="M:Delta.Scenes.BaseControl.Load(System.IO.BinaryReader)">
  317. <summary>
  318. Loads all data of the object again which were previously saved.
  319. </summary>
  320. <param name="dataReader">
  321. The container object which contains the data which were saved before.
  322. </param>
  323. </member>
  324. <member name="M:Delta.Scenes.BaseControl.ToString">
  325. <summary>
  326. To string
  327. </summary>
  328. <returns>
  329. A <see cref="T:System.String" /> that represents this instance.
  330. </returns>
  331. </member>
  332. <member name="M:Delta.Scenes.BaseControl.OnInputEvent(Delta.InputSystem.CommandTrigger)">
  333. <summary>
  334. On input event
  335. </summary>
  336. <param name="input">Input data</param>
  337. </member>
  338. <member name="M:Delta.Scenes.BaseControl.OnDesignChanging(Delta.Scenes.ControlDesign)">
  339. <summary>
  340. Occurs every time when the design of the control changes.
  341. </summary>
  342. <remarks>
  343. This method will only be called if the design will be changed
  344. explicitely by the user.
  345. </remarks>
  346. <param name="oldDesign">Old design</param>
  347. <returns>
  348. 'True' if the new value can be used or 'false' if the change should be
  349. aborted.
  350. </returns>
  351. </member>
  352. <member name="M:Delta.Scenes.BaseControl.OnDragging(Delta.Scenes.Enums.DragState,Delta.InputSystem.CommandTrigger)">
  353. <summary>
  354. Occurs if the left pointing device button is pressed down and the
  355. cursor will moved.
  356. </summary>
  357. <param name="dragType">Drag type</param>
  358. <param name="input">Input data</param>
  359. </member>
  360. <member name="M:Delta.Scenes.BaseControl.DetectChanges">
  361. <summary>
  362. This method implements the checks of the changes which are should be
  363. detected in this element. It also cares about triggering the events and
  364. the event handler methods.
  365. </summary>
  366. </member>
  367. <member name="M:Delta.Scenes.BaseControl.IsInControl(Delta.Utilities.Datatypes.Point)">
  368. <summary>
  369. Is in control
  370. </summary>
  371. <param name="absoluteQuadspacePosition">Absolute quadspace position</param>
  372. <returns>'True' if the given position is inside this control.</returns>
  373. </member>
  374. <member name="M:Delta.Scenes.BaseControl.DrawData">
  375. <summary>
  376. Draws all data of this control which needs to be visualized.
  377. </summary>
  378. <remarks>
  379. This method will only be called if the control is in a visible state.
  380. </remarks>
  381. </member>
  382. <member name="M:Delta.Scenes.BaseControl.ShortElementInfo">
  383. <summary>
  384. Short info of the this control (instance).
  385. Note: Helper function for the "ToString()" override.
  386. </summary>
  387. <returns>The short info of this element as string.</returns>
  388. </member>
  389. <member name="P:Delta.Scenes.BaseControl.CustomDesign">
  390. <summary>
  391. Represents the custom design which is used for this control. By default
  392. this value is 'null' and uses the related design of the current set
  393. UserTheme.
  394. </summary>
  395. </member>
  396. <member name="P:Delta.Scenes.BaseControl.IsCustomDesignUsed">
  397. <summary>
  398. Indicates if a custom or the default design is used for this control.
  399. </summary>
  400. </member>
  401. <member name="P:Delta.Scenes.BaseControl.FallbackDesign">
  402. <summary>
  403. Defines the theme which will be used if no "Design" was set
  404. explicitely.
  405. Note: This property needs to be implemented in every subclass.
  406. </summary>
  407. <returns>Control design</returns>
  408. </member>
  409. <member name="P:Delta.Scenes.BaseControl.Design">
  410. <summary>
  411. The final design which is used for drawing this control. By default it
  412. uses the related control design of the current "UITheme" but it can
  413. be "overridden" by setting an own design with the 'CustomDesign'
  414. property explicitely.
  415. </summary>
  416. <remarks>
  417. The property is 'internal' because of the fact that the UI-Editor needs
  418. access to the final design which is used for drawing.
  419. </remarks>
  420. </member>
  421. <member name="E:Delta.Scenes.BaseControl.Dragging">
  422. <summary>
  423. Occurs if the left pointing device button is pressed down and the
  424. cursor will moved.
  425. </summary>
  426. </member>
  427. <member name="T:Delta.Scenes.BaseControl.ControlDragEvent">
  428. <summary>
  429. Delegate for the "Dragging" event of an UI control.
  430. </summary>
  431. <param name="sender">The control which is currently dragging.</param>
  432. <param name="dragType">The kind of drag event</param>
  433. <param name="input">
  434. The position where the event happens on the screen. Note: For the
  435. "DragMove" event the value will be relative to the last event.
  436. </param>
  437. </member>
  438. <member name="T:Delta.Scenes.Enums.AnchorType">
  439. <summary>
  440. That type defines at which point of the parent control the own control
  441. will attached outside.
  442. </summary>
  443. </member>
  444. <member name="T:Delta.Scenes.Enums.ScreenState">
  445. <summary>
  446. Specifies the state that a <see cref="T:Delta.Scenes.BaseScreen" /> of a
  447. <see cref="T:Delta.Scenes.Scene" /> can have and will change every time it will be opened
  448. or closed.
  449. </summary>
  450. </member>
  451. <member name="T:Delta.Scenes.ControlDesign">
  452. <summary>
  453. This class is the base design class for all visual elements of an user
  454. interface <see cref="!:UIElement" /> and defines the basic look of each
  455. element. Of course more complex designs for UI elements are possible, you
  456. just have to create an own "design class" where you can define the a more
  457. advanced look (mostly needed for new UI element classes). The only thing
  458. that you have to keep in mind that every other UI design class is derived
  459. from this class, directly or indirectly.
  460. </summary>
  461. </member>
  462. <member name="M:Delta.Scenes.ControlDesign.DrawStyle(Delta.Scenes.BaseControl,Delta.Rendering.Basics.Materials.Material2DColored,Delta.Utilities.Datatypes.Rectangle)">
  463. <summary>
  464. Draws the style at the given area
  465. Note: Just a private helper function for drawing the control.
  466. </summary>
  467. <param name="control">Control</param>
  468. <param name="currentStyle">Current control style</param>
  469. <param name="drawArea">Draw area</param>
  470. </member>
  471. <member name="M:Delta.Scenes.ControlDesign.DrawControl(Delta.Scenes.BaseControl,Delta.Utilities.Datatypes.Rectangle)">
  472. <summary>
  473. Draw control
  474. Note: That method will only be called if the control state is
  475. at least visible.
  476. </summary>
  477. <param name="control">Control to draw in this design.</param>
  478. <param name="drawArea">The draw area.</param>
  479. </member>
  480. <member name="M:Delta.Scenes.ControlDesign.ToString">
  481. <summary>
  482. To string
  483. </summary>
  484. <returns>
  485. A <see cref="T:System.String" /> that represents this instance.
  486. </returns>
  487. </member>
  488. <member name="M:Delta.Scenes.ControlDesign.Save(System.IO.BinaryWriter)">
  489. <summary>
  490. Saves all necessary data of the object to a binary stream.
  491. </summary>
  492. <param name="dataWriter">The data writer.</param>
  493. </member>
  494. <member name="M:Delta.Scenes.ControlDesign.Load(System.IO.BinaryReader)">
  495. <summary>
  496. Loads all data of the object again which were previously saved.
  497. </summary>
  498. <param name="dataReader">The data of the object which were saved
  499. before.</param>
  500. </member>
  501. <member name="M:Delta.Scenes.ControlDesign.Dispose">
  502. <summary>
  503. Dispose the control design. Does nothing here.
  504. </summary>
  505. </member>
  506. <member name="M:Delta.Scenes.ControlDesign.SaveMaterial(System.IO.BinaryWriter,Delta.Rendering.Basics.Materials.Material2DColored)">
  507. <summary>
  508. Save material
  509. TODO: Use the "ISaveLoadBinary" implementation of the material class
  510. </summary>
  511. <param name="dataWriter">Data writer</param>
  512. <param name="material">Material</param>
  513. </member>
  514. <member name="M:Delta.Scenes.ControlDesign.LoadMaterial(System.IO.BinaryReader)">
  515. <summary>
  516. Load material
  517. </summary>
  518. <param name="dataReader">Data reader</param>
  519. <returns>The loaded material from the given data reader.</returns>
  520. </member>
  521. <member name="M:Delta.Scenes.ControlDesign.GetControlStyle(Delta.Scenes.BaseControl)">
  522. <summary>
  523. Returns the set style of the controls based on its current state.
  524. </summary>
  525. <param name="control">Control</param>
  526. <returns>the set style</returns>
  527. </member>
  528. <member name="P:Delta.Scenes.ControlDesign.DefaultMaterial">
  529. <summary>
  530. The default material which is used if no material is available for a
  531. UI design.
  532. Note:
  533. That is currently only used for "DrawDesign".
  534. </summary>
  535. <returns>Material 2D colored</returns>
  536. </member>
  537. <member name="P:Delta.Scenes.ControlDesign.Background">
  538. <summary>
  539. Defines the background of the control (or in the Image control the
  540. whole design). Basically it uses the "Theme" design ('DefaultDesign'
  541. is set) but it can be overridden by setting a value "explicitely".
  542. If no design is wished resp. should be ignored, then just the
  543. assignment of "null" is needed.
  544. </summary>
  545. <value>
  546. The background.
  547. </value>
  548. <returns>Material 2D colored</returns>
  549. </member>
  550. <member name="P:Delta.Scenes.ControlDesign.DisabledBackground">
  551. <summary>
  552. Defines the background of the control (or in the Image control the
  553. whole design) for the disabled state. If no design is wished resp.
  554. should be ignored, then just the assignment of "null" is needed.
  555. </summary>
  556. <value>
  557. The disabled background.
  558. </value>
  559. <returns>Material2DColored</returns>
  560. </member>
  561. <member name="P:Delta.Scenes.ControlDesign.Hover">
  562. <summary>
  563. The graphical design (material) which is used, if the control is
  564. currently in the "Hover mode". If "null" is assigned, then the whole
  565. "Hovering" logic will be ignored.
  566. </summary>
  567. <value>
  568. The hover.
  569. </value>
  570. <returns>Material 2D colored</returns>
  571. </member>
  572. <member name="P:Delta.Scenes.ControlDesign.Size">
  573. <summary>
  574. The size of the design.
  575. </summary>
  576. </member>
  577. <member name="T:Delta.Scenes.Enums.Alignment">
  578. <summary>
  579. Represents all possible alignment types which can be used for any visual
  580. UI element.
  581. </summary>
  582. </member>
  583. <member name="T:Delta.Scenes.Scene">
  584. <summary>
  585. Scene class which is basically a container for everything we want to have
  586. in our actual game scene. Like models, UI screens and more. You can
  587. create them programmatically or load them from the content system, in
  588. both cases the SceneData.Current and the Scene.Current objects need to
  589. point to the same scene data and scene respectively.
  590. <para />
  591. Each scene is dynamic module and Run() is called automatically (right
  592. before) the MaterialManager is called) but only the currently active
  593. scene is updated (see Run()).
  594. </summary>
  595. </member>
  596. <member name="M:Delta.Scenes.Scene.Open(System.String)">
  597. <summary>
  598. Create scene and starts it, please note that the current scene will be
  599. closed and dispose before the new one is loaded. It loads the internal
  600. scene data. Since that is a dynamic module Run() will update the
  601. screen, camera, video, etc.
  602. </summary>
  603. <param name="sceneContentName">Scene content name</param>
  604. <returns>The loaded scene instance.</returns>
  605. </member>
  606. <member name="M:Delta.Scenes.Scene.Open(Delta.Scenes.BaseScreen)">
  607. <summary>
  608. Creates the scene dynamically without content. Please note that all
  609. content is not automatically disposed like for content scenes.
  610. </summary>
  611. <remarks>
  612. The screen will use the default theme if none was set yet at all.
  613. </remarks>
  614. <param name="setUIScreen">Set UI Screen</param>
  615. <param name="setUITheme">Set UI Theme</param>
  616. <returns>The loaded scene instance.</returns>
  617. </member>
  618. <member name="M:Delta.Scenes.Scene.Open(Delta.Scenes.BaseScreen,Delta.Scenes.BaseTheme)">
  619. <summary>
  620. Creates the scene dynamically without content. Please note that all
  621. content is not automatically disposed like for content scenes.
  622. </summary>
  623. <param name="setUIScreen">Set Ui Screen</param>
  624. <param name="setUITheme">Set UI Theme</param>
  625. <returns>The loaded scene instance.</returns>
  626. </member>
  627. <member name="M:Delta.Scenes.Scene.DrawFps">
  628. <summary>
  629. Draw fps information.
  630. </summary>
  631. </member>
  632. <member name="M:Delta.Scenes.Scene.#ctor(System.String)">
  633. <summary>
  634. Create scene, just loads the internal scene data. Since that is a
  635. dynamic module all the magic happens in Run().
  636. </summary>
  637. <param name="setSceneName">Scene content name</param>
  638. </member>
  639. <member name="M:Delta.Scenes.Scene.GetScreen(System.String)">
  640. <summary>
  641. Return the found screen (specified by the name) or 'null' if it can't
  642. be found.
  643. </summary>
  644. <param name="screenName">The (content) name of the screen.</param>
  645. </member>
  646. <member name="M:Delta.Scenes.Scene.Add(Delta.Scenes.BaseScreen)">
  647. <summary>
  648. Adds a new screen including playing the blending in animation.
  649. </summary>
  650. <param name="screen">Screen</param>
  651. <param name="newScreen">New Screen</param>
  652. </member>
  653. <member name="M:Delta.Scenes.Scene.Remove(Delta.Scenes.BaseScreen)">
  654. <summary>
  655. Removes an existing screen incl. playing the blending out animation.
  656. </summary>
  657. <param name="existingScreen">Existing screen</param>
  658. </member>
  659. <member name="M:Delta.Scenes.Scene.RemoveUpTo(Delta.Scenes.BaseScreen)">
  660. <summary>
  661. Closes all screens up to the specified screen which are above on it.
  662. <para />
  663. Note: This specified screen won't be closed.
  664. </summary>
  665. <param name="newTopmostScreen">TheExisting screen</param>
  666. </member>
  667. <member name="M:Delta.Scenes.Scene.Run">
  668. <summary>
  669. Run the scene with all screens in it. Each active screen (usually we
  670. have a solid one in the background and optionally overlay screens on
  671. top of it) is Run as long is it active (Screen.Run will call Update
  672. and then Draw for each screen automatically).
  673. </summary>
  674. </member>
  675. <member name="M:Delta.Scenes.Scene.Load(Delta.ContentSystem.UserInterfaces.SceneData)">
  676. <summary>
  677. Load
  678. </summary>
  679. <param name="setData">Set data</param>
  680. </member>
  681. <member name="M:Delta.Scenes.Scene.Save(System.IO.BinaryWriter)">
  682. <summary>
  683. Saves all necessary data of the object into a binary stream.
  684. </summary>
  685. <param name="dataWriter">
  686. The container object which will store all the saved data.
  687. </param>
  688. </member>
  689. <member name="M:Delta.Scenes.Scene.Dispose">
  690. <summary>
  691. Disposes this scene again.
  692. </summary>
  693. </member>
  694. <member name="M:Delta.Scenes.Scene.ToString">
  695. <summary>
  696. To string
  697. </summary>
  698. <returns>
  699. A <see cref="T:System.String" /> that represents this instance.
  700. </returns>
  701. </member>
  702. <member name="P:Delta.Scenes.Scene.Current">
  703. <summary>
  704. By default the empty project scene is set (it is also set when no
  705. other scene is set anymore and Dispose was called from the last one).
  706. The empty project scene is real content and can even be modified with
  707. the Scene Editor.
  708. </summary>
  709. <remarks>
  710. Each scene can have children and a parent.
  711. </remarks>
  712. </member>
  713. <member name="P:Delta.Scenes.Scene.LoadingBackgroundImage">
  714. <summary>
  715. Loading background image
  716. </summary>
  717. </member>
  718. <member name="P:Delta.Scenes.Scene.UITheme">
  719. <summary>
  720. The theme which contains all imported values for the correct rendering
  721. of Ui elements on the screen.
  722. </summary>
  723. </member>
  724. <member name="P:Delta.Scenes.Scene.Camera">
  725. <summary>
  726. Active camera, loaded from content if there is one set for this scene.
  727. </summary>
  728. </member>
  729. <member name="P:Delta.Scenes.Scene.Music">
  730. <summary>
  731. Music, loaded and managed by this scene if there is music set.
  732. </summary>
  733. </member>
  734. <member name="P:Delta.Scenes.Scene.Video">
  735. <summary>
  736. Video, loaded and managed by this scene if there is a video set.
  737. </summary>
  738. </member>
  739. <member name="P:Delta.Scenes.Scene.ScreenArea">
  740. <summary>
  741. Screen area
  742. The full area of the screen (based on the current resolution) which is
  743. required to display the curren set UI theme aspect ratio true on a
  744. screen.
  745. <para />
  746. Note: This area is always centered inside the max. available screen
  747. area, in the case that the current resolution doesn't fit the aspect
  748. ratio that is used for the UI theme.
  749. </summary>
  750. </member>
  751. <member name="T:Delta.Scenes.Enums.DragState">
  752. <summary>
  753. Specifies the possible state values of the 'Dragging' events that are
  754. used in the UI controls.
  755. </summary>
  756. </member>
  757. <member name="T:Delta.Scenes.BaseTheme">
  758. <summary>
  759. That class defines the base to allow a general theming of different UI
  760. elements.
  761. </summary>
  762. </member>
  763. <member name="F:Delta.Scenes.BaseTheme.DefaultBlendColor">
  764. <summary>
  765. Represents the default blend color for a (default) enabled design of
  766. the UI controls.
  767. </summary>
  768. </member>
  769. <member name="F:Delta.Scenes.BaseTheme.DefaultDisabledBlendColor">
  770. <summary>
  771. Represents the default blend color for a (default) disabled design of
  772. the UI controls.
  773. </summary>
  774. </member>
  775. <member name="F:Delta.Scenes.BaseTheme.DefaultHoverColor">
  776. <summary>
  777. Represents the default blend color for a (default) hover design of
  778. the UI controls.
  779. </summary>
  780. </member>
  781. <member name="F:Delta.Scenes.BaseTheme.DefaultTextColor">
  782. <summary>
  783. The default color for drawing a text by a font.
  784. </summary>
  785. </member>
  786. <member name="M:Delta.Scenes.BaseTheme.GetUIMaterial(Delta.Utilities.Datatypes.Color)">
  787. <summary>
  788. Get user interface material, just creates a new 2D colored material and
  789. sets the DrawLayer to UI.
  790. </summary>
  791. <param name="setColor">Set color</param>
  792. <returns>The created material based on the given color.</returns>
  793. </member>
  794. <member name="M:Delta.Scenes.BaseTheme.GetUIMaterial(System.String)">
  795. <summary>
  796. Get user interface material, just creates a new 2D colored material and
  797. sets the DrawLayer to UI.
  798. </summary>
  799. <param name="setImageName">Set image name</param>
  800. <returns>The created material based on the given image name.</returns>
  801. </member>
  802. <member name="M:Delta.Scenes.BaseTheme.GetUIMaterial(System.String,Delta.Utilities.Datatypes.Color)">
  803. <summary>
  804. Get user interface material, just creates a new 2D colored material and
  805. sets the DrawLayer to UI.
  806. </summary>
  807. <param name="setImageName">Name of the set image.</param>
  808. <param name="setBlendColor">Color of the set blend.</param>
  809. <returns>
  810. The created material based on the given image name and color.
  811. </returns>
  812. </member>
  813. <member name="M:Delta.Scenes.BaseTheme.#ctor(System.String)">
  814. <summary>
  815. Create user interface style
  816. </summary>
  817. <param name="setThemeName">Name of the set theme.</param>
  818. </member>
  819. <member name="M:Delta.Scenes.BaseTheme.ComputeScreenArea">
  820. <summary>
  821. Computes the required draw area to display the Theme aspect ratio true
  822. on a screen based on the current resolution.
  823. <para />
  824. Note: This area is centered in the max. available screen area based on
  825. the settings.
  826. </summary>
  827. </member>
  828. <member name="M:Delta.Scenes.BaseTheme.LoadDefaultDesign">
  829. <summary>
  830. Load default design
  831. </summary>
  832. </member>
  833. <member name="P:Delta.Scenes.BaseTheme.Default">
  834. <summary>
  835. Default theme when nothing else is assigned.
  836. </summary>
  837. </member>
  838. <member name="P:Delta.Scenes.BaseTheme.Current">
  839. <summary>
  840. Current theme, will return the Default theme if nothing is set.
  841. </summary>
  842. </member>
  843. <member name="P:Delta.Scenes.BaseTheme.DesignedResolution">
  844. <summary>
  845. Represents the resolution where that style was designed for.
  846. </summary>
  847. <value>
  848. The designed resolution.
  849. </value>
  850. </member>
  851. <member name="T:Delta.Scenes.BaseScreen">
  852. <summary>
  853. Base user interface scene
  854. </summary>
  855. </member>
  856. <member name="M:Delta.Scenes.BaseScreen.#ctor(System.String)">
  857. <summary>
  858. Creates an user interface scene from the content file with all stored
  859. controls.
  860. </summary>
  861. <param name="screenContentName">
  862. Name of the content data for this screen.
  863. </param>
  864. </member>
  865. <member name="M:Delta.Scenes.BaseScreen.Open">
  866. <summary>
  867. Sets this screen as current active one. If loaded by content this is
  868. done automatically in the constructor. When creating a screen
  869. dynamically in code you need to add all UI elements yourself and then
  870. call Open yourself to present the screen to the user. All rendering
  871. and updating is handled automatically by the Scene module!
  872. </summary>
  873. </member>
  874. <member name="M:Delta.Scenes.BaseScreen.Add(Delta.Scenes.BaseControl)">
  875. <summary>
  876. Adds a control to the scene.
  877. </summary>
  878. <param name="newControl">New control</param>
  879. </member>
  880. <member name="M:Delta.Scenes.BaseScreen.Remove(Delta.Scenes.BaseControl)">
  881. <summary>
  882. Removes a control to the scene again.
  883. </summary>
  884. <param name="controlToRemove">Control to remove</param>
  885. </member>
  886. <member name="M:Delta.Scenes.BaseScreen.IsDirectParentOf(Delta.Scenes.BaseControl)">
  887. <summary>
  888. Returns 'true' if the scene is direct parent of the given control.
  889. </summary>
  890. <param name="control">Control</param>
  891. <returns>bool</returns>
  892. </member>
  893. <member name="M:Delta.Scenes.BaseScreen.Save(System.IO.BinaryWriter)">
  894. <summary>
  895. Saves all necessary data of the object into a binary stream.
  896. </summary>
  897. <param name="dataWriter">
  898. The container object which will store all the saved data.
  899. </param>
  900. </member>
  901. <member name="M:Delta.Scenes.BaseScreen.Load(System.IO.BinaryReader)">
  902. <summary>
  903. Loads all data of the object again which were previously saved.
  904. </summary>
  905. <param name="dataReader">
  906. The container object which contains the data which were saved before.
  907. </param>
  908. </member>
  909. <member name="M:Delta.Scenes.BaseScreen.Close">
  910. <summary>
  911. Close
  912. </summary>
  913. </member>
  914. <member name="M:Delta.Scenes.BaseScreen.Dispose">
  915. <summary>
  916. Dispose
  917. </summary>
  918. </member>
  919. <member name="M:Delta.Scenes.BaseScreen.OnActivated">
  920. <summary>
  921. Happens on every time the scene has been opened or the this scene was
  922. be deactivated first by opening another (solid) scene above it before
  923. and gets now active after the other scene (above) is closed now again.
  924. </summary>
  925. </member>
  926. <member name="M:Delta.Scenes.BaseScreen.OnDeactivated">
  927. <summary>
  928. Happens every time another (new solid) scene will be opened and "hides"
  929. now this scene. It also occurs before the scene will be closed.
  930. <para />
  931. This the place where delegates should be (temporarily) detached from
  932. "global" events.
  933. </summary>
  934. </member>
  935. <member name="M:Delta.Scenes.BaseScreen.GetControl(Delta.Utilities.Datatypes.Point)">
  936. <summary>
  937. Gets the (topmost) control of the chosen position in the scene.
  938. </summary>
  939. <param name="scenePoint">
  940. The (Quadratic Space) position in the scene.
  941. (This function can be e.g. use to get the topmost control of the mouse
  942. click position in the scene.)
  943. </param>
  944. </member>
  945. <member name="M:Delta.Scenes.BaseScreen.GetControl(System.String)">
  946. <summary>
  947. Get control
  948. </summary>
  949. <param name="controlName">Control name</param>
  950. <returns>
  951. The found control identified by the name or just 'null' if a control
  952. with the given name couldn't be found.
  953. </returns>
  954. </member>
  955. <member name="M:Delta.Scenes.BaseScreen.Update">
  956. <summary>
  957. Updates the UI screen.
  958. </summary>
  959. <remarks>
  960. This method will be only called if this screen is in 'Active' state
  961. </remarks>
  962. </member>
  963. <member name="M:Delta.Scenes.BaseScreen.Draw">
  964. <summary>
  965. Draws the whole screen.
  966. </summary>
  967. </member>
  968. <member name="P:Delta.Scenes.BaseScreen.Scene">
  969. <summary>
  970. The scene where this UI screen belongs to.
  971. </summary>
  972. </member>
  973. <member name="P:Delta.Scenes.BaseScreen.IsOpened">
  974. <summary>
  975. Is opened
  976. </summary>
  977. </member>
  978. <member name="P:Delta.Scenes.BaseScreen.IsActive">
  979. <summary>
  980. Returns 'true' if the currently used screen is visible and active.
  981. </summary>
  982. </member>
  983. <member name="P:Delta.Scenes.BaseScreen.IsOverlayScreen">
  984. <summary>
  985. Gets or sets if this screen is a overlay one. Overlay screens stay
  986. above the active normal screen of the current scene unlike a normal
  987. screen which will hide completely the current active screen.
  988. </summary>
  989. </member>
  990. <member name="P:Delta.Scenes.BaseScreen.FocusedControl">
  991. <summary>
  992. Returns the focused control.
  993. </summary>
  994. </member>
  995. <member name="P:Delta.Scenes.BaseScreen.Background">
  996. <summary>
  997. Content name of the background of the screen. If no design is wished or
  998. needed then just assign an empty name (or even 'null' is possible).
  999. </summary>
  1000. <remarks>
  1001. The default is set to no background (null).
  1002. </remarks>
  1003. </member>
  1004. <member name="E:Delta.Scenes.BaseScreen.Closed">
  1005. <summary>
  1006. Occurs if the scene is closed.
  1007. </summary>
  1008. </member>
  1009. <member name="T:Delta.Scenes.BaseScreen.ScreenManagementControl">
  1010. <summary>
  1011. Represents the "private" element which manages all "real" (user)
  1012. controls which belongs to that screen.
  1013. We only want to use the already implemented functionality of the
  1014. "BaseUIElement", but we self aren't a "real" control, we only manage
  1015. all registered children...
  1016. </summary>
  1017. <returns>Base control</returns>
  1018. </member>
  1019. <member name="T:Delta.Scenes.Enums.ElementState">
  1020. <summary>
  1021. The enum with all possible states that an UI element can have.
  1022. </summary>
  1023. </member>
  1024. </members>
  1025. </doc>