SkeletonLoader.cs 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. /******************************************************************************
  2. * Spine Runtimes License Agreement
  3. * Last updated July 28, 2023. Replaces all prior versions.
  4. *
  5. * Copyright (c) 2013-2023, Esoteric Software LLC
  6. *
  7. * Integration of the Spine Runtimes into software or otherwise creating
  8. * derivative works of the Spine Runtimes is permitted under the terms and
  9. * conditions of Section 2 of the Spine Editor License Agreement:
  10. * http://esotericsoftware.com/spine-editor-license
  11. *
  12. * Otherwise, it is permitted to integrate the Spine Runtimes into software or
  13. * otherwise create derivative works of the Spine Runtimes (collectively,
  14. * "Products"), provided that each user of the Products must obtain their own
  15. * Spine Editor license and redistribution of the Products in any form must
  16. * include this license and copyright notice.
  17. *
  18. * THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
  19. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21. * DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
  22. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
  24. * BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
  25. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE
  27. * SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28. *****************************************************************************/
  29. using System;
  30. using System.Collections.Generic;
  31. using System.IO;
  32. namespace Spine {
  33. /// <summary>
  34. /// Base class for loading skeleton data from a file.
  35. /// <para>
  36. /// See<a href="http://esotericsoftware.com/spine-loading-skeleton-data#JSON-and-binary-data">JSON and binary data</a> in the
  37. /// Spine Runtimes Guide.</para>
  38. /// </summary>
  39. public abstract class SkeletonLoader {
  40. protected readonly AttachmentLoader attachmentLoader;
  41. protected float scale = 1;
  42. /// <summary>Creates a skeleton loader that loads attachments using an <see cref="AtlasAttachmentLoader"/> with the specified atlas.
  43. /// </summary>
  44. public SkeletonLoader (params Atlas[] atlasArray) {
  45. attachmentLoader = new AtlasAttachmentLoader(atlasArray);
  46. }
  47. /// <summary>Creates a skeleton loader that loads attachments using the specified attachment loader.
  48. /// <para>See <a href='http://esotericsoftware.com/spine-loading-skeleton-data#JSON-and-binary-data'>Loading skeleton data</a> in the
  49. /// Spine Runtimes Guide.</para></summary>
  50. public SkeletonLoader (AttachmentLoader attachmentLoader) {
  51. if (attachmentLoader == null) throw new ArgumentNullException("attachmentLoader", "attachmentLoader cannot be null.");
  52. this.attachmentLoader = attachmentLoader;
  53. }
  54. /// <summary>Scales bone positions, image sizes, and translations as they are loaded. This allows different size images to be used at
  55. /// runtime than were used in Spine.
  56. /// <para>
  57. /// See <a href="http://esotericsoftware.com/spine-loading-skeleton-data#Scaling">Scaling</a> in the Spine Runtimes Guide.</para>
  58. /// </summary>
  59. public float Scale {
  60. get { return scale; }
  61. set {
  62. if (scale == 0) throw new ArgumentNullException("scale", "scale cannot be 0.");
  63. this.scale = value;
  64. }
  65. }
  66. public abstract SkeletonData ReadSkeletonData (string path);
  67. }
  68. }