initial commit, advanced objects: T51110
[blender-addons-contrib.git] / object_drop_to_ground.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 bl_info = {
20     'name': 'Drop to Ground',
21     'author': 'Unnikrishnan(kodemax), Florian Meyer(testscreenings)',
22     'version': (1, 2),
23     "blender": (2, 71, 0),
24     'location': '3D View > Toolshelf > Tools Tab',
25     'description': 'Drop selected objects on active object',
26     'warning': '',
27     'wiki_url': 'http://wiki.blender.org/index.php/Extensions:2.6/Py/'
28         'Scripts/Object/Drop_to_ground',
29     "tracker_url": "https://developer.blender.org/maniphest/task/edit/form/2/",
30     'category': 'Object'}
31
32
33 import bpy, bmesh
34 from mathutils import *
35 from bpy.types import Operator
36 from bpy.props import *
37
38 def get_align_matrix(location, normal):
39     up = Vector((0,0,1))
40     angle = normal.angle(up)
41     axis = up.cross(normal)
42     mat_rot = Matrix.Rotation(angle, 4, axis)
43     mat_loc = Matrix.Translation(location)
44     mat_align = mat_rot * mat_loc
45     return mat_align
46
47 def transform_ground_to_world(sc, ground):
48     tmpMesh = ground.to_mesh(sc, True, 'PREVIEW')
49     tmpMesh.transform(ground.matrix_world)
50     tmp_ground = bpy.data.objects.new('tmpGround', tmpMesh)
51     sc.objects.link(tmp_ground)
52     sc.update()
53     return tmp_ground
54
55 def get_lowest_world_co_from_mesh(ob, mat_parent=None):
56     bme = bmesh.new()
57     bme.from_mesh(ob.data)
58     mat_to_world = ob.matrix_world.copy()
59     if mat_parent:
60         mat_to_world = mat_parent * mat_to_world
61     lowest=None
62     #bme.verts.index_update() #probably not needed
63     for v in bme.verts:
64         if not lowest:
65             lowest = v
66         if (mat_to_world * v.co).z < (mat_to_world * lowest.co).z:
67             lowest = v
68     lowest_co = mat_to_world * lowest.co
69     bme.free()
70     return lowest_co
71
72 def get_lowest_world_co(context, ob, mat_parent=None):
73     if ob.type == 'MESH':
74         return get_lowest_world_co_from_mesh(ob)
75
76     elif ob.type == 'EMPTY' and ob.dupli_type == 'GROUP':
77         if not ob.dupli_group:
78             return None
79
80         else:
81             lowest_co = None
82             for ob_l in ob.dupli_group.objects:
83                 if ob_l.type == 'MESH':
84                     lowest_ob_l = get_lowest_world_co_from_mesh(ob_l, ob.matrix_world)
85                     if not lowest_co:
86                         lowest_co = lowest_ob_l
87                     if lowest_ob_l.z < lowest_co.z:
88                         lowest_co = lowest_ob_l
89
90             return lowest_co
91
92 def drop_objects(self, context):
93     ground = context.object
94     obs = context.selected_objects
95     obs.remove(ground)
96     tmp_ground = transform_ground_to_world(context.scene, ground)
97     down = Vector((0, 0, -10000))
98
99     for ob in obs:
100         if self.use_origin:
101             lowest_world_co = ob.location
102         else:
103             lowest_world_co = get_lowest_world_co(context, ob)
104         if not lowest_world_co:
105             print(ob.type, 'is not supported. Failed to drop', ob.name)
106             continue
107         is_hit, hit_location, hit_normal, hit_index = tmp_ground.ray_cast(lowest_world_co, down)
108         if not is_hit:
109             print(ob.name, 'didn\'t hit the ground')
110             continue
111
112         # simple drop down
113         to_ground_vec =  hit_location - lowest_world_co
114         ob.location += to_ground_vec
115
116         # drop with align to hit normal
117         if self.align:
118             to_center_vec = ob.location - hit_location #vec: hit_loc to origin
119             # rotate object to align with face normal
120             mat_normal = get_align_matrix(hit_location, hit_normal)
121             rot_euler = mat_normal.to_euler()
122             mat_ob_tmp = ob.matrix_world.copy().to_3x3()
123             mat_ob_tmp.rotate(rot_euler)
124             mat_ob_tmp = mat_ob_tmp.to_4x4()
125             ob.matrix_world = mat_ob_tmp
126             # move_object to hit_location
127             ob.location = hit_location
128             # move object above surface again
129             to_center_vec.rotate(rot_euler)
130             ob.location += to_center_vec
131
132
133     #cleanup
134     bpy.ops.object.select_all(action='DESELECT')
135     tmp_ground.select = True
136     bpy.ops.object.delete('EXEC_DEFAULT')
137     for ob in obs:
138         ob.select = True
139     ground.select = True
140
141 #################################################################
142 class OBJECT_OT_drop_to_ground(Operator):
143     """Drop selected objects on active object"""
144     bl_idname = "object.drop_on_active"
145     bl_label = "Drop to Ground"
146     bl_options = {'REGISTER', 'UNDO'}
147     bl_description = "Drop selected objects on active object"
148
149     align = BoolProperty(
150             name="Align to ground",
151             description="Aligns the object to the ground",
152             default=True)
153     use_origin = BoolProperty(
154             name="Use Center",
155             description="Drop to objects origins",
156             default=False)
157
158     ##### POLL #####
159     @classmethod
160     def poll(cls, context):
161         return len(context.selected_objects) >= 2
162
163     ##### EXECUTE #####
164     def execute(self, context):
165         print('\nDropping Objects')
166         drop_objects(self, context)
167         return {'FINISHED'}
168
169 #################################################################
170 class drop_help(bpy.types.Operator):
171         bl_idname = 'help.drop'
172         bl_label = ''
173
174         def draw(self, context):
175                 layout = self.layout
176                 layout.label("To use:")
177                 layout.label("Name the base object 'Ground'")
178                 layout.label("Select the object/s to drop")
179                 layout.label("Then Shift Select 'Ground'")
180
181         def execute(self, context):
182                 return {'FINISHED'}
183
184         def invoke(self, context, event):
185                 return context.window_manager.invoke_popup(self, width = 300)
186                 
187 class Drop_Operator_Panel(bpy.types.Panel):
188     bl_label = "Drop To Ground"
189     bl_region_type = "TOOLS" #UI possible too
190     bl_space_type = "VIEW_3D"
191     bl_options = {'DEFAULT_CLOSED'}
192     bl_context = "objectmode"
193     bl_category = "Tools"
194
195     def draw(self,context):
196         sce = context.scene
197         layout = self.layout
198         row = layout.row()
199         row = layout.split(0.80)
200         row.operator(OBJECT_OT_drop_to_ground.bl_idname,
201                          text="Drop to Ground")
202         row.operator('help.drop', icon = 'INFO')
203
204
205
206 # register the class
207 def register():
208     bpy.utils.register_module(__name__)
209
210     pass
211
212 def unregister():
213     bpy.utils.unregister_module(__name__)
214
215     pass
216
217 if __name__ == "__main__":
218     register()