IArmatureProxy.cs 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /**
  2. * The MIT License (MIT)
  3. *
  4. * Copyright (c) 2012-2017 DragonBones team and other contributors
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining a copy of
  7. * this software and associated documentation files (the "Software"), to deal in
  8. * the Software without restriction, including without limitation the rights to
  9. * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  10. * the Software, and to permit persons to whom the Software is furnished to do so,
  11. * subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in all
  14. * copies or substantial portions of the Software.
  15. *
  16. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  18. * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  19. * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  20. * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22. */
  23. namespace DragonBones
  24. {
  25. /// <summary>
  26. /// - The armature proxy interface, the docking engine needs to implement it concretely.
  27. /// </summary>
  28. /// <see cref="DragonBones.Armature"/>
  29. /// <version>DragonBones 5.0</version>
  30. /// <language>en_US</language>
  31. /// <summary>
  32. /// - 骨架代理接口,对接的引擎需要对其进行具体实现。
  33. /// </summary>
  34. /// <see cref="DragonBones.Armature"/>
  35. /// <version>DragonBones 5.0</version>
  36. /// <language>zh_CN</language>
  37. public interface IArmatureProxy : IEventDispatcher<EventObject>
  38. {
  39. /// <internal/>
  40. /// <private/>
  41. void DBInit(Armature armature);
  42. /// <internal/>
  43. /// <private/>
  44. void DBClear();
  45. /// <internal/>
  46. /// <private/>
  47. void DBUpdate();
  48. /// <summary>
  49. /// - Dispose the instance and the Armature instance. (The Armature instance will return to the object pool)
  50. /// </summary>
  51. /// <example>
  52. /// TypeScript style, for reference only.
  53. /// <pre>
  54. /// removeChild(armatureDisplay);
  55. /// armatureDisplay.dispose();
  56. /// </pre>
  57. /// </example>
  58. /// <version>DragonBones 4.5</version>
  59. /// <language>en_US</language>
  60. /// <summary>
  61. /// - 释放该实例和骨架。 (骨架会回收到对象池)
  62. /// </summary>
  63. /// <example>
  64. /// TypeScript 风格,仅供参考。
  65. /// <pre>
  66. /// removeChild(armatureDisplay);
  67. /// armatureDisplay.dispose();
  68. /// </pre>
  69. /// </example>
  70. /// <version>DragonBones 4.5</version>
  71. /// <language>zh_CN</language>
  72. void Dispose(bool disposeProxy);
  73. /// <summary>
  74. /// - The armature.
  75. /// </summary>
  76. /// <version>DragonBones 4.5</version>
  77. /// <language>en_US</language>
  78. /// <summary>
  79. /// - 骨架。
  80. /// </summary>
  81. /// <version>DragonBones 4.5</version>
  82. /// <language>zh_CN</language>
  83. Armature armature { get; }
  84. /// <summary>
  85. /// - The animation player.
  86. /// </summary>
  87. /// <version>DragonBones 3.0</version>
  88. /// <language>en_US</language>
  89. /// <summary>
  90. /// - 动画播放器。
  91. /// </summary>
  92. /// <version>DragonBones 3.0</version>
  93. /// <language>zh_CN</language>
  94. AnimationDB animation { get; }
  95. }
  96. }