Merged revision(s) 57423-57498 from trunk/blender into soc-2013-dingto
[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 (FloatProperty,
24                        IntProperty,
25                        BoolProperty,
26                        )
27 from bpy.app.translations import pgettext_data as data_
28
29 from bpy_extras import object_utils
30
31
32 def add_torus(major_rad, minor_rad, major_seg, minor_seg):
33     from math import cos, sin, pi
34     from mathutils import Vector, Quaternion
35
36     PI_2 = pi * 2.0
37     z_axis = 0.0, 0.0, 1.0
38
39     verts = []
40     faces = []
41     i1 = 0
42     tot_verts = major_seg * minor_seg
43     for major_index in range(major_seg):
44         quat = Quaternion(z_axis, (major_index / major_seg) * PI_2)
45
46         for minor_index in range(minor_seg):
47             angle = 2 * pi * minor_index / minor_seg
48
49             vec = quat * Vector((major_rad + (cos(angle) * minor_rad),
50                                  0.0,
51                                  (sin(angle) * minor_rad),
52                                  ))
53
54             verts.extend(vec[:])
55
56             if minor_index + 1 == minor_seg:
57                 i2 = (major_index) * minor_seg
58                 i3 = i1 + minor_seg
59                 i4 = i2 + minor_seg
60
61             else:
62                 i2 = i1 + 1
63                 i3 = i1 + minor_seg
64                 i4 = i3 + 1
65
66             if i2 >= tot_verts:
67                 i2 = i2 - tot_verts
68             if i3 >= tot_verts:
69                 i3 = i3 - tot_verts
70             if i4 >= tot_verts:
71                 i4 = i4 - tot_verts
72
73             # stupid eekadoodle
74             if i2:
75                 faces.extend([i1, i3, i4, i2])
76             else:
77                 faces.extend([i2, i1, i3, i4])
78
79             i1 += 1
80
81     return verts, faces
82
83
84 class AddTorus(Operator, object_utils.AddObjectHelper):
85     """Add a torus mesh"""
86     bl_idname = "mesh.primitive_torus_add"
87     bl_label = "Add Torus"
88     bl_options = {'REGISTER', 'UNDO', 'PRESET'}
89
90     major_radius = FloatProperty(
91             name="Major Radius",
92             description=("Radius from the origin to the "
93                          "center of the cross sections"),
94             min=0.01, max=100.0,
95             default=1.0,
96             subtype='DISTANCE',
97             unit='LENGTH',
98             )
99     minor_radius = FloatProperty(
100             name="Minor Radius",
101             description="Radius of the torus' cross section",
102             min=0.01, max=100.0,
103             default=0.25,
104             subtype='DISTANCE',
105             unit='LENGTH',
106             )
107     major_segments = IntProperty(
108             name="Major Segments",
109             description="Number of segments for the main ring of the torus",
110             min=3, max=256,
111             default=48,
112             )
113     minor_segments = IntProperty(
114             name="Minor Segments",
115             description="Number of segments for the minor ring of the torus",
116             min=3, max=256,
117             default=12,
118             )
119     use_abso = BoolProperty(
120             name="Use Int+Ext Controls",
121             description="Use the Int / Ext controls for torus dimensions",
122             default=False,
123             )
124     abso_major_rad = FloatProperty(
125             name="Exterior Radius",
126             description="Total Exterior Radius of the torus",
127             min=0.01, max=100.0,
128             default=1.0,
129             subtype='DISTANCE',
130             unit='LENGTH',
131             )
132     abso_minor_rad = FloatProperty(
133             name="Inside Radius",
134             description="Total Interior Radius of the torus",
135             min=0.01, max=100.0,
136             default=0.5,
137             subtype='DISTANCE',
138             unit='LENGTH',
139             )
140
141     def invoke(self, context, event):
142         object_utils.object_add_grid_scale_apply_operator(self, context)
143         return self.execute(context)
144
145     def execute(self, context):
146
147         if self.use_abso is True:
148             extra_helper = (self.abso_major_rad - self.abso_minor_rad) * 0.5
149             self.major_radius = self.abso_minor_rad + extra_helper
150             self.minor_radius = extra_helper
151
152         verts_loc, faces = add_torus(self.major_radius,
153                                      self.minor_radius,
154                                      self.major_segments,
155                                      self.minor_segments)
156
157         mesh = bpy.data.meshes.new(data_("Torus"))
158
159         mesh.vertices.add(len(verts_loc) // 3)
160
161         nbr_loops = len(faces)
162         nbr_polys = nbr_loops // 4
163         mesh.loops.add(nbr_loops)
164         mesh.polygons.add(nbr_polys)
165
166         mesh.vertices.foreach_set("co", verts_loc)
167         mesh.polygons.foreach_set("loop_start", range(0, nbr_loops, 4))
168         mesh.polygons.foreach_set("loop_total", (4,) * nbr_polys)
169         mesh.loops.foreach_set("vertex_index", faces)
170         mesh.update()
171
172         object_utils.object_data_add(context, mesh, operator=self)
173
174         return {'FINISHED'}