-
Notifications
You must be signed in to change notification settings - Fork 2
/
add_curve_torus_knots.py
688 lines (573 loc) · 22.9 KB
/
add_curve_torus_knots.py
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
# ##### BEGIN GPL LICENSE BLOCK #####
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####
'''
bl_info = {
"name": "Torus Knots",
"author": "Marius Giurgi (DolphinDream), testscreenings",
"version": (0, 2),
"blender": (2, 76, 0),
"location": "View3D > Add > Curve",
"description": "Adds many types of (torus) knots",
"warning": "",
"wiki_url": "http://wiki.blender.org/index.php/Extensions:2.6/Py/"
"Scripts/Curve/Torus_Knot",
"category": "Add Curve"}
'''
# ------------------------------------------------------------------------------
#### import modules
import bpy
from bpy.props import BoolProperty, EnumProperty, FloatProperty, IntProperty
from math import sin, cos, pi, sqrt
from mathutils import *
from bpy_extras.object_utils import AddObjectHelper, object_data_add
from random import random
DEBUG = False
# greatest common denominator
def gcd(a, b):
if b == 0:
return a
else:
return gcd(b, a % b)
########################################################################
####################### Knot Definitions ###############################
########################################################################
def Torus_Knot(self, linkIndex=0):
p = self.torus_p # revolution count (around the torus center)
q = self.torus_q # spin count (around the torus tube)
N = self.torus_res # curve resolution (number of control points)
# use plus options only when they are enabled
if self.options_plus:
u = self.torus_u # p multiplier
v = self.torus_v # q multiplier
h = self.torus_h # height (scale along Z)
s = self.torus_s # torus scale (radii scale factor)
else: # don't use plus settings
u = 1
v = 1
h = 1
s = 1
R = self.torus_R * s # major radius (scaled)
r = self.torus_r * s # minor radius (scaled)
# number of decoupled links when (p,q) are NOT co-primes
links = gcd(p,q) # = 1 when (p,q) are co-primes
# parametrized angle increment (cached outside of the loop for performance)
# NOTE: the total angle is divided by number of decoupled links to ensure
# the curve does not overlap with itself when (p,q) are not co-primes
da = 2*pi/links/(N-1)
# link phase : each decoupled link is phased equally around the torus center
# NOTE: linkIndex value is in [0, links-1]
linkPhase = 2*pi/q * linkIndex # = 0 when there is just ONE link
# user defined phasing
if self.options_plus:
rPhase = self.torus_rP # user defined revolution phase
sPhase = self.torus_sP # user defined spin phase
else: # don't use plus settings
rPhase = 0
sPhase = 0
rPhase += linkPhase # total revolution phase of the current link
if DEBUG:
print("")
print("Link: %i of %i" % (linkIndex, links))
print("gcd = %i" % links)
print("p = %i" % p)
print("q = %i" % q)
print("link phase = %.2f deg" % (linkPhase * 180/pi))
print("link phase = %.2f rad" % linkPhase)
# flip directions ? NOTE: flipping both is equivalent to no flip
if self.flip_p: p*=-1
if self.flip_q: q*=-1
# create the 3D point array for the current link
newPoints = []
for n in range(N-1):
# t = 2*pi / links * n/(N-1) with: da = 2*pi/links/(N-1) => t = n * da
t = n * da
theta = p*t*u + rPhase # revolution angle
phi = q*t*v + sPhase # spin angle
x = (R + r*cos(phi)) * cos(theta)
y = (R + r*cos(phi)) * sin(theta)
z = r*sin(phi) * h
# append 3D point
# NOTE : the array is adjusted later as needed to 4D for POLY and NURBS
newPoints.append([x,y,z])
return newPoints
# ------------------------------------------------------------------------------
# Calculate the align matrix for the new object (based on user preferences)
def align_matrix(self, context):
if self.absolute_location:
loc = Matrix.Translation(Vector((0,0,0)))
else:
loc = Matrix.Translation(context.scene.cursor_location)
# user defined location & translation
userLoc = Matrix.Translation(self.location)
userRot = self.rotation.to_matrix().to_4x4()
obj_align = context.user_preferences.edit.object_align
if (context.space_data.type == 'VIEW_3D' and obj_align == 'VIEW'):
rot = context.space_data.region_3d.view_matrix.to_3x3().inverted().to_4x4()
else:
rot = Matrix()
align_matrix = userLoc * loc * rot * userRot
return align_matrix
# ------------------------------------------------------------------------------
# Set curve BEZIER handles to auto
def setBezierHandles(obj, mode = 'AUTOMATIC'):
scene = bpy.context.scene
if obj.type != 'CURVE':
return
scene.objects.active = obj
bpy.ops.object.mode_set(mode='EDIT', toggle=True)
bpy.ops.curve.select_all(action='SELECT')
bpy.ops.curve.handle_type_set(type=mode)
bpy.ops.object.mode_set(mode='OBJECT', toggle=True)
# ------------------------------------------------------------------------------
# Convert array of vert coordinates to points according to spline type
def vertsToPoints(Verts, splineType):
# main vars
vertArray = []
# array for BEZIER spline output (V3)
if splineType == 'BEZIER':
for v in Verts:
vertArray += v
# array for non-BEZIER output (V4)
else:
for v in Verts:
vertArray += v
if splineType == 'NURBS':
vertArray.append(1) # for NURBS w=1
else: # for POLY w=0
vertArray.append(0)
return vertArray
# ------------------------------------------------------------------------------
# Create the Torus Knot curve and object and add it to the scene
def create_torus_knot(self, context):
# pick a name based on (p,q) parameters
aName = "Torus Knot %i x %i" % (self.torus_p, self.torus_q)
# create curve
curve_data = bpy.data.curves.new(name=aName, type='CURVE')
# setup materials to be used for the TK links
if self.use_colors:
addLinkColors(self, curve_data)
# create torus knot link(s)
if self.multiple_links:
links = gcd(self.torus_p, self.torus_q);
else:
links = 1;
for l in range(links):
# get vertices for the current link
verts = Torus_Knot(self, l)
# output splineType 'POLY' 'NURBS' or 'BEZIER'
splineType = self.outputType
# turn verts into proper array (based on spline type)
vertArray = vertsToPoints(verts, splineType)
# create spline from vertArray (based on spline type)
spline = curve_data.splines.new(type=splineType)
if splineType == 'BEZIER':
spline.bezier_points.add(int(len(vertArray)*1.0/3-1))
spline.bezier_points.foreach_set('co', vertArray)
else:
spline.points.add(int(len(vertArray)*1.0/4 - 1))
spline.points.foreach_set('co', vertArray)
spline.use_endpoint_u = True
# set curve options
spline.use_cyclic_u = True
spline.order_u = 4
# set a color per link
if self.use_colors:
spline.material_index = l
curve_data.dimensions = '3D'
curve_data.resolution_u = self.segment_res
# create surface ?
if self.geo_surface:
curve_data.fill_mode = 'FULL'
curve_data.bevel_depth = self.geo_bDepth
curve_data.bevel_resolution = self.geo_bRes
curve_data.extrude = self.geo_extrude
curve_data.offset = self.geo_offset
new_obj = bpy.data.objects.new(aName, curve_data)
# set object in the scene
scene = bpy.context.scene
scene.objects.link(new_obj) # place in active scene
new_obj.select = True # set as selected
scene.objects.active = new_obj # set as active
new_obj.matrix_world = self.align_matrix # apply matrix
# set BEZIER handles
if splineType == 'BEZIER':
setBezierHandles(new_obj, self.handleType)
return
# ------------------------------------------------------------------------------
# Create materials to be assigned to each TK link
def addLinkColors(self, curveData):
# some predefined colors for the torus knot links
colors = []
if self.colorSet == "1": # RGBish
colors += [ [0.0, 0.0, 1.0] ]
colors += [ [0.0, 1.0, 0.0] ]
colors += [ [1.0, 0.0, 0.0] ]
colors += [ [1.0, 1.0, 0.0] ]
colors += [ [0.0, 1.0, 1.0] ]
colors += [ [1.0, 0.0, 1.0] ]
colors += [ [1.0, 0.5, 0.0] ]
colors += [ [0.0, 1.0, 0.5] ]
colors += [ [0.5, 0.0, 1.0] ]
else: # RainBow
colors += [ [0.0, 0.0, 1.0] ]
colors += [ [0.0, 0.5, 1.0] ]
colors += [ [0.0, 1.0, 1.0] ]
colors += [ [0.0, 1.0, 0.5] ]
colors += [ [0.0, 1.0, 0.0] ]
colors += [ [0.5, 1.0, 0.0] ]
colors += [ [1.0, 1.0, 0.0] ]
colors += [ [1.0, 0.5, 0.0] ]
colors += [ [1.0, 0.0, 0.0] ]
me = curveData
mat_offset = len(me.materials)
links = gcd(self.torus_p, self.torus_q)
mats = []
for i in range(links):
matName = "TorusKnot-Link-%i" % i
matListNames = bpy.data.materials.keys()
# create the material
if matName not in matListNames:
if DEBUG: print("Creating new material : %s" % matName)
mat = bpy.data.materials.new(matName)
else:
if DEBUG: print("Material %s already exists" % matName)
mat = bpy.data.materials[matName]
# set material color
if self.options_plus and self.random_colors:
mat.diffuse_color = random(), random(), random()
else:
cID = i % (len(colors)) # cycle through predefined colors
mat.diffuse_color = colors[cID]
if self.options_plus:
mat.diffuse_color.s = self.saturation
else:
mat.diffuse_color.s = 0.75
me.materials.append(mat)
# ------------------------------------------------------------------------------
# Main Torus Knot class
class torus_knot_plus(bpy.types.Operator, AddObjectHelper):
""""""
bl_idname = "curve.torus_knot_plus"
bl_label = "Torus Knot +"
bl_options = {'REGISTER', 'UNDO', 'PRESET'}
bl_description = "Adds many types of tours knots"
bl_context = "object"
def mode_update_callback(self, context):
# keep the equivalent radii sets (R,r)/(eR,iR) in sync
if self.mode == 'EXT_INT':
self.torus_eR = self.torus_R + self.torus_r
self.torus_iR = self.torus_R - self.torus_r
# align_matrix for the invoke
align_matrix = None
#### GENERAL options
options_plus = BoolProperty(
name="Extra Options",
default=False,
description="Show more options (the plus part).")
absolute_location = BoolProperty(
name= "Absolute Location",
default=False,
description="Set absolute location instead of relative to 3D cursor.")
#### COLOR options
use_colors = BoolProperty(
name="Use Colors",
default=False,
description="Show torus links in colors.")
colorSet = EnumProperty(
name="Color Set",
items= (('1', 'RGBish', 'RGBsish ordered colors'),
('2', 'Rainbow', 'Rainbow ordered colors')))
random_colors = BoolProperty(
name="Randomize Colors",
default=False,
description="Randomize link colors.")
saturation = FloatProperty(
name="Saturation",
default=0.75,
min=0.0, max=1.0,
description="Color saturation.")
#### SURFACE Options
geo_surface = BoolProperty(
name="Surface",
default=True,
description="Create surface.")
geo_bDepth = FloatProperty(
name="Bevel Depth",
default=0.04,
min=0, soft_min=0,
description="Bevel Depth.")
geo_bRes = IntProperty(
name="Bevel Resolution",
default=2,
min=0, soft_min=0,
max=5, soft_max=5,
description="Bevel Resolution.")
geo_extrude = FloatProperty(
name="Extrude",
default=0.0,
min=0, soft_min=0,
description="Amount of curve extrusion.")
geo_offset = FloatProperty(
name="Offset",
default=0.0,
min=0, soft_min=0,
description="Offset the surface relative to the curve.")
#### TORUS KNOT Options
torus_p = IntProperty(
name="p",
default=2,
min=1, soft_min=1,
description="Number of REVOLUTIONs around the torus hole before closing the knot.")
torus_q = IntProperty(
name="q",
default=3,
min=1, soft_min=1,
description="Number of SPINs through the torus hole before closing the knot.")
flip_p = BoolProperty(
name="Flip p",
default=False,
description="Flip REVOLUTION direction.")
flip_q = BoolProperty(
name="Flip q",
default=False,
description="Flip SPIN direction.")
multiple_links = BoolProperty(
name="Multiple Links",
default=True,
description="Generate ALL links or just ONE link when q and q are not co-primes.")
torus_u = IntProperty(
name="p multiplier",
default=1,
min=1, soft_min=1,
description="p multiplier.")
torus_v = IntProperty(
name="q multiplier",
default=1,
min=1, soft_min=1,
description="q multiplier.")
torus_rP = FloatProperty(
name="Revolution Phase",
default=0.0,
min=0.0, soft_min=0.0,
description="Phase revolutions by this radian amount.")
torus_sP = FloatProperty(
name="Spin Phase",
default=0.0,
min=0.0, soft_min=0.0,
description="Phase spins by this radian amount.")
#### TORUS DIMENSIONS options
mode = EnumProperty(
name="Torus Dimensions",
items=(("MAJOR_MINOR", "Major/Minor",
"Use the Major/Minor radii for torus dimensions."),
("EXT_INT", "Exterior/Interior",
"Use the Exterior/Interior radii for torus dimensions.")),
update=mode_update_callback)
torus_R = FloatProperty(
name="Major Radius",
min=0.00, max=100.0,
default=1.0,
subtype='DISTANCE',
unit='LENGTH',
description="Radius from the torus origin to the center of the cross section.")
torus_r = FloatProperty(
name="Minor Radius",
min=0.00, max=100.0,
default=.25,
subtype='DISTANCE',
unit='LENGTH',
description="Radius of the torus' cross section.")
torus_iR = FloatProperty(
name="Interior Radius",
min=0.00, max=100.0,
default=.75,
subtype='DISTANCE',
unit='LENGTH',
description="Interior radius of the torus (closest to the torus center).")
torus_eR = FloatProperty(
name="Exterior Radius",
min=0.00, max=100.0,
default=1.25,
subtype='DISTANCE',
unit='LENGTH',
description="Exterior radius of the torus (farthest from the torus center).")
torus_s = FloatProperty(
name="Scale",
min=0.01, max=100.0,
default=1.00,
description="Scale factor to multiply the radii.")
torus_h = FloatProperty(
name="Height",
default=1.0,
min=0.0, max=100.0,
description="Scale along the local Z axis.")
#### CURVE options
torus_res = IntProperty(
name="Curve Resolution",
default=100,
min=3, soft_min=3,
description="Number of control vertices in the curve.")
segment_res = IntProperty(
name="Segment Resolution",
default=12,
min=1, soft_min=1,
description="Curve subdivisions per segment.")
SplineTypes = [
('POLY', 'Poly', 'POLY'),
('NURBS', 'Nurbs', 'NURBS'),
('BEZIER', 'Bezier', 'BEZIER')]
outputType = EnumProperty(
name="Output splines",
description="Type of splines to output.",
default='BEZIER',
items=SplineTypes)
bezierHandles = [
('VECTOR', 'Vector', 'VECTOR'),
('AUTOMATIC', 'Auto', 'AUTOMATIC')]
handleType = EnumProperty(
name="Handle type",
description="Bezier handle type.",
default='AUTOMATIC',
items=bezierHandles)
adaptive_resolution = BoolProperty(
name="Adaptive Resolution",
default=False,
description="Auto adjust curve resolution based on TK length.")
##### DRAW #####
def draw(self, context):
layout = self.layout
# extra parameters toggle
layout.prop(self, 'options_plus')
# TORUS KNOT Parameters
col = layout.column()
col.label(text="Torus Knot Parameters:")
box = layout.box()
row = box.row()
row.column().prop(self, 'torus_p')
row.column().prop(self, 'flip_p')
row = box.row()
row.column().prop(self, 'torus_q')
row.column().prop(self, 'flip_q')
links = gcd(self.torus_p, self.torus_q)
info = "Multiple Links"
if links > 1: info += " ( " + str(links) + " )"
box.prop(self, 'multiple_links', text=info)
if self.options_plus:
box = box.box()
box.prop(self, 'torus_u')
box.prop(self, 'torus_v')
box.prop(self, 'torus_rP')
box.prop(self, 'torus_sP')
# TORUS DIMENSIONS options
col = layout.column(align=True)
col.label(text="Torus Dimensions:")
box = layout.box()
col = box.column(align=True)
col.row().prop(self, "mode", expand=True)
if self.mode == 'MAJOR_MINOR':
col = box.column(align=True)
col.prop(self, "torus_R")
col = box.column(align=True)
col.prop(self, "torus_r")
else: # EXTERIOR-INTERIOR
col = box.column(align=True)
col.prop(self, "torus_eR")
col = box.column(align=True)
col.prop(self, "torus_iR")
if self.options_plus:
box = box.box()
box.prop(self, 'torus_s')
box.prop(self, 'torus_h')
# CURVE options
col = layout.column(align=True)
col.label(text="Curve Options:")
box = layout.box()
col = box.column()
col.label(text="Output Curve Type:")
col.row().prop(self, 'outputType', expand=True)
depends=box.column()
depends.prop(self, 'torus_res')
# deactivate the "curve resolution" if "adaptive resolution" is enabled
depends.enabled = not self.adaptive_resolution
box.prop(self, 'adaptive_resolution')
box.prop(self, 'segment_res')
# SURFACE options
col = layout.column()
col.label(text="Geometry Options:")
box = layout.box()
box.prop(self, 'geo_surface')
if self.geo_surface:
box.prop(self, 'geo_bDepth')
box.prop(self, 'geo_bRes')
box.prop(self, 'geo_extrude')
box.prop(self, 'geo_offset')
# COLOR options
col = layout.column()
col.label(text="Color Options:")
box = layout.box()
box.prop(self, 'use_colors')
if self.use_colors and self.options_plus:
box = box.box()
box.prop(self, 'colorSet')
box.prop(self, 'random_colors')
box.prop(self, 'saturation')
# TRANSFORM options
col = layout.column()
col.label(text="Transform Options:")
box = col.box()
box.prop(self, 'location')
box.prop(self, 'absolute_location')
box.prop(self, 'rotation')
##### POLL #####
@classmethod
def poll(cls, context):
if context.mode != "OBJECT": return False
return context.scene != None
##### EXECUTE #####
def execute(self, context):
if self.mode == 'EXT_INT':
# adjust the equivalent radii pair : (R,r) <=> (eR,iR)
self.torus_R = (self.torus_eR + self.torus_iR)*0.5
self.torus_r = (self.torus_eR - self.torus_iR)*0.5
if self.adaptive_resolution:
# adjust curve resolution automatically based on (p,q,R,r) values
p = self.torus_p
q = self.torus_q
R = self.torus_R
r = self.torus_r
links = gcd(p,q)
# get an approximate length of the whole TK curve
maxTKLen = 2*pi*sqrt(p*p*(R+r)*(R+r) + q*q*r*r) # upper bound approximation
minTKLen = 2*pi*sqrt(p*p*(R-r)*(R-r) + q*q*r*r) # lower bound approximation
avgTKLen = (minTKLen + maxTKLen)/2 # average approximation
if DEBUG: print("Approximate average TK length = %.2f" % avgTKLen)
self.torus_res = max(3, avgTKLen/links * 8) # x N factor = control points per unit length
# update align matrix
self.align_matrix = align_matrix(self, context)
# turn off undo
undo = bpy.context.user_preferences.edit.use_global_undo
bpy.context.user_preferences.edit.use_global_undo = False
# create the curve
create_torus_knot(self, context)
# restore pre operator undo state
bpy.context.user_preferences.edit.use_global_undo = undo
return {'FINISHED'}
##### INVOKE #####
def invoke(self, context, event):
self.execute(context)
return {'FINISHED'}