add_mesh_extra_objects/add_mesh_star.py

   1 # SPDX-FileCopyrightText: 2015-2022 Blender Foundation
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-or-later
   4
   5 # Original by Fourmadmen
   6
   7 import bpy
   8 from mathutils import (
   9         Vector,
  10         Quaternion,
  11         )
  12 from math import pi
  13 from bpy.props import (
  14         IntProperty,
  15         FloatProperty,
  16         StringProperty,
  17         BoolProperty,
  18         )
  19 from bpy_extras import object_utils
  20
  21 # Create a new mesh (object) from verts/edges/faces.
  22 # verts/edges/faces ... List of vertices/edges/faces for the
  23 #                       new mesh (as used in from_pydata)
  24 # name ... Name of the new mesh (& object)
  25
  26 def create_mesh_object(context, verts, edges, faces, name):
  27
  28     # Create new mesh
  29     mesh = bpy.data.meshes.new(name)
  30
  31     # Make a mesh from a list of verts/edges/faces.
  32     mesh.from_pydata(verts, edges, faces)
  33
  34     # Update mesh geometry after adding stuff.
  35     mesh.update()
  36
  37     from bpy_extras import object_utils
  38     return object_utils.object_data_add(context, mesh, operator=None)
  39
  40
  41 # A very simple "bridge" tool.
  42
  43 def createFaces(vertIdx1, vertIdx2, closed=False, flipped=False):
  44     faces = []
  45
  46     if not vertIdx1 or not vertIdx2:
  47         return None
  48
  49     if len(vertIdx1) < 2 and len(vertIdx2) < 2:
  50         return None
  51
  52     fan = False
  53     if (len(vertIdx1) != len(vertIdx2)):
  54         if (len(vertIdx1) == 1 and len(vertIdx2) > 1):
  55             fan = True
  56         else:
  57             return None
  58
  59     total = len(vertIdx2)
  60
  61     if closed:
  62         # Bridge the start with the end.
  63         if flipped:
  64             face = [
  65                 vertIdx1[0],
  66                 vertIdx2[0],
  67                 vertIdx2[total - 1]]
  68             if not fan:
  69                 face.append(vertIdx1[total - 1])
  70             faces.append(face)
  71
  72         else:
  73             face = [vertIdx2[0], vertIdx1[0]]
  74             if not fan:
  75                 face.append(vertIdx1[total - 1])
  76             face.append(vertIdx2[total - 1])
  77             faces.append(face)
  78
  79     # Bridge the rest of the faces.
  80     for num in range(total - 1):
  81         if flipped:
  82             if fan:
  83                 face = [vertIdx2[num], vertIdx1[0], vertIdx2[num + 1]]
  84             else:
  85                 face = [vertIdx2[num], vertIdx1[num],
  86                         vertIdx1[num + 1], vertIdx2[num + 1]]
  87             faces.append(face)
  88         else:
  89             if fan:
  90                 face = [vertIdx1[0], vertIdx2[num], vertIdx2[num + 1]]
  91             else:
  92                 face = [vertIdx1[num], vertIdx2[num],
  93                         vertIdx2[num + 1], vertIdx1[num + 1]]
  94             faces.append(face)
  95
  96     return faces
  97
  98
  99 # @todo Clean up vertex&face creation process a bit.
 100
 101 def add_star(points, outer_radius, inner_radius, height):
 102     PI_2 = pi * 2
 103     z_axis = (0, 0, 1)
 104
 105     verts = []
 106     faces = []
 107
 108     segments = points * 2
 109
 110     half_height = height / 2.0
 111
 112     vert_idx_top = len(verts)
 113     verts.append(Vector((0.0, 0.0, half_height)))
 114
 115     vert_idx_bottom = len(verts)
 116     verts.append(Vector((0.0, 0.0, -half_height)))
 117
 118     edgeloop_top = []
 119     edgeloop_bottom = []
 120
 121     for index in range(segments):
 122         quat = Quaternion(z_axis, (index / segments) * PI_2)
 123
 124         if index % 2:
 125             # Uneven
 126             radius = outer_radius
 127         else:
 128             # Even
 129             radius = inner_radius
 130
 131         edgeloop_top.append(len(verts))
 132         vec = quat @ Vector((radius, 0, half_height))
 133         verts.append(vec)
 134
 135         edgeloop_bottom.append(len(verts))
 136         vec = quat @ Vector((radius, 0, -half_height))
 137         verts.append(vec)
 138
 139     faces_top = createFaces([vert_idx_top], edgeloop_top, closed=True)
 140     faces_outside = createFaces(edgeloop_top, edgeloop_bottom, closed=True)
 141     faces_bottom = createFaces([vert_idx_bottom], edgeloop_bottom,
 142         flipped=True, closed=True)
 143
 144     faces.extend(faces_top)
 145     faces.extend(faces_outside)
 146     faces.extend(faces_bottom)
 147
 148     return verts, faces
 149
 150
 151 class AddStar(bpy.types.Operator, object_utils.AddObjectHelper):
 152     bl_idname = "mesh.primitive_star_add"
 153     bl_label = "Simple Star"
 154     bl_description = "Construct a star mesh"
 155     bl_options = {'REGISTER', 'UNDO', 'PRESET'}
 156
 157     Star : BoolProperty(name = "Star",
 158                 default = True,
 159                 description = "Star")
 160     change : BoolProperty(name = "Change",
 161                 default = False,
 162                 description = "change Star")
 163
 164     points: IntProperty(
 165         name="Points",
 166         description="Number of points for the star",
 167         min=2,
 168         max=256,
 169         default=5
 170         )
 171     outer_radius: FloatProperty(
 172         name="Outer Radius",
 173         description="Outer radius of the star",
 174         min=0.01,
 175         max=9999.0,
 176         default=1.0
 177         )
 178     innter_radius: FloatProperty(
 179         name="Inner Radius",
 180         description="Inner radius of the star",
 181         min=0.01,
 182         max=9999.0,
 183         default=0.5
 184         )
 185     height: FloatProperty(name="Height",
 186         description="Height of the star",
 187         min=0.01,
 188         max=9999.0,
 189         default=0.5
 190         )
 191
 192     def draw(self, context):
 193         layout = self.layout
 194
 195         layout.prop(self, 'points', expand=True)
 196         layout.prop(self, 'outer_radius', expand=True)
 197         layout.prop(self, 'innter_radius', expand=True)
 198         layout.prop(self, 'height', expand=True)
 199
 200         if self.change == False:
 201             col = layout.column(align=True)
 202             col.prop(self, 'align', expand=True)
 203             col = layout.column(align=True)
 204             col.prop(self, 'location', expand=True)
 205             col = layout.column(align=True)
 206             col.prop(self, 'rotation', expand=True)
 207
 208     def execute(self, context):
 209         # turn off 'Enter Edit Mode'
 210         use_enter_edit_mode = bpy.context.preferences.edit.use_enter_edit_mode
 211         bpy.context.preferences.edit.use_enter_edit_mode = False
 212
 213         if bpy.context.mode == "OBJECT":
 214             if context.selected_objects != [] and context.active_object and \
 215                 (context.active_object.data is not None) and ('Star' in context.active_object.data.keys()) and \
 216                 (self.change == True):
 217                 obj = context.active_object
 218                 oldmesh = obj.data
 219                 oldmeshname = obj.data.name
 220                 verts, faces = add_star(
 221                         self.points,
 222                         self.outer_radius,
 223                         self.innter_radius,
 224                         self.height
 225                         )
 226                 mesh = bpy.data.meshes.new('Star')
 227                 mesh.from_pydata(verts, [], faces)
 228                 obj.data = mesh
 229                 for material in oldmesh.materials:
 230                     obj.data.materials.append(material)
 231                 bpy.data.meshes.remove(oldmesh)
 232                 obj.data.name = oldmeshname
 233             else:
 234                 verts, faces = add_star(
 235                         self.points,
 236                         self.outer_radius,
 237                         self.innter_radius,
 238                         self.height
 239                         )
 240                 mesh = bpy.data.meshes.new('Star')
 241                 mesh.from_pydata(verts, [], faces)
 242                 obj = object_utils.object_data_add(context, mesh, operator=self)
 243
 244             obj.data["Star"] = True
 245             obj.data["change"] = False
 246             for prm in StarParameters():
 247                 obj.data[prm] = getattr(self, prm)
 248
 249         if bpy.context.mode == "EDIT_MESH":
 250             active_object = context.active_object
 251             name_active_object = active_object.name
 252             bpy.ops.object.mode_set(mode='OBJECT')
 253             verts, faces = add_star(
 254                         self.points,
 255                         self.outer_radius,
 256                         self.innter_radius,
 257                         self.height
 258                         )
 259             mesh = bpy.data.meshes.new('Star')
 260             mesh.from_pydata(verts, [], faces)
 261             obj = object_utils.object_data_add(context, mesh, operator=self)
 262             obj.select_set(True)
 263             active_object.select_set(True)
 264             bpy.context.view_layer.objects.active = active_object
 265             bpy.ops.object.join()
 266             context.active_object.name = name_active_object
 267             bpy.ops.object.mode_set(mode='EDIT')
 268
 269         if use_enter_edit_mode:
 270             bpy.ops.object.mode_set(mode = 'EDIT')
 271
 272         # restore pre operator state
 273         bpy.context.preferences.edit.use_enter_edit_mode = use_enter_edit_mode
 274
 275         return {'FINISHED'}
 276
 277 def StarParameters():
 278     StarParameters = [
 279         "points",
 280         "outer_radius",
 281         "innter_radius",
 282         "height",
 283         ]
 284     return StarParameters