correct missing bpy doc references.
[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     )
25
26
27 import bpy
28 import mathutils
29
30
31 def add_object_align_init(context, operator):
32     """
33     Return a matrix using the operator settings and view context.
34
35     :arg context: The context to use.
36     :type context: :class:`bpy.types.Context`
37     :arg operator: The operator, checked for location and rotation properties.
38     :type operator: :class:`bpy.types.Operator`
39     :return: the matrix from the context and settings.
40     :rtype: :class:`mathutils.Matrix`
41     """
42
43     from mathutils import Matrix, Vector, Euler
44     properties = operator.properties if operator is not None else None
45
46     space_data = context.space_data
47     if space_data.type != 'VIEW_3D':
48         space_data = None
49
50     # location
51     if operator and properties.is_property_set("location"):
52         location = Matrix.Translation(Vector(properties.location))
53     else:
54         if space_data:  # local view cursor is detected below
55             location = Matrix.Translation(space_data.cursor_location)
56         else:
57             location = Matrix.Translation(context.scene.cursor_location)
58
59         if operator:
60             properties.location = location.to_translation()
61
62     # rotation
63     view_align = (context.user_preferences.edit.object_align == 'VIEW')
64     view_align_force = False
65     if operator:
66         if properties.is_property_set("view_align"):
67             view_align = view_align_force = operator.view_align
68         else:
69             properties.view_align = view_align
70
71     if operator and (properties.is_property_set("rotation") and
72                      not view_align_force):
73
74         rotation = Euler(properties.rotation).to_matrix().to_4x4()
75     else:
76         if view_align and space_data:
77             rotation = space_data.region_3d.view_matrix.to_3x3().inverted()
78             rotation.resize_4x4()
79         else:
80             rotation = mathutils.Matrix()
81
82         # set the operator properties
83         if operator:
84             properties.rotation = rotation.to_euler()
85
86     return location * rotation
87
88
89 def object_data_add(context, obdata, operator=None):
90     """
91     Add an object using the view context and preference to to initialize the
92     location, rotation and layer.
93
94     :arg context: The context to use.
95     :type context: :class:`bpy.types.Context`
96     :arg obdata: the data used for the new object.
97     :type obdata: valid object data type or None.
98     :arg operator: The operator, checked for location and rotation properties.
99     :type operator: :class:`bpy.types.Operator`
100     :return: the newly created object in the scene.
101     :rtype: :class:`bpy.types.ObjectBase`
102     """
103     scene = context.scene
104
105     # ugh, could be made nicer
106     for ob in scene.objects:
107         ob.select = False
108
109     obj_new = bpy.data.objects.new(obdata.name, obdata)
110
111     base = scene.objects.link(obj_new)
112     base.select = True
113
114     if context.space_data and context.space_data.type == 'VIEW_3D':
115         base.layers_from_view(context.space_data)
116
117     obj_new.matrix_world = add_object_align_init(context, operator)
118
119     obj_act = scene.objects.active
120
121     # XXX
122     # caused because entering editmodedoes not add a empty undo slot!
123     if context.user_preferences.edit.use_enter_edit_mode:
124         if not (obj_act and
125                 obj_act.mode == 'EDIT' and
126                 obj_act.type == obj_new.type):
127
128             _obdata = bpy.data.meshes.new(obdata.name)
129             obj_act = bpy.data.objects.new(_obdata.name, _obdata)
130             obj_act.matrix_world = obj_new.matrix_world
131             scene.objects.link(obj_act)
132             scene.objects.active = obj_act
133             bpy.ops.object.mode_set(mode='EDIT')
134             # need empty undo step
135             bpy.ops.ed.undo_push(message="Enter Editmode")
136     # XXX
137
138     if obj_act and obj_act.mode == 'EDIT' and obj_act.type == obj_new.type:
139         bpy.ops.mesh.select_all(action='DESELECT')
140         bpy.ops.object.mode_set(mode='OBJECT')
141
142         obj_act.select = True
143         scene.update()  # apply location
144         #scene.objects.active = obj_new
145
146         bpy.ops.object.join()  # join into the active.
147         bpy.data.meshes.remove(obdata)
148
149         bpy.ops.object.mode_set(mode='EDIT')
150     else:
151         scene.objects.active = obj_new
152         if context.user_preferences.edit.use_enter_edit_mode:
153             bpy.ops.object.mode_set(mode='EDIT')
154
155     return base