setNodeOrientation.lua 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. return {
  2. summary = 'Set or blend the orientation of a node.',
  3. description = [[
  4. Sets or blends the orientation of a node to a new orientation. This sets the local orientation
  5. of the node, relative to its parent.
  6. ]],
  7. arguments = {
  8. index = {
  9. type = 'number',
  10. description = 'The index of the node.'
  11. },
  12. name = {
  13. type = 'string',
  14. description = 'The name of the node.'
  15. },
  16. angle = {
  17. type = 'number',
  18. description = 'The number of radians the node should be rotated around its rotation axis.'
  19. },
  20. ax = {
  21. type = 'number',
  22. description = 'The x component of the axis of rotation.'
  23. },
  24. ay = {
  25. type = 'number',
  26. description = 'The y component of the axis of rotation.'
  27. },
  28. az = {
  29. type = 'number',
  30. description = 'The z component of the axis of rotation.'
  31. },
  32. orientation = {
  33. type = 'Quat',
  34. description = 'The orientation.'
  35. },
  36. blend = {
  37. type = 'number',
  38. default = '1.0',
  39. description = [[
  40. A number from 0 to 1 indicating how much of the target orientation to blend in. A value of
  41. 0 will not change the node's orientation at all, whereas 1 will fully blend to the target
  42. orientation.
  43. ]]
  44. }
  45. },
  46. returns = {},
  47. variants = {
  48. {
  49. arguments = { 'index', 'angle', 'ax', 'ay', 'az', 'blend' },
  50. returns = {}
  51. },
  52. {
  53. arguments = { 'name', 'angle', 'ax', 'ay', 'az', 'blend' },
  54. returns = {}
  55. },
  56. {
  57. arguments = { 'index', 'orientation', 'blend' },
  58. returns = {}
  59. },
  60. {
  61. arguments = { 'name', 'orientation', 'blend' },
  62. returns = {}
  63. }
  64. },
  65. related = {
  66. 'Model:getNodePosition',
  67. 'Model:setNodePosition',
  68. 'Model:getNodeScale',
  69. 'Model:setNodeScale',
  70. 'Model:getNodePose',
  71. 'Model:setNodePose',
  72. 'Model:getNodeTransform',
  73. 'Model:setNodeTransform',
  74. 'Model:animate'
  75. }
  76. }