AnimationController.xml 41 KB

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