Component.xml 31 KB

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