Amaranth Addon
[blender-addons-contrib.git] / amaranth / animation / timeline_extra_info.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 Timeline Extra Info
16
17 Display amount of frames left until Frame End, very handy especially when
18 rendering an animation or OpenGL preview.
19 Display current/end time on SMPTE. Find it on the Timeline header.
20 """
21
22 import bpy
23
24
25 def label_timeline_extra_info(self, context):
26
27     preferences = context.user_preferences.addons["amaranth"].preferences
28     layout = self.layout
29     scene = context.scene
30
31     if preferences.use_timeline_extra_info:
32         row = layout.row(align=True)
33
34         # Check for preview range
35         frame_start = scene.frame_preview_start if scene.use_preview_range else scene.frame_start
36         frame_end = scene.frame_preview_end if scene.use_preview_range else scene.frame_end
37
38         row.label(
39             text="%s / %s" %
40             (bpy.utils.smpte_from_frame(
41                 scene.frame_current -
42                 frame_start),
43                 bpy.utils.smpte_from_frame(
44                     frame_end -
45                     frame_start)))
46
47         if (scene.frame_current > frame_end):
48             row.label(text="%s Frames Ahead" %
49                       ((frame_end - scene.frame_current) * -1))
50         elif (scene.frame_current == frame_start):
51             row.label(text="Start Frame (%s left)" %
52                       (frame_end - scene.frame_current))
53         elif (scene.frame_current == frame_end):
54             row.label(text="%s End Frame" % scene.frame_current)
55         else:
56             row.label(text="%s Frames Left" %
57                       (frame_end - scene.frame_current))
58
59
60 def register():
61     bpy.types.TIME_HT_header.append(label_timeline_extra_info)
62
63
64 def unregister():
65     bpy.types.TIME_HT_header.remove(label_timeline_extra_info)