CMake: add WITH_LINKER_LLD option for unix platforms
[blender-staging.git] / release / scripts / startup / bl_operators / add_mesh_torus.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8-80 compliant>
20 import bpy
21 from bpy.types import Operator
22
23 from bpy.props import (
24     BoolProperty,
25     EnumProperty,
26     FloatProperty,
27     IntProperty,
28 )
29 from bpy.app.translations import pgettext_data as data_
30
31 from bpy_extras import object_utils
32
33
34 def add_torus(major_rad, minor_rad, major_seg, minor_seg):
35     from math import cos, sin, pi
36     from mathutils import Vector, Matrix
37
38     pi_2 = pi * 2.0
39
40     verts = []
41     faces = []
42     i1 = 0
43     tot_verts = major_seg * minor_seg
44     for major_index in range(major_seg):
45         matrix = Matrix.Rotation((major_index / major_seg) * pi_2, 3, 'Z')
46
47         for minor_index in range(minor_seg):
48             angle = pi_2 * minor_index / minor_seg
49
50             vec = matrix @ Vector((
51                 major_rad + (cos(angle) * minor_rad),
52                 0.0,
53                 sin(angle) * minor_rad,
54             ))
55
56             verts.extend(vec[:])
57
58             if minor_index + 1 == minor_seg:
59                 i2 = (major_index) * minor_seg
60                 i3 = i1 + minor_seg
61                 i4 = i2 + minor_seg
62             else:
63                 i2 = i1 + 1
64                 i3 = i1 + minor_seg
65                 i4 = i3 + 1
66
67             if i2 >= tot_verts:
68                 i2 = i2 - tot_verts
69             if i3 >= tot_verts:
70                 i3 = i3 - tot_verts
71             if i4 >= tot_verts:
72                 i4 = i4 - tot_verts
73
74             faces.extend([i1, i3, i4, i2])
75
76             i1 += 1
77
78     return verts, faces
79
80
81 def add_uvs(mesh, minor_seg, major_seg):
82     from math import fmod
83
84     mesh.uv_layers.new()
85     uv_data = mesh.uv_layers.active.data
86     polygons = mesh.polygons
87     u_step = 1.0 / major_seg
88     v_step = 1.0 / minor_seg
89
90     # Round UV's, needed when segments aren't divisible by 4.
91     u_init = 0.5 + fmod(0.5, u_step)
92     v_init = 0.5 + fmod(0.5, v_step)
93
94     # Calculate wrapping value under 1.0 to prevent
95     # float precision errors wrapping at the wrong step.
96     u_wrap = 1.0 - (u_step / 2.0)
97     v_wrap = 1.0 - (v_step / 2.0)
98
99     vertex_index = 0
100
101     u_prev = u_init
102     u_next = u_prev + u_step
103     for _major_index in range(major_seg):
104         v_prev = v_init
105         v_next = v_prev + v_step
106         for _minor_index in range(minor_seg):
107             loops = polygons[vertex_index].loop_indices
108             uv_data[loops[0]].uv = u_prev, v_prev
109             uv_data[loops[1]].uv = u_next, v_prev
110             uv_data[loops[3]].uv = u_prev, v_next
111             uv_data[loops[2]].uv = u_next, v_next
112
113             if v_next > v_wrap:
114                 v_prev = v_next - 1.0
115             else:
116                 v_prev = v_next
117             v_next = v_prev + v_step
118
119             vertex_index += 1
120
121         if u_next > u_wrap:
122             u_prev = u_next - 1.0
123         else:
124             u_prev = u_next
125         u_next = u_prev + u_step
126
127
128 class AddTorus(Operator, object_utils.AddObjectHelper):
129     """Construct a torus mesh"""
130     bl_idname = "mesh.primitive_torus_add"
131     bl_label = "Add Torus"
132     bl_options = {'REGISTER', 'UNDO', 'PRESET'}
133
134     def mode_update_callback(self, _context):
135         if self.mode == 'EXT_INT':
136             self.abso_major_rad = self.major_radius + self.minor_radius
137             self.abso_minor_rad = self.major_radius - self.minor_radius
138
139     major_segments: IntProperty(
140         name="Major Segments",
141         description="Number of segments for the main ring of the torus",
142         min=3, max=256,
143         default=48,
144     )
145     minor_segments: IntProperty(
146         name="Minor Segments",
147         description="Number of segments for the minor ring of the torus",
148         min=3, max=256,
149         default=12,
150     )
151     mode: EnumProperty(
152         name="Torus Dimensions",
153         items=(
154             ('MAJOR_MINOR', "Major/Minor",
155              "Use the major/minor radii for torus dimensions"),
156             ('EXT_INT', "Exterior/Interior",
157              "Use the exterior/interior radii for torus dimensions"),
158         ),
159         update=mode_update_callback,
160     )
161     major_radius: FloatProperty(
162         name="Major Radius",
163         description=("Radius from the origin to the "
164                      "center of the cross sections"),
165         soft_min=0.0, soft_max=100.0,
166         min=0.0, max=10_000.0,
167         default=1.0,
168         subtype='DISTANCE',
169         unit='LENGTH',
170     )
171     minor_radius: FloatProperty(
172         name="Minor Radius",
173         description="Radius of the torus' cross section",
174         soft_min=0.0, soft_max=100.0,
175         min=0.0, max=10_000.0,
176         default=0.25,
177         subtype='DISTANCE',
178         unit='LENGTH',
179     )
180     abso_major_rad: FloatProperty(
181         name="Exterior Radius",
182         description="Total Exterior Radius of the torus",
183         soft_min=0.0, soft_max=100.0,
184         min=0.0, max=10_000.0,
185         default=1.25,
186         subtype='DISTANCE',
187         unit='LENGTH',
188     )
189     abso_minor_rad: FloatProperty(
190         name="Interior Radius",
191         description="Total Interior Radius of the torus",
192         soft_min=0.0, soft_max=100.0,
193         min=0.0, max=10_000.0,
194         default=0.75,
195         subtype='DISTANCE',
196         unit='LENGTH',
197     )
198     generate_uvs: BoolProperty(
199         name="Generate UVs",
200         description="Generate a default UV map",
201         default=True,
202     )
203
204     def draw(self, _context):
205         layout = self.layout
206
207         col = layout.column(align=True)
208         col.prop(self, "generate_uvs")
209         col.separator()
210         col.prop(self, "align")
211
212         col = layout.column(align=True)
213         col.label(text="Location")
214         col.prop(self, "location", text="")
215
216         col = layout.column(align=True)
217         col.label(text="Rotation")
218         col.prop(self, "rotation", text="")
219
220         col = layout.column(align=True)
221         col.label(text="Major Segments")
222         col.prop(self, "major_segments", text="")
223
224         col = layout.column(align=True)
225         col.label(text="Minor Segments")
226         col.prop(self, "minor_segments", text="")
227
228         col = layout.column(align=True)
229         col.label(text="Torus Dimensions")
230         col.row().prop(self, "mode", expand=True)
231
232         if self.mode == 'MAJOR_MINOR':
233             col = layout.column(align=True)
234             col.label(text="Major Radius")
235             col.prop(self, "major_radius", text="")
236
237             col = layout.column(align=True)
238             col.label(text="Minor Radius")
239             col.prop(self, "minor_radius", text="")
240         else:
241             col = layout.column(align=True)
242             col.label(text="Exterior Radius")
243             col.prop(self, "abso_major_rad", text="")
244
245             col = layout.column(align=True)
246             col.label(text="Interior Radius")
247             col.prop(self, "abso_minor_rad", text="")
248
249     def invoke(self, context, _event):
250         object_utils.object_add_grid_scale_apply_operator(self, context)
251         return self.execute(context)
252
253     def execute(self, context):
254
255         if self.mode == 'EXT_INT':
256             extra_helper = (self.abso_major_rad - self.abso_minor_rad) * 0.5
257             self.major_radius = self.abso_minor_rad + extra_helper
258             self.minor_radius = extra_helper
259
260         verts_loc, faces = add_torus(
261             self.major_radius,
262             self.minor_radius,
263             self.major_segments,
264             self.minor_segments,
265         )
266
267         mesh = bpy.data.meshes.new(data_("Torus"))
268
269         mesh.vertices.add(len(verts_loc) // 3)
270
271         nbr_loops = len(faces)
272         nbr_polys = nbr_loops // 4
273         mesh.loops.add(nbr_loops)
274         mesh.polygons.add(nbr_polys)
275
276         mesh.vertices.foreach_set("co", verts_loc)
277         mesh.polygons.foreach_set("loop_start", range(0, nbr_loops, 4))
278         mesh.polygons.foreach_set("loop_total", (4,) * nbr_polys)
279         mesh.loops.foreach_set("vertex_index", faces)
280
281         if self.generate_uvs:
282             add_uvs(mesh, self.minor_segments, self.major_segments)
283
284         mesh.update()
285
286         object_utils.object_data_add(context, mesh, operator=self)
287
288         return {'FINISHED'}
289
290
291 classes = (
292     AddTorus,
293 )