Cleanup: use staticmethod where appropriate
[blender.git] / release / scripts / templates_py / background_job.py
1 # This script is an example of how you can run blender from the command line
2 # (in background mode with no interface) to automate tasks, in this example it
3 # creates a text object, camera and light, then renders and/or saves it.
4 # This example also shows how you can parse command line options to scripts.
5 #
6 # Example usage for this test.
7 #  blender --background --factory-startup --python $HOME/background_job.py -- \
8 #          --text="Hello World" \
9 #          --render="/tmp/hello" \
10 #          --save="/tmp/hello.blend"
11 #
12 # Notice:
13 # '--factory-startup' is used to avoid the user default settings from
14 #                     interfering with automated scene generation.
15 #
16 # '--' causes blender to ignore all following arguments so python can use them.
17 #
18 # See blender --help for details.
19
20
21 import bpy
22
23
24 def example_function(text, save_path, render_path):
25     # Clear existing objects.
26     bpy.ops.wm.read_factory_settings(use_empty=True)
27
28     scene = bpy.context.scene
29
30     txt_data = bpy.data.curves.new(name="MyText", type='FONT')
31
32     # Text Object
33     txt_ob = bpy.data.objects.new(name="MyText", object_data=txt_data)
34     scene.collection.objects.link(txt_ob)   # add the data to the scene as an object
35     txt_data.body = text         # the body text to the command line arg given
36     txt_data.align_x = 'CENTER'  # center text
37
38     # Camera
39     cam_data = bpy.data.cameras.new("MyCam")
40     cam_ob = bpy.data.objects.new(name="MyCam", object_data=cam_data)
41     scene.collection.objects.link(cam_ob)  # instance the camera object in the scene
42     scene.camera = cam_ob       # set the active camera
43     cam_ob.location = 0.0, 0.0, 10.0
44
45     # Light
46     light_data = bpy.data.lights.new("MyLight", 'POINT')
47     light_ob = bpy.data.objects.new(name="MyCam", object_data=light_data)
48     scene.collection.objects.link(light_ob)
49     light_ob.location = 2.0, 2.0, 5.0
50
51     scene.update()
52
53     if save_path:
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 def main():
64     import sys       # to get command line args
65     import argparse  # to parse options for us and print a nice help message
66
67     # get the args passed to blender after "--", all of which are ignored by
68     # blender so scripts may receive their own arguments
69     argv = sys.argv
70
71     if "--" not in argv:
72         argv = []  # as if no args are passed
73     else:
74         argv = argv[argv.index("--") + 1:]  # get all args after "--"
75
76     # When --help or no args are given, print this help
77     usage_text = (
78         "Run blender in background mode with this script:"
79         "  blender --background --python " + __file__ + " -- [options]"
80     )
81
82     parser = argparse.ArgumentParser(description=usage_text)
83
84     # Example 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_argument(
87         "-t", "--text", dest="text", type=str, required=True,
88         help="This text will be used to render an image",
89     )
90
91     parser.add_argument(
92         "-s", "--save", dest="save_path", metavar='FILE',
93         help="Save the generated file to the specified path",
94     )
95     parser.add_argument(
96         "-r", "--render", dest="render_path", metavar='FILE',
97         help="Render an image to the specified path",
98     )
99
100     args = parser.parse_args(argv)  # In this example we won't use the args
101
102     if not argv:
103         parser.print_help()
104         return
105
106     if not args.text:
107         print("Error: --text=\"some string\" argument not given, aborting.")
108         parser.print_help()
109         return
110
111     # Run the example function
112     example_function(args.text, args.save_path, args.render_path)
113
114     print("batch job finished, exiting")
115
116
117 if __name__ == "__main__":
118     main()