summaryrefslogtreecommitdiff
path: root/doc/classes/VisualScriptMathConstant.xml
blob: c753c1621856ec5336606b3c3a4b234082521bac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Commonly used mathematical constants.
	</brief_description>
	<description>
		Provides common math constants, such as Pi or Euler's constant, on an output Data port.
		[b]Input Ports:[/b]
		none
		[b]Output Ports:[/b]
		- Data (variant): [code]get[/code]
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_math_constant">
			<return type="int" enum="VisualScriptMathConstant.MathConstant">
			</return>
			<description>
			</description>
		</method>
		<method name="set_math_constant">
			<return type="void">
			</return>
			<argument index="0" name="which" type="int" enum="VisualScriptMathConstant.MathConstant">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant">
			The math constant.
		</member>
	</members>
	<constants>
		<constant name="MATH_CONSTANT_ONE" value="0">
			Unity: [code]1[/code]
		</constant>
		<constant name="MATH_CONSTANT_PI" value="1">
			Pi: [code]3.141593[/code]
		</constant>
		<constant name="MATH_CONSTANT_HALF_PI" value="2">
			Pi divided by two: [code]1.570796[/code]
		</constant>
		<constant name="MATH_CONSTANT_TAU" value="3">
			Tau: [code]6.283185[/code]
		</constant>
		<constant name="MATH_CONSTANT_E" value="4">
			Natural log: [code]2.718282[/code]
		</constant>
		<constant name="MATH_CONSTANT_SQRT2" value="5">
			Square root of two: [code]1.414214[/code]
		</constant>
		<constant name="MATH_CONSTANT_INF" value="6">
			Infinity: [code]inf[/code]
		</constant>
		<constant name="MATH_CONSTANT_NAN" value="7">
			Not a number: [code]nan[/code]
		</constant>
		<constant name="MATH_CONSTANT_MAX" value="8">
		</constant>
	</constants>
</class>