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