API update: percentage to factor
[blender-addons-contrib.git] / amaranth / scene / refresh.py
1 #  This program is free software; you can redistribute it and/or
2 #  modify it under the terms of the GNU General Public License
3 #  as published by the Free Software Foundation; either version 2
4 #  of the License, or (at your option) any later version.
5 #
6 #  This program is distributed in the hope that it will be useful,
7 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
8 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9 #  GNU General Public License for more details.
10 #
11 #  You should have received a copy of the GNU General Public License
12 #  along with this program; if not, write to the Free Software Foundation,
13 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
14 """
15 Refresh Scene
16
17 Refresh the current scene, useful when working with libraries or drivers.
18 Could also add an option to refresh the VSE maybe? Usage: Hit F5 or find
19 it on the Specials menu W.
20 """
21
22 import bpy
23
24
25 KEYMAPS = list()
26
27
28 class AMTH_SCENE_OT_refresh(bpy.types.Operator):
29     """Refresh the current scene"""
30     bl_idname = "scene.refresh"
31     bl_label = "Refresh!"
32
33     def execute(self, context):
34         get_addon = "amaranth" in context.preferences.addons.keys()
35         if not get_addon:
36             return {"CANCELLED"}
37
38         preferences = context.preferences.addons["amaranth"].preferences
39         scene = context.scene
40
41         if preferences.use_scene_refresh:
42             # Changing the frame is usually the best way to go
43             scene.frame_current = scene.frame_current
44             self.report({"INFO"}, "Scene Refreshed!")
45
46         return {"FINISHED"}
47
48
49 def button_refresh(self, context):
50     get_addon = "amaranth" in context.preferences.addons.keys()
51     if not get_addon:
52         return
53
54     if context.preferences.addons["amaranth"].preferences.use_scene_refresh:
55         self.layout.separator()
56         self.layout.operator(AMTH_SCENE_OT_refresh.bl_idname,
57                              text="Refresh!",
58                              icon="FILE_REFRESH")
59
60
61 def register():
62     bpy.utils.register_class(AMTH_SCENE_OT_refresh)
63     bpy.types.VIEW3D_MT_object_context_menu.append(button_refresh)
64     kc = bpy.context.window_manager.keyconfigs.addon
65     km = kc.keymaps.new(name="Window")
66     kmi = km.keymap_items.new("scene.refresh", "F5", "PRESS",
67                               alt=True)
68     KEYMAPS.append((km, kmi))
69
70
71 def unregister():
72     bpy.utils.unregister_class(AMTH_SCENE_OT_refresh)
73     bpy.types.VIEW3D_MT_object_context_menu.remove(button_refresh)
74     for km, kmi in KEYMAPS:
75         km.keymap_items.remove(kmi)
76     KEYMAPS.clear()