e19f2b4e18caa1c6ca929f001b10cbc699e97b2e
[blender.git] / release / scripts / op / 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 compliant>
20 import bpy
21 import mathutils
22 from math import cos, sin, pi
23
24
25 def add_torus(major_rad, minor_rad, major_seg, minor_seg):
26     Vector = mathutils.Vector
27     Quaternion = mathutils.Quaternion
28
29     PI_2 = pi * 2
30     z_axis = (0, 0, 1)
31
32     verts = []
33     faces = []
34     i1 = 0
35     tot_verts = major_seg * minor_seg
36     for major_index in range(major_seg):
37         quat = Quaternion(z_axis, (major_index / major_seg) * PI_2)
38
39         for minor_index in range(minor_seg):
40             angle = 2 * pi * minor_index / minor_seg
41
42             vec = Vector((major_rad + (cos(angle) * minor_rad), 0.0,
43                         (sin(angle) * minor_rad))) * quat
44
45             verts.extend(vec[:])
46
47             if minor_index + 1 == minor_seg:
48                 i2 = (major_index) * minor_seg
49                 i3 = i1 + minor_seg
50                 i4 = i2 + minor_seg
51
52             else:
53                 i2 = i1 + 1
54                 i3 = i1 + minor_seg
55                 i4 = i3 + 1
56
57             if i2 >= tot_verts:
58                 i2 = i2 - tot_verts
59             if i3 >= tot_verts:
60                 i3 = i3 - tot_verts
61             if i4 >= tot_verts:
62                 i4 = i4 - tot_verts
63
64             # stupid eekadoodle
65             if i2:
66                 faces.extend([i1, i3, i4, i2])
67             else:
68                 faces.extend([i2, i1, i3, i4])
69
70             i1 += 1
71
72     return verts, faces
73
74 from bpy.props import *
75
76
77 class AddTorus(bpy.types.Operator):
78     '''Add a torus mesh'''
79     bl_idname = "mesh.primitive_torus_add"
80     bl_label = "Add Torus"
81     bl_options = {'REGISTER', 'UNDO'}
82
83     major_radius = FloatProperty(name="Major Radius",
84             description="Radius from the origin to the center of the cross sections",
85             default=1.0, min=0.01, max=100.0)
86     minor_radius = FloatProperty(name="Minor Radius",
87             description="Radius of the torus' cross section",
88             default=0.25, min=0.01, max=100.0)
89     major_segments = IntProperty(name="Major Segments",
90             description="Number of segments for the main ring of the torus",
91             default=48, min=3, max=256)
92     minor_segments = IntProperty(name="Minor Segments",
93             description="Number of segments for the minor ring of the torus",
94             default=12, min=3, max=256)
95     use_abso = BoolProperty(name="Use Int+Ext Controls",
96             description="Use the Int / Ext controls for torus dimensions",
97             default=False)
98     abso_major_rad = FloatProperty(name="Exterior Radius",
99             description="Total Exterior Radius of the torus",
100             default=1.0, min=0.01, max=100.0)
101     abso_minor_rad = FloatProperty(name="Inside Radius",
102             description="Total Interior Radius of the torus",
103             default=0.5, min=0.01, max=100.0)
104
105     # generic transform props
106     location = FloatVectorProperty(name="Location")
107     rotation = FloatVectorProperty(name="Rotation")
108
109     def execute(self, context):
110         props = self.properties
111
112         if props.use_abso == True:
113             extra_helper = (props.abso_major_rad - props.abso_minor_rad) * 0.5
114             props.major_radius = props.abso_minor_rad + extra_helper
115             props.minor_radius = extra_helper
116
117         verts_loc, faces = add_torus(props.major_radius,
118                                     props.minor_radius,
119                                     props.major_segments,
120                                     props.minor_segments)
121
122         mesh = bpy.data.meshes.new("Torus")
123
124         mesh.add_geometry(int(len(verts_loc) / 3), 0, int(len(faces) / 4))
125         mesh.vertices.foreach_set("co", verts_loc)
126         mesh.faces.foreach_set("vertices_raw", faces)
127         mesh.update()
128
129         import add_object_utils
130         add_object_utils.add_object_data(context, mesh, operator=self)
131
132         return {'FINISHED'}
133
134
135 def menu_func(self, context):
136     self.layout.operator(AddTorus.bl_idname, text="Torus", icon='MESH_DONUT')
137
138
139 def register():
140     bpy.types.INFO_MT_mesh_add.append(menu_func)
141
142
143 def unregister():
144     bpy.types.INFO_MT_mesh_add.remove(menu_func)
145
146 if __name__ == "__main__":
147     register()