AnimationController.xml 40 KB

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