- generate sphinx docs for bpy_extras module
[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 compliant>
20
21 __all__ = (
22     "add_object_align_init",
23     "object_data_add",
24 )
25
26
27 import bpy
28 import mathutils
29
30
31 def add_object_align_init(context, operator):
32     space_data = context.space_data
33     if space_data.type != 'VIEW_3D':
34         space_data = None
35
36     # location
37     if operator and operator.properties.is_property_set("location"):
38         location = mathutils.Matrix.Translation(mathutils.Vector(operator.properties.location))
39     else:
40         if space_data:  # local view cursor is detected below
41             location = mathutils.Matrix.Translation(space_data.cursor_location)
42         else:
43             location = mathutils.Matrix.Translation(context.scene.cursor_location)
44
45         if operator:
46             operator.properties.location = location.to_translation()
47
48     # rotation
49     view_align = (context.user_preferences.edit.object_align == 'VIEW')
50     view_align_force = False
51     if operator:
52         if operator.properties.is_property_set("view_align"):
53             view_align = view_align_force = operator.view_align
54         else:
55             operator.properties.view_align = view_align
56
57     if operator and operator.properties.is_property_set("rotation") and not view_align_force:
58         rotation = mathutils.Euler(operator.properties.rotation).to_matrix().to_4x4()
59     else:
60         if view_align and space_data:
61             rotation = space_data.region_3d.view_matrix.to_3x3().inverted().to_4x4()
62         else:
63             rotation = mathutils.Matrix()
64
65         # set the operator properties
66         if operator:
67             operator.properties.rotation = rotation.to_euler()
68
69     return location * rotation
70
71
72 def object_data_add(context, obdata, operator=None):
73
74     scene = context.scene
75
76     # ugh, could be made nicer
77     for ob in scene.objects:
78         ob.select = False
79
80     obj_new = bpy.data.objects.new(obdata.name, obdata)
81
82     base = scene.objects.link(obj_new)
83     base.select = True
84
85     if context.space_data and context.space_data.type == 'VIEW_3D':
86         base.layers_from_view(context.space_data)
87
88     obj_new.matrix_world = add_object_align_init(context, operator)
89
90     obj_act = scene.objects.active
91
92     # XXX
93     # caused because entering editmodedoes not add a empty undo slot!
94     if context.user_preferences.edit.use_enter_edit_mode:
95         if not (obj_act and obj_act.mode == 'EDIT' and obj_act.type == obj_new.type):
96             _obdata = bpy.data.meshes.new(obdata.name)
97             obj_act = bpy.data.objects.new(_obdata.name, _obdata)
98             obj_act.matrix_world = obj_new.matrix_world
99             scene.objects.link(obj_act)
100             scene.objects.active = obj_act
101             bpy.ops.object.mode_set(mode='EDIT')
102             bpy.ops.ed.undo_push(message="Enter Editmode")  # need empty undo step
103     # XXX
104
105     if obj_act and obj_act.mode == 'EDIT' and obj_act.type == obj_new.type:
106         bpy.ops.mesh.select_all(action='DESELECT')
107         bpy.ops.object.mode_set(mode='OBJECT')
108
109         obj_act.select = True
110         scene.update()  # apply location
111         #scene.objects.active = obj_new
112
113         bpy.ops.object.join()  # join into the active.
114         bpy.data.meshes.remove(obdata)
115
116         bpy.ops.object.mode_set(mode='EDIT')
117     else:
118         scene.objects.active = obj_new
119         if context.user_preferences.edit.use_enter_edit_mode:
120             bpy.ops.object.mode_set(mode='EDIT')
121
122     return base