summaryrefslogtreecommitdiff
path: root/doc/classes/Mesh.xml
blob: 733f76728c42b72785d3e3d5af6e35fa0d735f7e (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Mesh" inherits="Resource" category="Core" version="3.0-alpha">
	<brief_description>
		A [Resource] that contains vertex-array based geometry.
	</brief_description>
	<description>
		Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="create_convex_shape" qualifiers="const">
			<return type="Shape">
			</return>
			<description>
				Calculate a [ConvexPolygonShape] from the mesh.
			</description>
		</method>
		<method name="create_outline" qualifiers="const">
			<return type="Mesh">
			</return>
			<argument index="0" name="margin" type="float">
			</argument>
			<description>
				Calculate an outline mesh at a defined offset (margin) from the original mesh. Note: Typically returns the vertices in reverse order (e.g. clockwise to anti-clockwise).
			</description>
		</method>
		<method name="create_trimesh_shape" qualifiers="const">
			<return type="Shape">
			</return>
			<description>
				Calculate a [ConcavePolygonShape] from the mesh.
			</description>
		</method>
		<method name="generate_triangle_mesh" qualifiers="const">
			<return type="TriangleMesh">
			</return>
			<description>
				Generate a [TriangleMesh] from the mesh.
			</description>
		</method>
		<method name="get_faces" qualifiers="const">
			<return type="PoolVector3Array">
			</return>
			<description>
				Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.
			</description>
		</method>
	</methods>
	<constants>
		<constant name="PRIMITIVE_POINTS" value="0">
			Render array as points (one vertex equals one point).
		</constant>
		<constant name="PRIMITIVE_LINES" value="1">
			Render array as lines (every two vertices a line is created).
		</constant>
		<constant name="PRIMITIVE_LINE_STRIP" value="2">
			Render array as line strip.
		</constant>
		<constant name="PRIMITIVE_LINE_LOOP" value="3">
			Render array as line loop (like line strip, but closed).
		</constant>
		<constant name="PRIMITIVE_TRIANGLES" value="4">
			Render array as triangles (every three vertices a triangle is created).
		</constant>
		<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5">
			Render array as triangle strips.
		</constant>
		<constant name="PRIMITIVE_TRIANGLE_FAN" value="6">
			Render array as triangle fans.
		</constant>
		<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0">
		</constant>
		<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1">
		</constant>
		<constant name="ARRAY_FORMAT_VERTEX" value="1">
		</constant>
		<constant name="ARRAY_FORMAT_NORMAL" value="2">
		</constant>
		<constant name="ARRAY_FORMAT_TANGENT" value="4">
		</constant>
		<constant name="ARRAY_FORMAT_COLOR" value="8">
		</constant>
		<constant name="ARRAY_FORMAT_TEX_UV" value="16">
		</constant>
		<constant name="ARRAY_FORMAT_TEX_UV2" value="32">
		</constant>
		<constant name="ARRAY_FORMAT_BONES" value="64">
		</constant>
		<constant name="ARRAY_FORMAT_WEIGHTS" value="128">
		</constant>
		<constant name="ARRAY_FORMAT_INDEX" value="256">
		</constant>
		<constant name="ARRAY_COMPRESS_BASE" value="9">
		</constant>
		<constant name="ARRAY_COMPRESS_VERTEX" value="512">
		</constant>
		<constant name="ARRAY_COMPRESS_NORMAL" value="1024">
		</constant>
		<constant name="ARRAY_COMPRESS_TANGENT" value="2048">
		</constant>
		<constant name="ARRAY_COMPRESS_COLOR" value="4096">
		</constant>
		<constant name="ARRAY_COMPRESS_TEX_UV" value="8192">
		</constant>
		<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384">
		</constant>
		<constant name="ARRAY_COMPRESS_BONES" value="32768">
		</constant>
		<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536">
		</constant>
		<constant name="ARRAY_COMPRESS_INDEX" value="131072">
		</constant>
		<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144">
		</constant>
		<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288">
		</constant>
		<constant name="ARRAY_COMPRESS_DEFAULT" value="97792">
		</constant>
		<constant name="ARRAY_VERTEX" value="0">
		</constant>
		<constant name="ARRAY_NORMAL" value="1">
		</constant>
		<constant name="ARRAY_TANGENT" value="2">
		</constant>
		<constant name="ARRAY_COLOR" value="3">
		</constant>
		<constant name="ARRAY_TEX_UV" value="4">
		</constant>
		<constant name="ARRAY_TEX_UV2" value="5">
		</constant>
		<constant name="ARRAY_BONES" value="6">
		</constant>
		<constant name="ARRAY_WEIGHTS" value="7">
		</constant>
		<constant name="ARRAY_INDEX" value="8">
		</constant>
		<constant name="ARRAY_MAX" value="9">
		</constant>
	</constants>
</class>