VisualScriptMathConstant.xml 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptMathConstant" inherits="VisualScriptNode" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. Commonly used mathematical constants.
  5. </brief_description>
  6. <description>
  7. Provides common math constants, such as Pi, on an output Data port.
  8. [b]Input Ports:[/b]
  9. none
  10. [b]Output Ports:[/b]
  11. - Data (variant): [code]get[/code]
  12. </description>
  13. <tutorials>
  14. </tutorials>
  15. <methods>
  16. </methods>
  17. <members>
  18. <member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant" default="0">
  19. The math constant.
  20. </member>
  21. </members>
  22. <constants>
  23. <constant name="MATH_CONSTANT_ONE" value="0" enum="MathConstant">
  24. Unity: [code]1[/code].
  25. </constant>
  26. <constant name="MATH_CONSTANT_PI" value="1" enum="MathConstant">
  27. Pi: [code]3.141593[/code].
  28. </constant>
  29. <constant name="MATH_CONSTANT_HALF_PI" value="2" enum="MathConstant">
  30. Pi divided by two: [code]1.570796[/code].
  31. </constant>
  32. <constant name="MATH_CONSTANT_TAU" value="3" enum="MathConstant">
  33. Tau: [code]6.283185[/code].
  34. </constant>
  35. <constant name="MATH_CONSTANT_E" value="4" enum="MathConstant">
  36. Mathematical constant [code]e[/code], the natural log base: [code]2.718282[/code].
  37. </constant>
  38. <constant name="MATH_CONSTANT_SQRT2" value="5" enum="MathConstant">
  39. Square root of two: [code]1.414214[/code].
  40. </constant>
  41. <constant name="MATH_CONSTANT_INF" value="6" enum="MathConstant">
  42. Infinity: [code]inf[/code].
  43. </constant>
  44. <constant name="MATH_CONSTANT_NAN" value="7" enum="MathConstant">
  45. Not a number: [code]nan[/code].
  46. </constant>
  47. <constant name="MATH_CONSTANT_MAX" value="8" enum="MathConstant">
  48. Represents the size of the [enum MathConstant] enum.
  49. </constant>
  50. </constants>
  51. </class>