Merge branch 'master' into blender2.8
[blender.git] / release / scripts / modules / bpy_extras / object_utils.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
21 __all__ = (
22     "add_object_align_init",
23     "object_data_add",
24     "AddObjectHelper",
25     "object_add_grid_scale",
26     "object_add_grid_scale_apply_operator",
27     "object_image_guess",
28     "world_to_camera_view",
29     )
30
31
32 import bpy
33
34 from bpy.props import (
35         BoolProperty,
36         BoolVectorProperty,
37         FloatVectorProperty,
38         )
39
40
41 def add_object_align_init(context, operator):
42     """
43     Return a matrix using the operator settings and view context.
44
45     :arg context: The context to use.
46     :type context: :class:`bpy.types.Context`
47     :arg operator: The operator, checked for location and rotation properties.
48     :type operator: :class:`bpy.types.Operator`
49     :return: the matrix from the context and settings.
50     :rtype: :class:`mathutils.Matrix`
51     """
52
53     from mathutils import Matrix, Vector, Euler
54     properties = operator.properties if operator is not None else None
55
56     space_data = context.space_data
57     if space_data and space_data.type != 'VIEW_3D':
58         space_data = None
59
60     # location
61     if operator and properties.is_property_set("location"):
62         location = Matrix.Translation(Vector(properties.location))
63     else:
64         if space_data:  # local view cursor is detected below
65             location = Matrix.Translation(space_data.cursor_location)
66         else:
67             location = Matrix.Translation(context.scene.cursor_location)
68
69         if operator:
70             properties.location = location.to_translation()
71
72     # rotation
73     view_align = (context.user_preferences.edit.object_align == 'VIEW')
74     view_align_force = False
75     if operator:
76         if properties.is_property_set("view_align"):
77             view_align = view_align_force = operator.view_align
78         else:
79             if properties.is_property_set("rotation"):
80                 # ugh, 'view_align' callback resets
81                 value = properties.rotation[:]
82                 properties.view_align = view_align
83                 properties.rotation = value
84                 del value
85             else:
86                 properties.view_align = view_align
87
88     if operator and (properties.is_property_set("rotation") and
89                      not view_align_force):
90
91         rotation = Euler(properties.rotation).to_matrix().to_4x4()
92     else:
93         if view_align and space_data:
94             rotation = space_data.region_3d.view_matrix.to_3x3().inverted()
95             rotation.resize_4x4()
96         else:
97             rotation = Matrix()
98
99         # set the operator properties
100         if operator:
101             properties.rotation = rotation.to_euler()
102
103     return location * rotation
104
105
106 def object_data_add(context, obdata, operator=None, name=None):
107     """
108     Add an object using the view context and preference to initialize the
109     location, rotation and layer.
110
111     :arg context: The context to use.
112     :type context: :class:`bpy.types.Context`
113     :arg obdata: the data used for the new object.
114     :type obdata: valid object data type or None.
115     :arg operator: The operator, checked for location and rotation properties.
116     :type operator: :class:`bpy.types.Operator`
117     :arg name: Optional name
118     :type name: string
119     :return: the newly created object in the scene.
120     :rtype: :class:`bpy.types.Object`
121     """
122     scene = context.scene
123     layer = context.render_layer
124     layer_collection = context.layer_collection
125
126     for ob in layer.objects:
127         ob.select_set(action='DESELECT')
128
129     if not layer_collection:
130         # when there is no collection linked to this render_layer create one
131         scene_collection = scene.master_collection.collections.new("")
132         layer_collection = layer.collections.link(scene_collection)
133     else:
134         scene_collection = layer_collection.collection
135
136     if name is None:
137         name = "Object" if obdata is None else obdata.name
138
139     obj_act = layer.objects.active
140     obj_new = bpy.data.objects.new(name, obdata)
141     scene_collection.objects.link(obj_new)
142     obj_new.select_set(action='SELECT')
143     obj_new.matrix_world = add_object_align_init(context, operator)
144
145     # XXX
146     # caused because entering edit-mode does not add a empty undo slot!
147     if context.user_preferences.edit.use_enter_edit_mode:
148         if not (obj_act and
149                 obj_act.mode == 'EDIT' and
150                 obj_act.type == obj_new.type):
151
152             _obdata = bpy.data.meshes.new(name)
153             obj_act = bpy.data.objects.new(_obdata.name, _obdata)
154             obj_act.matrix_world = obj_new.matrix_world
155             scene_collection.objects.link(obj_act)
156             layer.objects.active = obj_act
157             bpy.ops.object.mode_set(mode='EDIT')
158             # need empty undo step
159             bpy.ops.ed.undo_push(message="Enter Editmode")
160     # XXX
161
162     if obj_act and obj_act.mode == 'EDIT' and obj_act.type == obj_new.type:
163         bpy.ops.mesh.select_all(action='DESELECT')
164         obj_act.select_set(action='SELECT')
165         bpy.ops.object.mode_set(mode='OBJECT')
166
167         obj_act.select_set(action='SELECT')
168         scene.update()  # apply location
169         # scene.objects.active = obj_new
170
171         # Match up UV layers, this is needed so adding an object with UV's
172         # doesn't create new layers when there happens to be a naming mis-match.
173         uv_new = obdata.uv_layers.active
174         if uv_new is not None:
175             uv_act = obj_act.data.uv_layers.active
176             if uv_act is not None:
177                 uv_new.name = uv_act.name
178
179         bpy.ops.object.join()  # join into the active.
180         if obdata:
181             bpy.data.meshes.remove(obdata)
182
183         bpy.ops.object.mode_set(mode='EDIT')
184     else:
185         layer.objects.active = obj_new
186         if context.user_preferences.edit.use_enter_edit_mode:
187             bpy.ops.object.mode_set(mode='EDIT')
188
189     return obj_new
190
191
192 class AddObjectHelper:
193     def view_align_update_callback(self, context):
194         if not self.view_align:
195             self.rotation.zero()
196
197     view_align = BoolProperty(
198             name="Align to View",
199             default=False,
200             update=view_align_update_callback,
201             )
202     location = FloatVectorProperty(
203             name="Location",
204             subtype='TRANSLATION',
205             )
206     rotation = FloatVectorProperty(
207             name="Rotation",
208             subtype='EULER',
209             )
210
211     @classmethod
212     def poll(self, context):
213         return context.scene.library is None
214
215
216 def object_add_grid_scale(context):
217     """
218     Return scale which should be applied on object
219     data to align it to grid scale
220     """
221
222     space_data = context.space_data
223
224     if space_data and space_data.type == 'VIEW_3D':
225         return space_data.grid_scale_unit
226
227     return 1.0
228
229
230 def object_add_grid_scale_apply_operator(operator, context):
231     """
232     Scale an operators distance values by the grid size.
233     """
234     grid_scale = object_add_grid_scale(context)
235
236     properties = operator.properties
237     properties_def = properties.bl_rna.properties
238     for prop_id in properties_def.keys():
239         if not properties.is_property_set(prop_id):
240             prop_def = properties_def[prop_id]
241             if prop_def.unit == 'LENGTH' and prop_def.subtype == 'DISTANCE':
242                 setattr(operator, prop_id,
243                         getattr(operator, prop_id) * grid_scale)
244
245
246 def object_image_guess(obj, bm=None):
247     """
248     Return a single image used by the object,
249     first checking the texture-faces, then the material.
250     """
251     # TODO, cycles/nodes materials
252     me = obj.data
253     if bm is None:
254         if obj.mode == 'EDIT':
255             import bmesh
256             bm = bmesh.from_edit_mesh(me)
257
258     if bm is not None:
259         tex_layer = bm.faces.layers.tex.active
260         if tex_layer is not None:
261             for f in bm.faces:
262                 image = f[tex_layer].image
263                 if image is not None:
264                     return image
265     else:
266         tex_layer = me.uv_textures.active
267         if tex_layer is not None:
268             for tf in tex_layer.data:
269                 image = tf.image
270                 if image is not None:
271                     return image
272
273     for m in obj.data.materials:
274         if m is not None:
275             # backwards so topmost are highest priority
276             for mtex in reversed(m.texture_slots):
277                 if mtex and mtex.use_map_color_diffuse:
278                     texture = mtex.texture
279                     if texture and texture.type == 'IMAGE':
280                         image = texture.image
281                         if image is not None:
282                             return image
283     return None
284
285
286 def world_to_camera_view(scene, obj, coord):
287     """
288     Returns the camera space coords for a 3d point.
289     (also known as: normalized device coordinates - NDC).
290
291     Where (0, 0) is the bottom left and (1, 1)
292     is the top right of the camera frame.
293     values outside 0-1 are also supported.
294     A negative 'z' value means the point is behind the camera.
295
296     Takes shift-x/y, lens angle and sensor size into account
297     as well as perspective/ortho projections.
298
299     :arg scene: Scene to use for frame size.
300     :type scene: :class:`bpy.types.Scene`
301     :arg obj: Camera object.
302     :type obj: :class:`bpy.types.Object`
303     :arg coord: World space location.
304     :type coord: :class:`mathutils.Vector`
305     :return: a vector where X and Y map to the view plane and
306        Z is the depth on the view axis.
307     :rtype: :class:`mathutils.Vector`
308     """
309     from mathutils import Vector
310
311     co_local = obj.matrix_world.normalized().inverted() * coord
312     z = -co_local.z
313
314     camera = obj.data
315     frame = [-v for v in camera.view_frame(scene=scene)[:3]]
316     if camera.type != 'ORTHO':
317         if z == 0.0:
318             return Vector((0.5, 0.5, 0.0))
319         else:
320             frame = [(v / (v.z / z)) for v in frame]
321
322     min_x, max_x = frame[1].x, frame[2].x
323     min_y, max_y = frame[0].y, frame[1].y
324
325     x = (co_local.x - min_x) / (max_x - min_x)
326     y = (co_local.y - min_y) / (max_y - min_y)
327
328     return Vector((x, y, z))