IkConstraintData.cs 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /******************************************************************************
  2. * Spine Runtimes License Agreement
  3. * Last updated January 1, 2020. Replaces all prior versions.
  4. *
  5. * Copyright (c) 2013-2020, 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
  13. * or 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
  27. * THE SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28. *****************************************************************************/
  29. using System;
  30. using System.Collections.Generic;
  31. namespace Spine {
  32. /// <summary>Stores the setup pose for an IkConstraint.</summary>
  33. public class IkConstraintData : ConstraintData {
  34. internal ExposedList<BoneData> bones = new ExposedList<BoneData>();
  35. internal BoneData target;
  36. internal int bendDirection = 1;
  37. internal bool compress, stretch, uniform;
  38. internal float mix = 1, softness;
  39. public IkConstraintData (string name) : base(name) {
  40. }
  41. /// <summary>The bones that are constrained by this IK Constraint.</summary>
  42. public ExposedList<BoneData> Bones {
  43. get { return bones; }
  44. }
  45. /// <summary>The bone that is the IK target.</summary>
  46. public BoneData Target {
  47. get { return target; }
  48. set { target = value; }
  49. }
  50. /// <summary>
  51. /// A percentage (0-1) that controls the mix between the constraint and unconstrained rotations.</summary>
  52. public float Mix {
  53. get { return mix; }
  54. set { mix = value; }
  55. }
  56. ///<summary>For two bone IK, the distance from the maximum reach of the bones that rotation will slow.</summary>
  57. public float Softness {
  58. get { return softness; }
  59. set { softness = value; }
  60. }
  61. /// <summary>Controls the bend direction of the IK bones, either 1 or -1.</summary>
  62. public int BendDirection {
  63. get { return bendDirection; }
  64. set { bendDirection = value; }
  65. }
  66. /// <summary>
  67. /// When true, and only a single bone is being constrained,
  68. /// if the target is too close, the bone is scaled to reach it. </summary>
  69. public bool Compress {
  70. get { return compress; }
  71. set { compress = value; }
  72. }
  73. /// <summary>
  74. /// When true, if the target is out of range, the parent bone is scaled on the X axis to reach it.
  75. /// If the bone has local nonuniform scale, stretching is not applied.</summary>
  76. public bool Stretch {
  77. get { return stretch; }
  78. set { stretch = value; }
  79. }
  80. /// <summary>
  81. /// When true, only a single bone is being constrained and Compress or Stretch is used,
  82. /// the bone is scaled both on the X and Y axes.</summary>
  83. public bool Uniform {
  84. get { return uniform; }
  85. set { uniform = value; }
  86. }
  87. }
  88. }