Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_animationnodesub2.rst

class_animationnodesub2.rst 2.7 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeSub2.xml.
    7. 

  7. 

  8. .. _class_AnimationNodeSub2:
    9. 

  9. 

  10. AnimationNodeSub2
    11. 

  11. =================
    12. 

  12. 

  13. **Inherits:** :ref:`AnimationNodeSync<class_AnimationNodeSync>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Blends two animations subtractively inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations subtractively based on the amount value.
    23. 

  23. 

  24. This animation node is usually used for pre-calculation to cancel out any extra poses from the animation for the "add" animation source in :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>` or :ref:`AnimationNodeAdd3<class_AnimationNodeAdd3>`.
    25. 

  25. 

  26. In general, the blend value should be in the ``[0.0, 1.0]`` range, but values outside of this range can be used for amplified or inverted animations.
    27. 

  27. 

  28. \ **Note:** This calculation is different from using a negative value in :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>`, since the transformation matrices do not satisfy the commutative law. **AnimationNodeSub2** multiplies the transformation matrix of the inverted animation from the left side, while negative :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>` multiplies it from the right side.
    29. 

  29. 

  30. .. rst-class:: classref-introduction-group
    31. 

  31. 

  32. Tutorials
    33. 

  33. ---------
    34. 

  34. 

  35. - :doc:`AnimationTree <../tutorials/animation/animation_tree>`
    36. 

  36. 

  37. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    38. 

  38. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    39. 

  39. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    40. 

  40. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    41. 

  41. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    42. 

  42. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    43. 

  43. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    44. 

  44. .. |void| replace:: :abbr:`void (No return value.)`
    45. 

  45.