5705e8ef53e6b7d374eb07c9139455403ea754fb
[blender.git] / release / scripts / templates / background_job.py
1 # This script is an example of how you can run blender from the command line (in background mode with no interface)
2 # to automate tasks, in this example it creates a text object, camera and light, then renders and/or saves it.
3 # This example also shows how you can parse command line options to python scripts.
4
5 # Example usage for this test.
6 #  blender -b -P $HOME/background_job.py -- --text="Hello World" --render="/tmp/hello" --save="/tmp/hello.blend"
7
8 # Notice all python args are after the "--" argument.
9
10 import bpy
11
12 def example_function(body_text, save_path, render_path):
13     
14     scene = bpy.context.scene
15
16     # Clear existing objects.
17     scene.camera = None
18     for obj in scene.objects:
19         scene.objects.unlink(obj)
20
21     txt_data = bpy.data.curves.new(name="MyText", type='FONT')
22
23     # Text Object
24     txt_ob = bpy.data.objects.new(name="MyText", object_data=txt_data)
25     scene.objects.link(txt_ob)            # add the data to the scene as an object
26     txt_data.body = body_text                     # set the body text to the command line arg given
27     txt_data.align = 'CENTER'                    # center text
28
29     # Camera
30     cam_data = bpy.data.cameras.new("MyCam")        # create new camera data
31     cam_ob = bpy.data.objects.new(name="MyCam", object_data=cam_data)
32     scene.objects.link(cam_ob)            # add the camera data to the scene (creating a new object)
33     scene.camera = cam_ob                    # set the active camera
34     cam_ob.location =  0.0, 0.0, 10.0
35
36     # Lamp
37     lamp_data = bpy.data.lamps.new("MyLamp")
38     lamp_ob = bpy.data.objects.new(name="MyCam", object_data=lamp_data)
39     scene.objects.link(lamp_ob)
40     lamp_ob.location = 2.0, 2.0, 5.0
41
42     if save_path:
43         try:
44             f = open(save_path, 'w')
45             f.close()
46             ok = True
47         except:
48             print("Cannot save to path %r" % save_path)
49
50             import traceback
51             traceback.print_exc()
52
53         if ok:
54             bpy.ops.wm.save_as_mainfile(filepath=save_path)
55
56     if render_path:
57         render = scene.render
58         render.use_file_extension = True
59         render.filepath = render_path
60         bpy.ops.render.render(write_still=True)
61
62
63 import sys        # to get command line args
64 import optparse    # to parse options for us and print a nice help message
65
66 def main():
67     
68     # get the args passed to blender after "--", all of which are ignored by blender specifically
69     # so python may receive its own arguments
70     argv = sys.argv
71
72     if "--" not in argv:
73         argv = [] # as if no args are passed
74     else:    
75         argv = argv[argv.index("--") + 1:] # get all args after "--"
76     
77     # When --help or no args are given, print this help
78     usage_text = "Run blender in background mode with this script:"
79     usage_text += "  blender -b -P " + __file__ + " -- [options]"
80             
81     parser = optparse.OptionParser(usage=usage_text)
82     
83
84     # Example background utility, add some text and renders or saves it (with options)
85     # Possible types are: string, int, long, choice, float and complex.
86     parser.add_option("-t", "--text", dest="body_text", help="This text will be used to render an image", type="string")
87
88     parser.add_option("-s", "--save", dest="save_path", help="Save the generated file to the specified path", metavar='FILE')
89     parser.add_option("-r", "--render", dest="render_path", help="Render an image to the specified path", metavar='FILE')
90
91     options, args = parser.parse_args(argv) # In this example we wont use the args
92     
93     if not argv:
94         parser.print_help()
95         return
96
97     if not options.body_text:
98         print("Error: --text=\"some string\" argument not given, aborting.")
99         parser.print_help()
100         return
101     
102     # Run the example function
103     example_function(options.body_text, options.save_path, options.render_path)
104
105     print("batch job finished, exiting")
106
107
108 if __name__ == "__main__":
109     main()