Component.xml 31 KB

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