AnimationController.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980
  1. <Type Name="AnimationController" FullName="Urho.AnimationController">
  2. <TypeSignature Language="C#" Value="public class AnimationController : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AnimationController extends Urho.Component" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Component that drives an AnimatedModel's animations.
  14. </summary>
  15. <remarks>To be added.</remarks>
  16. </Docs>
  17. <Members>
  18. <Member MemberName=".ctor">
  19. <MemberSignature Language="C#" Value="public AnimationController ();" />
  20. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  21. <MemberType>Constructor</MemberType>
  22. <AssemblyInfo>
  23. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  24. </AssemblyInfo>
  25. <Parameters />
  26. <Docs>
  27. <summary>
  28. <para>Constructs a new instance of Urho.AnimationController which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  29. </summary>
  30. <remarks></remarks>
  31. </Docs>
  32. </Member>
  33. <Member MemberName=".ctor">
  34. <MemberSignature Language="C#" Value="public AnimationController (IntPtr handle);" />
  35. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  36. <MemberType>Constructor</MemberType>
  37. <AssemblyInfo>
  38. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  39. </AssemblyInfo>
  40. <Parameters>
  41. <Parameter Name="handle" Type="System.IntPtr" />
  42. </Parameters>
  43. <Docs>
  44. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  45. <summary>Constructs a new instance of Urho.AnimationController, given a raw pointer to an unmanaged object</summary>
  46. <remarks>
  47. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  48. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  49. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  50. </remarks>
  51. </Docs>
  52. </Member>
  53. <Member MemberName=".ctor">
  54. <MemberSignature Language="C#" Value="public AnimationController (Urho.Context context);" />
  55. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  56. <MemberType>Constructor</MemberType>
  57. <AssemblyInfo>
  58. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  59. </AssemblyInfo>
  60. <Parameters>
  61. <Parameter Name="context" Type="Urho.Context" />
  62. </Parameters>
  63. <Docs>
  64. <param name="context">The context that this object will be attached to.</param>
  65. <summary>
  66. <para>Constructs a new instance of Urho.AnimationController linked to a specific <see cref="T:Urho.Context" />.</para>
  67. </summary>
  68. <remarks></remarks>
  69. </Docs>
  70. </Member>
  71. <Member MemberName=".ctor">
  72. <MemberSignature Language="C#" Value="protected AnimationController (Urho.UrhoObjectFlag emptyFlag);" />
  73. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  74. <MemberType>Constructor</MemberType>
  75. <AssemblyInfo>
  76. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  77. </AssemblyInfo>
  78. <Parameters>
  79. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  80. </Parameters>
  81. <Docs>
  82. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  83. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  84. <remarks>
  85. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  86. <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>
  87. <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>
  88. </remarks>
  89. </Docs>
  90. </Member>
  91. <Member MemberName="Fade">
  92. <MemberSignature Language="C#" Value="public bool Fade (string name, float targetWeight, float fadeTime);" />
  93. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Fade(string name, float32 targetWeight, float32 fadeTime) cil managed" />
  94. <MemberType>Method</MemberType>
  95. <AssemblyInfo>
  96. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  97. </AssemblyInfo>
  98. <ReturnValue>
  99. <ReturnType>System.Boolean</ReturnType>
  100. </ReturnValue>
  101. <Parameters>
  102. <Parameter Name="name" Type="System.String" />
  103. <Parameter Name="targetWeight" Type="System.Single" />
  104. <Parameter Name="fadeTime" Type="System.Single" />
  105. </Parameters>
  106. <Docs>
  107. <param name="name">To be added.</param>
  108. <param name="targetWeight">To be added.</param>
  109. <param name="fadeTime">To be added.</param>
  110. <summary>
  111. Fade animation to target weight. Return true on success.
  112. </summary>
  113. <returns>To be added.</returns>
  114. <remarks>To be added.</remarks>
  115. </Docs>
  116. </Member>
  117. <Member MemberName="FadeOthers">
  118. <MemberSignature Language="C#" Value="public bool FadeOthers (string name, float targetWeight, float fadeTime);" />
  119. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FadeOthers(string name, float32 targetWeight, float32 fadeTime) cil managed" />
  120. <MemberType>Method</MemberType>
  121. <AssemblyInfo>
  122. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  123. </AssemblyInfo>
  124. <ReturnValue>
  125. <ReturnType>System.Boolean</ReturnType>
  126. </ReturnValue>
  127. <Parameters>
  128. <Parameter Name="name" Type="System.String" />
  129. <Parameter Name="targetWeight" Type="System.Single" />
  130. <Parameter Name="fadeTime" Type="System.Single" />
  131. </Parameters>
  132. <Docs>
  133. <param name="name">To be added.</param>
  134. <param name="targetWeight">To be added.</param>
  135. <param name="fadeTime">To be added.</param>
  136. <summary>
  137. Fade other animations on the same layer to target weight. Return true on success.
  138. </summary>
  139. <returns>To be added.</returns>
  140. <remarks>To be added.</remarks>
  141. </Docs>
  142. </Member>
  143. <Member MemberName="GetAnimationState">
  144. <MemberSignature Language="C#" Value="public Urho.AnimationState GetAnimationState (string name);" />
  145. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.AnimationState GetAnimationState(string name) cil managed" />
  146. <MemberType>Method</MemberType>
  147. <AssemblyInfo>
  148. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  149. </AssemblyInfo>
  150. <ReturnValue>
  151. <ReturnType>Urho.AnimationState</ReturnType>
  152. </ReturnValue>
  153. <Parameters>
  154. <Parameter Name="name" Type="System.String" />
  155. </Parameters>
  156. <Docs>
  157. <param name="name">To be added.</param>
  158. <summary>
  159. Find an animation state by animation name.
  160. </summary>
  161. <returns>To be added.</returns>
  162. <remarks>To be added.</remarks>
  163. </Docs>
  164. </Member>
  165. <Member MemberName="GetAnimationState">
  166. <MemberSignature Language="C#" Value="public Urho.AnimationState GetAnimationState (Urho.StringHash nameHash);" />
  167. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.AnimationState GetAnimationState(valuetype Urho.StringHash nameHash) cil managed" />
  168. <MemberType>Method</MemberType>
  169. <AssemblyInfo>
  170. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  171. </AssemblyInfo>
  172. <ReturnValue>
  173. <ReturnType>Urho.AnimationState</ReturnType>
  174. </ReturnValue>
  175. <Parameters>
  176. <Parameter Name="nameHash" Type="Urho.StringHash" />
  177. </Parameters>
  178. <Docs>
  179. <param name="nameHash">To be added.</param>
  180. <summary>
  181. Find an animation state by animation name hash
  182. </summary>
  183. <returns>To be added.</returns>
  184. <remarks>To be added.</remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="GetAutoFade">
  188. <MemberSignature Language="C#" Value="public float GetAutoFade (string name);" />
  189. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetAutoFade(string name) cil managed" />
  190. <MemberType>Method</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.Single</ReturnType>
  196. </ReturnValue>
  197. <Parameters>
  198. <Parameter Name="name" Type="System.String" />
  199. </Parameters>
  200. <Docs>
  201. <param name="name">To be added.</param>
  202. <summary>
  203. Return animation autofade time.
  204. </summary>
  205. <returns>To be added.</returns>
  206. <remarks>To be added.</remarks>
  207. </Docs>
  208. </Member>
  209. <Member MemberName="GetFadeTarget">
  210. <MemberSignature Language="C#" Value="public float GetFadeTarget (string name);" />
  211. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetFadeTarget(string name) cil managed" />
  212. <MemberType>Method</MemberType>
  213. <AssemblyInfo>
  214. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  215. </AssemblyInfo>
  216. <ReturnValue>
  217. <ReturnType>System.Single</ReturnType>
  218. </ReturnValue>
  219. <Parameters>
  220. <Parameter Name="name" Type="System.String" />
  221. </Parameters>
  222. <Docs>
  223. <param name="name">To be added.</param>
  224. <summary>
  225. Return animation fade target weight.
  226. </summary>
  227. <returns>To be added.</returns>
  228. <remarks>To be added.</remarks>
  229. </Docs>
  230. </Member>
  231. <Member MemberName="GetFadeTime">
  232. <MemberSignature Language="C#" Value="public float GetFadeTime (string name);" />
  233. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetFadeTime(string name) cil managed" />
  234. <MemberType>Method</MemberType>
  235. <AssemblyInfo>
  236. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  237. </AssemblyInfo>
  238. <ReturnValue>
  239. <ReturnType>System.Single</ReturnType>
  240. </ReturnValue>
  241. <Parameters>
  242. <Parameter Name="name" Type="System.String" />
  243. </Parameters>
  244. <Docs>
  245. <param name="name">To be added.</param>
  246. <summary>
  247. Return animation fade time.
  248. </summary>
  249. <returns>To be added.</returns>
  250. <remarks>To be added.</remarks>
  251. </Docs>
  252. </Member>
  253. <Member MemberName="GetLayer">
  254. <MemberSignature Language="C#" Value="public byte GetLayer (string name);" />
  255. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8 GetLayer(string name) cil managed" />
  256. <MemberType>Method</MemberType>
  257. <AssemblyInfo>
  258. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  259. </AssemblyInfo>
  260. <ReturnValue>
  261. <ReturnType>System.Byte</ReturnType>
  262. </ReturnValue>
  263. <Parameters>
  264. <Parameter Name="name" Type="System.String" />
  265. </Parameters>
  266. <Docs>
  267. <param name="name">To be added.</param>
  268. <summary>
  269. Return animation blending layer.
  270. </summary>
  271. <returns>To be added.</returns>
  272. <remarks>To be added.</remarks>
  273. </Docs>
  274. </Member>
  275. <Member MemberName="GetLength">
  276. <MemberSignature Language="C#" Value="public float GetLength (string name);" />
  277. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetLength(string name) cil managed" />
  278. <MemberType>Method</MemberType>
  279. <AssemblyInfo>
  280. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  281. </AssemblyInfo>
  282. <ReturnValue>
  283. <ReturnType>System.Single</ReturnType>
  284. </ReturnValue>
  285. <Parameters>
  286. <Parameter Name="name" Type="System.String" />
  287. </Parameters>
  288. <Docs>
  289. <param name="name">To be added.</param>
  290. <summary>
  291. Return animation length.
  292. </summary>
  293. <returns>To be added.</returns>
  294. <remarks>To be added.</remarks>
  295. </Docs>
  296. </Member>
  297. <Member MemberName="GetRemoveOnCompletion">
  298. <MemberSignature Language="C#" Value="public bool GetRemoveOnCompletion (string name);" />
  299. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetRemoveOnCompletion(string name) cil managed" />
  300. <MemberType>Method</MemberType>
  301. <AssemblyInfo>
  302. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  303. </AssemblyInfo>
  304. <ReturnValue>
  305. <ReturnType>System.Boolean</ReturnType>
  306. </ReturnValue>
  307. <Parameters>
  308. <Parameter Name="name" Type="System.String" />
  309. </Parameters>
  310. <Docs>
  311. <param name="name">To be added.</param>
  312. <summary>
  313. Return whether animation auto-removes on completion, or false if no such animation.
  314. </summary>
  315. <returns>To be added.</returns>
  316. <remarks>To be added.</remarks>
  317. </Docs>
  318. </Member>
  319. <Member MemberName="GetSpeed">
  320. <MemberSignature Language="C#" Value="public float GetSpeed (string name);" />
  321. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetSpeed(string name) cil managed" />
  322. <MemberType>Method</MemberType>
  323. <AssemblyInfo>
  324. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  325. </AssemblyInfo>
  326. <ReturnValue>
  327. <ReturnType>System.Single</ReturnType>
  328. </ReturnValue>
  329. <Parameters>
  330. <Parameter Name="name" Type="System.String" />
  331. </Parameters>
  332. <Docs>
  333. <param name="name">To be added.</param>
  334. <summary>
  335. Return animation speed.
  336. </summary>
  337. <returns>To be added.</returns>
  338. <remarks>To be added.</remarks>
  339. </Docs>
  340. </Member>
  341. <Member MemberName="GetStartBone">
  342. <MemberSignature Language="C#" Value="public Urho.Bone* GetStartBone (string name);" />
  343. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Bone* GetStartBone(string name) cil managed" />
  344. <MemberType>Method</MemberType>
  345. <AssemblyInfo>
  346. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  347. </AssemblyInfo>
  348. <ReturnValue>
  349. <ReturnType>Urho.Bone*</ReturnType>
  350. </ReturnValue>
  351. <Parameters>
  352. <Parameter Name="name" Type="System.String" />
  353. </Parameters>
  354. <Docs>
  355. <param name="name">To be added.</param>
  356. <summary>
  357. Return animation start bone, or null if no such animation.
  358. </summary>
  359. <returns>To be added.</returns>
  360. <remarks>To be added.</remarks>
  361. </Docs>
  362. </Member>
  363. <Member MemberName="GetStartBoneName">
  364. <MemberSignature Language="C#" Value="public string GetStartBoneName (string name);" />
  365. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetStartBoneName(string name) cil managed" />
  366. <MemberType>Method</MemberType>
  367. <AssemblyInfo>
  368. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  369. </AssemblyInfo>
  370. <ReturnValue>
  371. <ReturnType>System.String</ReturnType>
  372. </ReturnValue>
  373. <Parameters>
  374. <Parameter Name="name" Type="System.String" />
  375. </Parameters>
  376. <Docs>
  377. <param name="name">To be added.</param>
  378. <summary>
  379. Return animation start bone name, or empty string if no such animation.
  380. </summary>
  381. <returns>To be added.</returns>
  382. <remarks>To be added.</remarks>
  383. </Docs>
  384. </Member>
  385. <Member MemberName="GetTime">
  386. <MemberSignature Language="C#" Value="public float GetTime (string name);" />
  387. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetTime(string name) cil managed" />
  388. <MemberType>Method</MemberType>
  389. <AssemblyInfo>
  390. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  391. </AssemblyInfo>
  392. <ReturnValue>
  393. <ReturnType>System.Single</ReturnType>
  394. </ReturnValue>
  395. <Parameters>
  396. <Parameter Name="name" Type="System.String" />
  397. </Parameters>
  398. <Docs>
  399. <param name="name">To be added.</param>
  400. <summary>
  401. Return animation time position.
  402. </summary>
  403. <returns>To be added.</returns>
  404. <remarks>To be added.</remarks>
  405. </Docs>
  406. </Member>
  407. <Member MemberName="GetWeight">
  408. <MemberSignature Language="C#" Value="public float GetWeight (string name);" />
  409. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetWeight(string name) cil managed" />
  410. <MemberType>Method</MemberType>
  411. <AssemblyInfo>
  412. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  413. </AssemblyInfo>
  414. <ReturnValue>
  415. <ReturnType>System.Single</ReturnType>
  416. </ReturnValue>
  417. <Parameters>
  418. <Parameter Name="name" Type="System.String" />
  419. </Parameters>
  420. <Docs>
  421. <param name="name">To be added.</param>
  422. <summary>
  423. Return animation weight.
  424. </summary>
  425. <returns>To be added.</returns>
  426. <remarks>To be added.</remarks>
  427. </Docs>
  428. </Member>
  429. <Member MemberName="IsAtEnd">
  430. <MemberSignature Language="C#" Value="public bool IsAtEnd (string name);" />
  431. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsAtEnd(string name) cil managed" />
  432. <MemberType>Method</MemberType>
  433. <AssemblyInfo>
  434. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  435. </AssemblyInfo>
  436. <ReturnValue>
  437. <ReturnType>System.Boolean</ReturnType>
  438. </ReturnValue>
  439. <Parameters>
  440. <Parameter Name="name" Type="System.String" />
  441. </Parameters>
  442. <Docs>
  443. <param name="name">To be added.</param>
  444. <summary>
  445. Return whether an animation is at its end. Will return false if the animation is not active at all.
  446. </summary>
  447. <returns>To be added.</returns>
  448. <remarks>To be added.</remarks>
  449. </Docs>
  450. </Member>
  451. <Member MemberName="IsFadingIn">
  452. <MemberSignature Language="C#" Value="public bool IsFadingIn (string name);" />
  453. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsFadingIn(string name) cil managed" />
  454. <MemberType>Method</MemberType>
  455. <AssemblyInfo>
  456. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  457. </AssemblyInfo>
  458. <ReturnValue>
  459. <ReturnType>System.Boolean</ReturnType>
  460. </ReturnValue>
  461. <Parameters>
  462. <Parameter Name="name" Type="System.String" />
  463. </Parameters>
  464. <Docs>
  465. <param name="name">To be added.</param>
  466. <summary>
  467. Return whether an animation is fading in.
  468. </summary>
  469. <returns>To be added.</returns>
  470. <remarks>To be added.</remarks>
  471. </Docs>
  472. </Member>
  473. <Member MemberName="IsFadingOut">
  474. <MemberSignature Language="C#" Value="public bool IsFadingOut (string name);" />
  475. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsFadingOut(string name) cil managed" />
  476. <MemberType>Method</MemberType>
  477. <AssemblyInfo>
  478. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  479. </AssemblyInfo>
  480. <ReturnValue>
  481. <ReturnType>System.Boolean</ReturnType>
  482. </ReturnValue>
  483. <Parameters>
  484. <Parameter Name="name" Type="System.String" />
  485. </Parameters>
  486. <Docs>
  487. <param name="name">To be added.</param>
  488. <summary>
  489. Return whether an animation is fading out.
  490. </summary>
  491. <returns>To be added.</returns>
  492. <remarks>To be added.</remarks>
  493. </Docs>
  494. </Member>
  495. <Member MemberName="IsLooped">
  496. <MemberSignature Language="C#" Value="public bool IsLooped (string name);" />
  497. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsLooped(string name) cil managed" />
  498. <MemberType>Method</MemberType>
  499. <AssemblyInfo>
  500. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  501. </AssemblyInfo>
  502. <ReturnValue>
  503. <ReturnType>System.Boolean</ReturnType>
  504. </ReturnValue>
  505. <Parameters>
  506. <Parameter Name="name" Type="System.String" />
  507. </Parameters>
  508. <Docs>
  509. <param name="name">To be added.</param>
  510. <summary>
  511. Return animation looping.
  512. </summary>
  513. <returns>To be added.</returns>
  514. <remarks>To be added.</remarks>
  515. </Docs>
  516. </Member>
  517. <Member MemberName="IsPlaying">
  518. <MemberSignature Language="C#" Value="public bool IsPlaying (string name);" />
  519. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsPlaying(string name) cil managed" />
  520. <MemberType>Method</MemberType>
  521. <AssemblyInfo>
  522. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  523. </AssemblyInfo>
  524. <ReturnValue>
  525. <ReturnType>System.Boolean</ReturnType>
  526. </ReturnValue>
  527. <Parameters>
  528. <Parameter Name="name" Type="System.String" />
  529. </Parameters>
  530. <Docs>
  531. <param name="name">To be added.</param>
  532. <summary>
  533. Return whether an animation is active. Note that non-looping animations that are being clamped at the end also return true.
  534. </summary>
  535. <returns>To be added.</returns>
  536. <remarks>To be added.</remarks>
  537. </Docs>
  538. </Member>
  539. <Member MemberName="OnSetEnabled">
  540. <MemberSignature Language="C#" Value="public override void OnSetEnabled ();" />
  541. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSetEnabled() cil managed" />
  542. <MemberType>Method</MemberType>
  543. <AssemblyInfo>
  544. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  545. </AssemblyInfo>
  546. <ReturnValue>
  547. <ReturnType>System.Void</ReturnType>
  548. </ReturnValue>
  549. <Parameters />
  550. <Docs>
  551. <summary>
  552. Handle enabled/disabled state change.
  553. </summary>
  554. <remarks>To be added.</remarks>
  555. </Docs>
  556. </Member>
  557. <Member MemberName="Play">
  558. <MemberSignature Language="C#" Value="public bool Play (string name, byte layer, bool looped, float fadeInTime);" />
  559. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Play(string name, unsigned int8 layer, bool looped, float32 fadeInTime) cil managed" />
  560. <MemberType>Method</MemberType>
  561. <AssemblyInfo>
  562. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  563. </AssemblyInfo>
  564. <ReturnValue>
  565. <ReturnType>System.Boolean</ReturnType>
  566. </ReturnValue>
  567. <Parameters>
  568. <Parameter Name="name" Type="System.String" />
  569. <Parameter Name="layer" Type="System.Byte" />
  570. <Parameter Name="looped" Type="System.Boolean" />
  571. <Parameter Name="fadeInTime" Type="System.Single" />
  572. </Parameters>
  573. <Docs>
  574. <param name="name">To be added.</param>
  575. <param name="layer">To be added.</param>
  576. <param name="looped">To be added.</param>
  577. <param name="fadeInTime">To be added.</param>
  578. <summary>
  579. Play an animation and set full target weight. Name must be the full resource name. Return true on success.
  580. </summary>
  581. <returns>To be added.</returns>
  582. <remarks>To be added.</remarks>
  583. </Docs>
  584. </Member>
  585. <Member MemberName="PlayExclusive">
  586. <MemberSignature Language="C#" Value="public bool PlayExclusive (string name, byte layer, bool looped, float fadeTime);" />
  587. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool PlayExclusive(string name, unsigned int8 layer, bool looped, float32 fadeTime) cil managed" />
  588. <MemberType>Method</MemberType>
  589. <AssemblyInfo>
  590. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  591. </AssemblyInfo>
  592. <ReturnValue>
  593. <ReturnType>System.Boolean</ReturnType>
  594. </ReturnValue>
  595. <Parameters>
  596. <Parameter Name="name" Type="System.String" />
  597. <Parameter Name="layer" Type="System.Byte" />
  598. <Parameter Name="looped" Type="System.Boolean" />
  599. <Parameter Name="fadeTime" Type="System.Single" />
  600. </Parameters>
  601. <Docs>
  602. <param name="name">To be added.</param>
  603. <param name="layer">To be added.</param>
  604. <param name="looped">To be added.</param>
  605. <param name="fadeTime">To be added.</param>
  606. <summary>
  607. Play an animation, set full target weight and fade out all other animations on the same layer. Name must be the full resource name. Return true on success.
  608. </summary>
  609. <returns>To be added.</returns>
  610. <remarks>To be added.</remarks>
  611. </Docs>
  612. </Member>
  613. <Member MemberName="RegisterObject">
  614. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  615. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  616. <MemberType>Method</MemberType>
  617. <AssemblyInfo>
  618. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  619. </AssemblyInfo>
  620. <ReturnValue>
  621. <ReturnType>System.Void</ReturnType>
  622. </ReturnValue>
  623. <Parameters>
  624. <Parameter Name="context" Type="Urho.Context" />
  625. </Parameters>
  626. <Docs>
  627. <param name="context">To be added.</param>
  628. <summary>
  629. Register object factory.
  630. </summary>
  631. <remarks>To be added.</remarks>
  632. </Docs>
  633. </Member>
  634. <Member MemberName="SetAutoFade">
  635. <MemberSignature Language="C#" Value="public bool SetAutoFade (string name, float fadeOutTime);" />
  636. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetAutoFade(string name, float32 fadeOutTime) cil managed" />
  637. <MemberType>Method</MemberType>
  638. <AssemblyInfo>
  639. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  640. </AssemblyInfo>
  641. <ReturnValue>
  642. <ReturnType>System.Boolean</ReturnType>
  643. </ReturnValue>
  644. <Parameters>
  645. <Parameter Name="name" Type="System.String" />
  646. <Parameter Name="fadeOutTime" Type="System.Single" />
  647. </Parameters>
  648. <Docs>
  649. <param name="name">To be added.</param>
  650. <param name="fadeOutTime">To be added.</param>
  651. <summary>
  652. Set animation autofade at end (non-looped animations only.) Zero time disables. Return true on success.
  653. </summary>
  654. <returns>To be added.</returns>
  655. <remarks>To be added.</remarks>
  656. </Docs>
  657. </Member>
  658. <Member MemberName="SetLayer">
  659. <MemberSignature Language="C#" Value="public bool SetLayer (string name, byte layer);" />
  660. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetLayer(string name, unsigned int8 layer) cil managed" />
  661. <MemberType>Method</MemberType>
  662. <AssemblyInfo>
  663. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  664. </AssemblyInfo>
  665. <ReturnValue>
  666. <ReturnType>System.Boolean</ReturnType>
  667. </ReturnValue>
  668. <Parameters>
  669. <Parameter Name="name" Type="System.String" />
  670. <Parameter Name="layer" Type="System.Byte" />
  671. </Parameters>
  672. <Docs>
  673. <param name="name">To be added.</param>
  674. <param name="layer">To be added.</param>
  675. <summary>
  676. Set animation blending layer priority. Return true on success.
  677. </summary>
  678. <returns>To be added.</returns>
  679. <remarks>To be added.</remarks>
  680. </Docs>
  681. </Member>
  682. <Member MemberName="SetLooped">
  683. <MemberSignature Language="C#" Value="public bool SetLooped (string name, bool enable);" />
  684. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetLooped(string name, bool enable) cil managed" />
  685. <MemberType>Method</MemberType>
  686. <AssemblyInfo>
  687. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  688. </AssemblyInfo>
  689. <ReturnValue>
  690. <ReturnType>System.Boolean</ReturnType>
  691. </ReturnValue>
  692. <Parameters>
  693. <Parameter Name="name" Type="System.String" />
  694. <Parameter Name="enable" Type="System.Boolean" />
  695. </Parameters>
  696. <Docs>
  697. <param name="name">To be added.</param>
  698. <param name="enable">To be added.</param>
  699. <summary>
  700. Set animation looping. Return true on success.
  701. </summary>
  702. <returns>To be added.</returns>
  703. <remarks>To be added.</remarks>
  704. </Docs>
  705. </Member>
  706. <Member MemberName="SetRemoveOnCompletion">
  707. <MemberSignature Language="C#" Value="public bool SetRemoveOnCompletion (string name, bool removeOnCompletion);" />
  708. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetRemoveOnCompletion(string name, bool removeOnCompletion) cil managed" />
  709. <MemberType>Method</MemberType>
  710. <AssemblyInfo>
  711. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  712. </AssemblyInfo>
  713. <ReturnValue>
  714. <ReturnType>System.Boolean</ReturnType>
  715. </ReturnValue>
  716. <Parameters>
  717. <Parameter Name="name" Type="System.String" />
  718. <Parameter Name="removeOnCompletion" Type="System.Boolean" />
  719. </Parameters>
  720. <Docs>
  721. <param name="name">To be added.</param>
  722. <param name="removeOnCompletion">To be added.</param>
  723. <summary>
  724. Set whether an animation auto-removes on completion.
  725. </summary>
  726. <returns>To be added.</returns>
  727. <remarks>To be added.</remarks>
  728. </Docs>
  729. </Member>
  730. <Member MemberName="SetSpeed">
  731. <MemberSignature Language="C#" Value="public bool SetSpeed (string name, float speed);" />
  732. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetSpeed(string name, float32 speed) cil managed" />
  733. <MemberType>Method</MemberType>
  734. <AssemblyInfo>
  735. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  736. </AssemblyInfo>
  737. <ReturnValue>
  738. <ReturnType>System.Boolean</ReturnType>
  739. </ReturnValue>
  740. <Parameters>
  741. <Parameter Name="name" Type="System.String" />
  742. <Parameter Name="speed" Type="System.Single" />
  743. </Parameters>
  744. <Docs>
  745. <param name="name">To be added.</param>
  746. <param name="speed">To be added.</param>
  747. <summary>
  748. Set animation speed. Return true on success.
  749. </summary>
  750. <returns>To be added.</returns>
  751. <remarks>To be added.</remarks>
  752. </Docs>
  753. </Member>
  754. <Member MemberName="SetStartBone">
  755. <MemberSignature Language="C#" Value="public bool SetStartBone (string name, string startBoneName);" />
  756. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetStartBone(string name, string startBoneName) cil managed" />
  757. <MemberType>Method</MemberType>
  758. <AssemblyInfo>
  759. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  760. </AssemblyInfo>
  761. <ReturnValue>
  762. <ReturnType>System.Boolean</ReturnType>
  763. </ReturnValue>
  764. <Parameters>
  765. <Parameter Name="name" Type="System.String" />
  766. <Parameter Name="startBoneName" Type="System.String" />
  767. </Parameters>
  768. <Docs>
  769. <param name="name">To be added.</param>
  770. <param name="startBoneName">To be added.</param>
  771. <summary>
  772. Set animation start bone. Return true on success.
  773. </summary>
  774. <returns>To be added.</returns>
  775. <remarks>To be added.</remarks>
  776. </Docs>
  777. </Member>
  778. <Member MemberName="SetTime">
  779. <MemberSignature Language="C#" Value="public bool SetTime (string name, float time);" />
  780. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetTime(string name, float32 time) cil managed" />
  781. <MemberType>Method</MemberType>
  782. <AssemblyInfo>
  783. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  784. </AssemblyInfo>
  785. <ReturnValue>
  786. <ReturnType>System.Boolean</ReturnType>
  787. </ReturnValue>
  788. <Parameters>
  789. <Parameter Name="name" Type="System.String" />
  790. <Parameter Name="time" Type="System.Single" />
  791. </Parameters>
  792. <Docs>
  793. <param name="name">To be added.</param>
  794. <param name="time">To be added.</param>
  795. <summary>
  796. Set animation time position. Return true on success.
  797. </summary>
  798. <returns>To be added.</returns>
  799. <remarks>To be added.</remarks>
  800. </Docs>
  801. </Member>
  802. <Member MemberName="SetWeight">
  803. <MemberSignature Language="C#" Value="public bool SetWeight (string name, float weight);" />
  804. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetWeight(string name, float32 weight) cil managed" />
  805. <MemberType>Method</MemberType>
  806. <AssemblyInfo>
  807. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  808. </AssemblyInfo>
  809. <ReturnValue>
  810. <ReturnType>System.Boolean</ReturnType>
  811. </ReturnValue>
  812. <Parameters>
  813. <Parameter Name="name" Type="System.String" />
  814. <Parameter Name="weight" Type="System.Single" />
  815. </Parameters>
  816. <Docs>
  817. <param name="name">To be added.</param>
  818. <param name="weight">To be added.</param>
  819. <summary>
  820. Set animation weight. Return true on success.
  821. </summary>
  822. <returns>To be added.</returns>
  823. <remarks>To be added.</remarks>
  824. </Docs>
  825. </Member>
  826. <Member MemberName="Stop">
  827. <MemberSignature Language="C#" Value="public bool Stop (string name, float fadeOutTime);" />
  828. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Stop(string name, float32 fadeOutTime) cil managed" />
  829. <MemberType>Method</MemberType>
  830. <AssemblyInfo>
  831. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  832. </AssemblyInfo>
  833. <ReturnValue>
  834. <ReturnType>System.Boolean</ReturnType>
  835. </ReturnValue>
  836. <Parameters>
  837. <Parameter Name="name" Type="System.String" />
  838. <Parameter Name="fadeOutTime" Type="System.Single" />
  839. </Parameters>
  840. <Docs>
  841. <param name="name">To be added.</param>
  842. <param name="fadeOutTime">To be added.</param>
  843. <summary>
  844. Stop an animation. Zero fadetime is instant. Return true on success.
  845. </summary>
  846. <returns>To be added.</returns>
  847. <remarks>To be added.</remarks>
  848. </Docs>
  849. </Member>
  850. <Member MemberName="StopAll">
  851. <MemberSignature Language="C#" Value="public void StopAll (float fadeTime);" />
  852. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopAll(float32 fadeTime) cil managed" />
  853. <MemberType>Method</MemberType>
  854. <AssemblyInfo>
  855. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  856. </AssemblyInfo>
  857. <ReturnValue>
  858. <ReturnType>System.Void</ReturnType>
  859. </ReturnValue>
  860. <Parameters>
  861. <Parameter Name="fadeTime" Type="System.Single" />
  862. </Parameters>
  863. <Docs>
  864. <param name="fadeTime">To be added.</param>
  865. <summary>
  866. Stop all animations. Zero fadetime is instant.
  867. </summary>
  868. <remarks>To be added.</remarks>
  869. </Docs>
  870. </Member>
  871. <Member MemberName="StopLayer">
  872. <MemberSignature Language="C#" Value="public void StopLayer (byte layer, float fadeOutTime);" />
  873. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopLayer(unsigned int8 layer, float32 fadeOutTime) cil managed" />
  874. <MemberType>Method</MemberType>
  875. <AssemblyInfo>
  876. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  877. </AssemblyInfo>
  878. <ReturnValue>
  879. <ReturnType>System.Void</ReturnType>
  880. </ReturnValue>
  881. <Parameters>
  882. <Parameter Name="layer" Type="System.Byte" />
  883. <Parameter Name="fadeOutTime" Type="System.Single" />
  884. </Parameters>
  885. <Docs>
  886. <param name="layer">To be added.</param>
  887. <param name="fadeOutTime">To be added.</param>
  888. <summary>
  889. Stop all animations on a specific layer. Zero fadetime is instant.
  890. </summary>
  891. <remarks>To be added.</remarks>
  892. </Docs>
  893. </Member>
  894. <Member MemberName="Type">
  895. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  896. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  897. <MemberType>Property</MemberType>
  898. <AssemblyInfo>
  899. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  900. </AssemblyInfo>
  901. <ReturnValue>
  902. <ReturnType>Urho.StringHash</ReturnType>
  903. </ReturnValue>
  904. <Docs>
  905. <summary>Urho's type system type.</summary>
  906. <value>StringHash representing the type for this C# type.</value>
  907. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  908. </Docs>
  909. </Member>
  910. <Member MemberName="TypeName">
  911. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  912. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  913. <MemberType>Property</MemberType>
  914. <AssemblyInfo>
  915. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  916. </AssemblyInfo>
  917. <ReturnValue>
  918. <ReturnType>System.String</ReturnType>
  919. </ReturnValue>
  920. <Docs>
  921. <summary>Urho's low-level type name.</summary>
  922. <value>Stringified low-level type name.</value>
  923. <remarks></remarks>
  924. </Docs>
  925. </Member>
  926. <Member MemberName="TypeNameStatic">
  927. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  928. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  929. <MemberType>Property</MemberType>
  930. <AssemblyInfo>
  931. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  932. </AssemblyInfo>
  933. <ReturnValue>
  934. <ReturnType>System.String</ReturnType>
  935. </ReturnValue>
  936. <Docs>
  937. <summary>Urho's low-level type name, accessible as a static method.</summary>
  938. <value>Stringified low-level type name.</value>
  939. <remarks></remarks>
  940. </Docs>
  941. </Member>
  942. <Member MemberName="TypeStatic">
  943. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  944. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  945. <MemberType>Property</MemberType>
  946. <AssemblyInfo>
  947. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  948. </AssemblyInfo>
  949. <ReturnValue>
  950. <ReturnType>Urho.StringHash</ReturnType>
  951. </ReturnValue>
  952. <Docs>
  953. <summary>Urho's low-level type, accessible as a static method.</summary>
  954. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  955. <remarks></remarks>
  956. </Docs>
  957. </Member>
  958. <Member MemberName="Update">
  959. <MemberSignature Language="C#" Value="public void Update (float timeStep);" />
  960. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 timeStep) cil managed" />
  961. <MemberType>Method</MemberType>
  962. <AssemblyInfo>
  963. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  964. </AssemblyInfo>
  965. <ReturnValue>
  966. <ReturnType>System.Void</ReturnType>
  967. </ReturnValue>
  968. <Parameters>
  969. <Parameter Name="timeStep" Type="System.Single" />
  970. </Parameters>
  971. <Docs>
  972. <param name="timeStep">To be added.</param>
  973. <summary>
  974. Update the animations. Is called from HandleScenePostUpdate().
  975. </summary>
  976. <remarks>To be added.</remarks>
  977. </Docs>
  978. </Member>
  979. </Members>
  980. </Type>