Component.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633
  1. <Type Name="Component" FullName="Urho.Component">
  2. <TypeSignature Language="C#" Value="public class Component : Urho.Animatable" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Component extends Urho.Animatable" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Animatable</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Base class for components. Components can be attached to scene nodes.
  15. </summary>
  16. <remarks>
  17. <para>Serialization</para>
  18. <para>
  19. </para>
  20. <para>To implement serialization you would override the OnSerialize and OnDeserialize methods and store your component state on the provided serializer and deserializer objects.</para>
  21. <para>
  22. </para>
  23. <code lang="C#"><![CDATA[class MyComponent : Component {
  24. // Constructor needed for deserialization
  25. public MyComponent(IntPtr handle) : base(handle) { }
  26. public MyComponent() { }
  27. // user defined properties (managed state):
  28. public Quaternion MyRotation { get; set; }
  29. public string MyName { get; set; }
  30. public override void OnSerialize(IComponentSerializer ser)
  31. {
  32. // register our properties with their names as keys using nameof()
  33. ser.Serialize(nameof(MyRotation), MyRotation);
  34. ser.Serialize(nameof(MyName), MyName);
  35. }
  36. public override void OnDeserialize(IComponentDeserializer des)
  37. {
  38. MyRotation = des.Deserialize<Quaternion>(nameof(MyRotation));
  39. MyName = des.Deserialize<string>(nameof(MyName));
  40. }
  41. // called when the component is attached to some node
  42. public override void OnAttachedToNode()
  43. {
  44. var node = this.Node;
  45. }
  46. }]]></code>
  47. <para>
  48. </para>
  49. </remarks>
  50. </Docs>
  51. <Members>
  52. <Member MemberName=".ctor">
  53. <MemberSignature Language="C#" Value="public Component ();" />
  54. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  55. <MemberType>Constructor</MemberType>
  56. <AssemblyInfo>
  57. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  58. </AssemblyInfo>
  59. <Parameters />
  60. <Docs>
  61. <summary>
  62. <para>Constructs a new instance of Urho.Component which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  63. </summary>
  64. <remarks>
  65. </remarks>
  66. </Docs>
  67. </Member>
  68. <Member MemberName=".ctor">
  69. <MemberSignature Language="C#" Value="public Component (IntPtr handle);" />
  70. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  71. <MemberType>Constructor</MemberType>
  72. <AssemblyInfo>
  73. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  74. </AssemblyInfo>
  75. <Parameters>
  76. <Parameter Name="handle" Type="System.IntPtr" />
  77. </Parameters>
  78. <Docs>
  79. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  80. <summary>Constructs a new instance of Urho.Component, given a raw pointer to an unmanaged object</summary>
  81. <remarks>
  82. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  83. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  84. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  85. </remarks>
  86. </Docs>
  87. </Member>
  88. <Member MemberName=".ctor">
  89. <MemberSignature Language="C#" Value="public Component (Urho.Context context);" />
  90. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  91. <MemberType>Constructor</MemberType>
  92. <AssemblyInfo>
  93. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  94. </AssemblyInfo>
  95. <Parameters>
  96. <Parameter Name="context" Type="Urho.Context" />
  97. </Parameters>
  98. <Docs>
  99. <param name="context">The context that this object will be attached to.</param>
  100. <summary>
  101. <para>Constructs a new instance of Urho.Component linked to a specific <see cref="T:Urho.Context" />.</para>
  102. </summary>
  103. <remarks>
  104. </remarks>
  105. </Docs>
  106. </Member>
  107. <Member MemberName=".ctor">
  108. <MemberSignature Language="C#" Value="protected Component (Urho.UrhoObjectFlag emptyFlag);" />
  109. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  110. <MemberType>Constructor</MemberType>
  111. <AssemblyInfo>
  112. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  113. </AssemblyInfo>
  114. <Parameters>
  115. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  116. </Parameters>
  117. <Docs>
  118. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  119. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  120. <remarks>
  121. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  122. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  123. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  124. </remarks>
  125. </Docs>
  126. </Member>
  127. <Member MemberName="AddReplicationState">
  128. <MemberSignature Language="C#" Value="public void AddReplicationState (Urho.ComponentReplicationState* state);" />
  129. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddReplicationState(valuetype Urho.ComponentReplicationState* state) cil managed" />
  130. <MemberType>Method</MemberType>
  131. <AssemblyInfo>
  132. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  133. </AssemblyInfo>
  134. <ReturnValue>
  135. <ReturnType>System.Void</ReturnType>
  136. </ReturnValue>
  137. <Parameters>
  138. <Parameter Name="state" Type="Urho.ComponentReplicationState*" />
  139. </Parameters>
  140. <Docs>
  141. <param name="state">To be added.</param>
  142. <summary>
  143. Add a replication state that is tracking this component.
  144. </summary>
  145. <remarks>To be added.</remarks>
  146. </Docs>
  147. </Member>
  148. <Member MemberName="Application">
  149. <MemberSignature Language="C#" Value="public Urho.Application Application { get; }" />
  150. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Application Application" />
  151. <MemberType>Property</MemberType>
  152. <AssemblyInfo>
  153. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  154. </AssemblyInfo>
  155. <ReturnValue>
  156. <ReturnType>Urho.Application</ReturnType>
  157. </ReturnValue>
  158. <Docs>
  159. <summary>To be added.</summary>
  160. <value>To be added.</value>
  161. <remarks>To be added.</remarks>
  162. </Docs>
  163. </Member>
  164. <Member MemberName="CleanupConnection">
  165. <MemberSignature Language="C#" Value="public void CleanupConnection (Urho.Network.Connection connection);" />
  166. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CleanupConnection(class Urho.Network.Connection connection) cil managed" />
  167. <MemberType>Method</MemberType>
  168. <AssemblyInfo>
  169. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  170. </AssemblyInfo>
  171. <ReturnValue>
  172. <ReturnType>System.Void</ReturnType>
  173. </ReturnValue>
  174. <Parameters>
  175. <Parameter Name="connection" Type="Urho.Network.Connection" />
  176. </Parameters>
  177. <Docs>
  178. <param name="connection">To be added.</param>
  179. <summary>
  180. Clean up all references to a network connection that is about to be removed.
  181. </summary>
  182. <remarks>To be added.</remarks>
  183. </Docs>
  184. </Member>
  185. <Member MemberName="DrawDebugGeometry">
  186. <MemberSignature Language="C#" Value="public virtual void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  187. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  188. <MemberType>Method</MemberType>
  189. <AssemblyInfo>
  190. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  191. </AssemblyInfo>
  192. <ReturnValue>
  193. <ReturnType>System.Void</ReturnType>
  194. </ReturnValue>
  195. <Parameters>
  196. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  197. <Parameter Name="depthTest" Type="System.Boolean" />
  198. </Parameters>
  199. <Docs>
  200. <param name="debug">To be added.</param>
  201. <param name="depthTest">To be added.</param>
  202. <summary>
  203. Visualize the component as debug geometry.
  204. </summary>
  205. <remarks>To be added.</remarks>
  206. </Docs>
  207. </Member>
  208. <Member MemberName="Enabled">
  209. <MemberSignature Language="C#" Value="public bool Enabled { get; set; }" />
  210. <MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
  211. <MemberType>Property</MemberType>
  212. <AssemblyInfo>
  213. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  214. </AssemblyInfo>
  215. <ReturnValue>
  216. <ReturnType>System.Boolean</ReturnType>
  217. </ReturnValue>
  218. <Docs>
  219. <summary>Controls whether the component is enabled or not, additionally, the node might not be enabled, see EnabledEffective for a computation that takes both into account.</summary>
  220. <value>To be added.</value>
  221. <remarks>To be added.</remarks>
  222. </Docs>
  223. </Member>
  224. <Member MemberName="EnabledEffective">
  225. <MemberSignature Language="C#" Value="public bool EnabledEffective { get; }" />
  226. <MemberSignature Language="ILAsm" Value=".property instance bool EnabledEffective" />
  227. <MemberType>Property</MemberType>
  228. <AssemblyInfo>
  229. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  230. </AssemblyInfo>
  231. <ReturnValue>
  232. <ReturnType>System.Boolean</ReturnType>
  233. </ReturnValue>
  234. <Docs>
  235. <summary>Return whether is effectively enabled, that is, both the component and its containing Node are enabled.</summary>
  236. <value>To be added.</value>
  237. <remarks>To be added.</remarks>
  238. </Docs>
  239. </Member>
  240. <Member MemberName="GetComponent">
  241. <MemberSignature Language="C#" Value="public Urho.Component GetComponent (Urho.StringHash type);" />
  242. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Component GetComponent(valuetype Urho.StringHash type) cil managed" />
  243. <MemberType>Method</MemberType>
  244. <AssemblyInfo>
  245. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  246. </AssemblyInfo>
  247. <ReturnValue>
  248. <ReturnType>Urho.Component</ReturnType>
  249. </ReturnValue>
  250. <Parameters>
  251. <Parameter Name="type" Type="Urho.StringHash" />
  252. </Parameters>
  253. <Docs>
  254. <param name="type">To be added.</param>
  255. <summary>
  256. Return component in the same scene node by type. If there are several, returns the first.
  257. </summary>
  258. <returns>To be added.</returns>
  259. <remarks>To be added.</remarks>
  260. </Docs>
  261. </Member>
  262. <Member MemberName="GetComponent&lt;T&gt;">
  263. <MemberSignature Language="C#" Value="public T GetComponent&lt;T&gt; () where T : Urho.Component;" />
  264. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetComponent&lt;(class Urho.Component) T&gt;() cil managed" />
  265. <MemberType>Method</MemberType>
  266. <AssemblyInfo>
  267. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  268. </AssemblyInfo>
  269. <ReturnValue>
  270. <ReturnType>T</ReturnType>
  271. </ReturnValue>
  272. <TypeParameters>
  273. <TypeParameter Name="T">
  274. <Constraints>
  275. <BaseTypeName>Urho.Component</BaseTypeName>
  276. </Constraints>
  277. </TypeParameter>
  278. </TypeParameters>
  279. <Parameters />
  280. <Docs>
  281. <typeparam name="T">To be added.</typeparam>
  282. <summary>To be added.</summary>
  283. <returns>To be added.</returns>
  284. <remarks>To be added.</remarks>
  285. </Docs>
  286. </Member>
  287. <Member MemberName="ID">
  288. <MemberSignature Language="C#" Value="public uint ID { get; }" />
  289. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ID" />
  290. <MemberType>Property</MemberType>
  291. <AssemblyInfo>
  292. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  293. </AssemblyInfo>
  294. <ReturnValue>
  295. <ReturnType>System.UInt32</ReturnType>
  296. </ReturnValue>
  297. <Docs>
  298. <summary>
  299. Return ID.
  300. </summary>
  301. <value>To be added.</value>
  302. <remarks>To be added.</remarks>
  303. </Docs>
  304. </Member>
  305. <Member MemberName="MarkNetworkUpdate">
  306. <MemberSignature Language="C#" Value="public override void MarkNetworkUpdate ();" />
  307. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void MarkNetworkUpdate() cil managed" />
  308. <MemberType>Method</MemberType>
  309. <AssemblyInfo>
  310. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  311. </AssemblyInfo>
  312. <ReturnValue>
  313. <ReturnType>System.Void</ReturnType>
  314. </ReturnValue>
  315. <Parameters />
  316. <Docs>
  317. <summary>
  318. Mark for attribute check on the next network update.
  319. </summary>
  320. <remarks>To be added.</remarks>
  321. </Docs>
  322. </Member>
  323. <Member MemberName="Node">
  324. <MemberSignature Language="C#" Value="public Urho.Node Node { get; }" />
  325. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Node Node" />
  326. <MemberType>Property</MemberType>
  327. <AssemblyInfo>
  328. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  329. </AssemblyInfo>
  330. <ReturnValue>
  331. <ReturnType>Urho.Node</ReturnType>
  332. </ReturnValue>
  333. <Docs>
  334. <summary>
  335. Return scene node.
  336. </summary>
  337. <value>To be added.</value>
  338. <remarks>To be added.</remarks>
  339. </Docs>
  340. </Member>
  341. <Member MemberName="OnAttachedToNode">
  342. <MemberSignature Language="C#" Value="public virtual void OnAttachedToNode (Urho.Node node);" />
  343. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnAttachedToNode(class Urho.Node node) cil managed" />
  344. <MemberType>Method</MemberType>
  345. <AssemblyInfo>
  346. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  347. </AssemblyInfo>
  348. <ReturnValue>
  349. <ReturnType>System.Void</ReturnType>
  350. </ReturnValue>
  351. <Parameters>
  352. <Parameter Name="node" Type="Urho.Node" />
  353. </Parameters>
  354. <Docs>
  355. <param name="node">To be added.</param>
  356. <summary>To be added.</summary>
  357. <remarks>To be added.</remarks>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="OnDeleted">
  361. <MemberSignature Language="C#" Value="protected override void OnDeleted ();" />
  362. <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnDeleted() cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.Void</ReturnType>
  369. </ReturnValue>
  370. <Parameters />
  371. <Docs>
  372. <summary>To be added.</summary>
  373. <remarks>To be added.</remarks>
  374. </Docs>
  375. </Member>
  376. <Member MemberName="OnDeserialize">
  377. <MemberSignature Language="C#" Value="public virtual void OnDeserialize (Urho.Resources.IComponentDeserializer deserializer);" />
  378. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnDeserialize(class Urho.Resources.IComponentDeserializer deserializer) cil managed" />
  379. <MemberType>Method</MemberType>
  380. <AssemblyInfo>
  381. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  382. </AssemblyInfo>
  383. <ReturnValue>
  384. <ReturnType>System.Void</ReturnType>
  385. </ReturnValue>
  386. <Parameters>
  387. <Parameter Name="deserializer" Type="Urho.Resources.IComponentDeserializer" />
  388. </Parameters>
  389. <Docs>
  390. <param name="deserializer">Object used to retrieve the stored information</param>
  391. <summary>Overridable method to deserialize the component state</summary>
  392. <remarks>Implement this method to have the Urho runtime initialize your object state from a previously saved state.</remarks>
  393. </Docs>
  394. </Member>
  395. <Member MemberName="OnSerialize">
  396. <MemberSignature Language="C#" Value="public virtual void OnSerialize (Urho.Resources.IComponentSerializer serializer);" />
  397. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnSerialize(class Urho.Resources.IComponentSerializer serializer) cil managed" />
  398. <MemberType>Method</MemberType>
  399. <AssemblyInfo>
  400. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  401. </AssemblyInfo>
  402. <ReturnValue>
  403. <ReturnType>System.Void</ReturnType>
  404. </ReturnValue>
  405. <Parameters>
  406. <Parameter Name="serializer" Type="Urho.Resources.IComponentSerializer" />
  407. </Parameters>
  408. <Docs>
  409. <param name="serializer">You serialize the state into this object.</param>
  410. <summary>Overridable method to serialize the component state</summary>
  411. <remarks>You typically override this method in your application to save the state of your component.   Saving takes place by saving the state on the API surfaced by the serializer parameter.</remarks>
  412. </Docs>
  413. </Member>
  414. <Member MemberName="OnSetEnabled">
  415. <MemberSignature Language="C#" Value="public virtual void OnSetEnabled ();" />
  416. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnSetEnabled() cil managed" />
  417. <MemberType>Method</MemberType>
  418. <AssemblyInfo>
  419. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  420. </AssemblyInfo>
  421. <ReturnValue>
  422. <ReturnType>System.Void</ReturnType>
  423. </ReturnValue>
  424. <Parameters />
  425. <Docs>
  426. <summary>
  427. Handle enabled/disabled state change.
  428. </summary>
  429. <remarks>To be added.</remarks>
  430. </Docs>
  431. </Member>
  432. <Member MemberName="OnUpdate">
  433. <MemberSignature Language="C#" Value="protected virtual void OnUpdate (float timeStep);" />
  434. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnUpdate(float32 timeStep) cil managed" />
  435. <MemberType>Method</MemberType>
  436. <AssemblyInfo>
  437. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  438. </AssemblyInfo>
  439. <ReturnValue>
  440. <ReturnType>System.Void</ReturnType>
  441. </ReturnValue>
  442. <Parameters>
  443. <Parameter Name="timeStep" Type="System.Single" />
  444. </Parameters>
  445. <Docs>
  446. <param name="timeStep">To be added.</param>
  447. <summary>
  448. Make sure you set SubscribeToSceneUpdate property to true in order to receive Update events
  449. </summary>
  450. <remarks>To be added.</remarks>
  451. </Docs>
  452. </Member>
  453. <Member MemberName="PrepareNetworkUpdate">
  454. <MemberSignature Language="C#" Value="public void PrepareNetworkUpdate ();" />
  455. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PrepareNetworkUpdate() cil managed" />
  456. <MemberType>Method</MemberType>
  457. <AssemblyInfo>
  458. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  459. </AssemblyInfo>
  460. <ReturnValue>
  461. <ReturnType>System.Void</ReturnType>
  462. </ReturnValue>
  463. <Parameters />
  464. <Docs>
  465. <summary>
  466. Prepare network update by comparing attributes and marking replication states dirty as necessary.
  467. </summary>
  468. <remarks>To be added.</remarks>
  469. </Docs>
  470. </Member>
  471. <Member MemberName="ReceiveSceneUpdates">
  472. <MemberSignature Language="C#" Value="protected bool ReceiveSceneUpdates { get; set; }" />
  473. <MemberSignature Language="ILAsm" Value=".property instance bool ReceiveSceneUpdates" />
  474. <MemberType>Property</MemberType>
  475. <AssemblyInfo>
  476. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  477. </AssemblyInfo>
  478. <ReturnValue>
  479. <ReturnType>System.Boolean</ReturnType>
  480. </ReturnValue>
  481. <Docs>
  482. <summary>To be added.</summary>
  483. <value>To be added.</value>
  484. <remarks>To be added.</remarks>
  485. </Docs>
  486. </Member>
  487. <Member MemberName="Remove">
  488. <MemberSignature Language="C#" Value="public void Remove ();" />
  489. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Remove() cil managed" />
  490. <MemberType>Method</MemberType>
  491. <AssemblyInfo>
  492. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  493. </AssemblyInfo>
  494. <ReturnValue>
  495. <ReturnType>System.Void</ReturnType>
  496. </ReturnValue>
  497. <Parameters />
  498. <Docs>
  499. <summary>
  500. Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
  501. </summary>
  502. <remarks>To be added.</remarks>
  503. </Docs>
  504. </Member>
  505. <Member MemberName="Save">
  506. <MemberSignature Language="C#" Value="public override bool Save (Urho.IO.File dest);" />
  507. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Save(class Urho.IO.File dest) cil managed" />
  508. <MemberType>Method</MemberType>
  509. <AssemblyInfo>
  510. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  511. </AssemblyInfo>
  512. <ReturnValue>
  513. <ReturnType>System.Boolean</ReturnType>
  514. </ReturnValue>
  515. <Parameters>
  516. <Parameter Name="dest" Type="Urho.IO.File" />
  517. </Parameters>
  518. <Docs>
  519. <param name="dest">To be added.</param>
  520. <summary>To be added.</summary>
  521. <returns>To be added.</returns>
  522. <remarks>To be added.</remarks>
  523. </Docs>
  524. </Member>
  525. <Member MemberName="SaveXml">
  526. <MemberSignature Language="C#" Value="public override bool SaveXml (Urho.Resources.XmlElement dest);" />
  527. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool SaveXml(class Urho.Resources.XmlElement dest) cil managed" />
  528. <MemberType>Method</MemberType>
  529. <AssemblyInfo>
  530. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  531. </AssemblyInfo>
  532. <ReturnValue>
  533. <ReturnType>System.Boolean</ReturnType>
  534. </ReturnValue>
  535. <Parameters>
  536. <Parameter Name="dest" Type="Urho.Resources.XmlElement" />
  537. </Parameters>
  538. <Docs>
  539. <param name="dest">To be added.</param>
  540. <summary>To be added.</summary>
  541. <returns>To be added.</returns>
  542. <remarks>To be added.</remarks>
  543. </Docs>
  544. </Member>
  545. <Member MemberName="Scene">
  546. <MemberSignature Language="C#" Value="public Urho.Scene Scene { get; }" />
  547. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Scene Scene" />
  548. <MemberType>Property</MemberType>
  549. <AssemblyInfo>
  550. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  551. </AssemblyInfo>
  552. <ReturnValue>
  553. <ReturnType>Urho.Scene</ReturnType>
  554. </ReturnValue>
  555. <Docs>
  556. <summary>
  557. Return the scene the node belongs to.
  558. </summary>
  559. <value>To be added.</value>
  560. <remarks>To be added.</remarks>
  561. </Docs>
  562. </Member>
  563. <Member MemberName="Type">
  564. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  565. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  566. <MemberType>Property</MemberType>
  567. <AssemblyInfo>
  568. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  569. </AssemblyInfo>
  570. <ReturnValue>
  571. <ReturnType>Urho.StringHash</ReturnType>
  572. </ReturnValue>
  573. <Docs>
  574. <summary>Urho's type system type.</summary>
  575. <value>StringHash representing the type for this C# type.</value>
  576. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="TypeName">
  580. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  581. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  582. <MemberType>Property</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>System.String</ReturnType>
  588. </ReturnValue>
  589. <Docs>
  590. <summary>Urho's low-level type name.</summary>
  591. <value>Stringified low-level type name.</value>
  592. <remarks>
  593. </remarks>
  594. </Docs>
  595. </Member>
  596. <Member MemberName="TypeNameStatic">
  597. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  598. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  599. <MemberType>Property</MemberType>
  600. <AssemblyInfo>
  601. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  602. </AssemblyInfo>
  603. <ReturnValue>
  604. <ReturnType>System.String</ReturnType>
  605. </ReturnValue>
  606. <Docs>
  607. <summary>Urho's low-level type name, accessible as a static method.</summary>
  608. <value>Stringified low-level type name.</value>
  609. <remarks>
  610. </remarks>
  611. </Docs>
  612. </Member>
  613. <Member MemberName="TypeStatic">
  614. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  615. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  616. <MemberType>Property</MemberType>
  617. <AssemblyInfo>
  618. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  619. </AssemblyInfo>
  620. <ReturnValue>
  621. <ReturnType>Urho.StringHash</ReturnType>
  622. </ReturnValue>
  623. <Docs>
  624. <summary>Urho's low-level type, accessible as a static method.</summary>
  625. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  626. <remarks>
  627. </remarks>
  628. </Docs>
  629. </Member>
  630. </Members>
  631. </Type>