setPose.lua 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. return {
  2. summary = 'Set the pose of the layer.',
  3. description = 'Sets the position and orientation of the layer.',
  4. arguments = {
  5. x = {
  6. type = 'number',
  7. description = 'The x position.'
  8. },
  9. y = {
  10. type = 'number',
  11. description = 'The y position.'
  12. },
  13. z = {
  14. type = 'number',
  15. description = 'The z position.'
  16. },
  17. angle = {
  18. type = 'number',
  19. description = 'The amount of rotation around the axis of rotation, in radians.'
  20. },
  21. ax = {
  22. type = 'number',
  23. description = 'The x component of the axis of rotation.'
  24. },
  25. ay = {
  26. type = 'number',
  27. description = 'The y component of the axis of rotation.'
  28. },
  29. az = {
  30. type = 'number',
  31. description = 'The z component of the axis of rotation.'
  32. },
  33. position = {
  34. type = 'Vec3',
  35. description = 'The position of the layer.'
  36. },
  37. orientation = {
  38. type = 'Quat',
  39. description = 'The orientation of the layer.'
  40. }
  41. },
  42. returns = {},
  43. variants = {
  44. {
  45. arguments = { 'x', 'y', 'z', 'angle', 'ax', 'ay', 'az' },
  46. returns = {}
  47. },
  48. {
  49. arguments = { 'position', 'orientation' },
  50. returns = {}
  51. }
  52. },
  53. notes = 'Units are in meters.',
  54. related = {
  55. 'Layer:getPosition',
  56. 'Layer:setPosition',
  57. 'Layer:getOrientation',
  58. 'Layer:setOrientation'
  59. }
  60. }