some updates to epy docs
[blender.git] / source / blender / python / api2_2x / doc / API_intro.py
1 # This is not a real module, it's simply an introductory text.
2
3 """
4 The Blender Python API Reference
5 ================================
6
7         An asterisk (*) means the module has been updated.
8
9         for a full list of changes since 2.45 see U{http://wiki.blender.org/index.php/Release_Notes/Notes246/Python_API}
10
11         Top Module:
12         -----------
13
14                 - L{Blender}
15                 - L{bpy<Bpy>} (experimental)
16
17         Submodules:
18         -----------
19                 - L{Armature}
20                         - L{NLA}
21                         - L{Action<NLA.Action>}
22                 - L{BezTriple}
23                 - L{BGL}
24                 - L{Camera}
25                 - L{Curve}
26                 - L{Draw}
27                 - L{Effect}
28                 - L{Geometry}
29                 - L{Group}
30                 - L{Image}
31                 - L{Ipo}
32                 - L{IpoCurve}
33                 - L{Key}
34                 - L{Lamp}
35                 - L{Lattice}
36                 - L{Library}
37                 - L{Material}
38                 - L{Mathutils}
39                 - L{Mesh}
40                   - L{MeshPrimitives}
41                 - L{Metaball}
42                 - L{NMesh} (deprecated)
43                 - L{Noise}
44                 - L{Object}
45                         - L{Modifier}
46                         - L{Pose}
47                         - L{Constraint}
48                         - L{ActionStrips<NLA>}
49                 - L{Particle}
50                 - L{Registry}
51                 - L{Scene} (*)
52                         - L{Radio}
53                         - L{Render}
54                 - L{Sound}
55                 - L{Text}
56                 - L{Text3d}
57                         - L{Font}
58                 - L{Texture}
59                 - L{TimeLine}
60                 - L{Types}
61                 - L{Window}
62                         - L{Theme}
63                 - L{World}
64                 - L{sys<Sys>}
65
66 Introduction:
67 =============
68
69         This reference documents the Blender Python API, a growing collection of
70         Python modules (libraries) that give access to part of the program's internal
71         data and functions.
72         
73         Through scripting Blender can be extended in real-time via
74         U{Python <www.python.org>}, an impressive high level, multi-paradigm, open
75         source language.  Newcomers are recommended to start with the tutorial that
76         comes with it.
77
78         This opens many interesting possibilities, ranging from automating repetitive
79         tasks to adding new functionality to the program: procedural models,
80         importers and exporters, even complex applications and so on.  Blender itself
81         comes with some scripts, but many others can be found in the Scripts & Plugins
82         sections and forum posts at the Blender-related sites listed below.
83
84 Scripting and Blender:
85 ======================
86
87 These are the basic ways to execute scripts in Blender:
88
89         1. They can be loaded or typed as text files in the Text Editor window, then
90         executed with ALT+P.
91         2. Via command line: C{blender -P <scriptname>} will start Blender and execute
92         the given script.  <scriptname> can be a filename in the user's file system or
93         the name of a text saved in a .blend Blender file:
94         'blender myfile.blend -P textname'.
95         3. Via command line in I{background mode}: use the '-b' flag (the order is
96         important): C{blender -b <blendfile> -P <scriptname>}.  <blendfile> can be any
97         .blend file, including the default .B.blend that is in Blender's home directory
98         L{Blender.Get}('homedir'). In this mode no window will be opened and the
99         program will leave as soon as the script finishes execution.
100         4. Properly registered scripts can be selected directly from the program's
101         menus.
102         5. Scriptlinks: these are also loaded or typed in the Text Editor window and
103         can be linked to objects, materials or scenes using the Scriptlink buttons
104         tab.  Script links get executed automatically when their events (ONLOAD,
105         REDRAW, FRAMECHANGED) are triggered.  Normal scripts can create (L{Text}) and
106         link other scripts to objects and events, see L{Object.Object.addScriptLink},
107         for example.
108         6. A script can call another script (that will run in its own context, with
109         its own global dictionary) with the L{Blender.Run} module function.
110
111
112 Interaction with users:
113 -----------------------
114
115         Scripts can:
116                 - simply run and exit;
117                 - pop messages, menus and small number and text input boxes;
118                 - draw graphical user interfaces (GUIs) with OpenGL calls and native
119                         program buttons, which stay there accepting user input like any other
120                         Blender window until the user closes them;
121                 - attach themselves to a space's event or drawing code (aka space handlers,
122                         L{check here<API_related>});
123                 - make changes to the 3D View (set visible layer(s), view point, etc);
124                 - grab the main input event queue and process (or pass to Blender) selected
125                         keyboard, mouse, redraw events -- not considered good practice, but still
126                         available for private use;
127                 - tell Blender to execute other scripts (see L{Blender.Run}());
128                 - use external Python libraries, if available.
129
130         You can read the documentation for the L{Window}, L{Draw} and L{BGL} modules
131         for more information and also check the Python site for external modules that
132         might be useful to you.  Note though that any imported module will become a
133         requirement of your script, since Blender itself does not bundle external
134         modules.
135
136 Command line mode:
137 ------------------
138
139         Python was embedded in Blender, so to access BPython modules you need to
140         run scripts from the program itself: you can't import the Blender module
141         into an external Python interpreter.
142
143         On the other hand, for many tasks it's possible to control Blender via
144         some automated process using scripts.  Interested readers should learn about
145         features like "OnLoad" script links, the "-b <blendfile>" (background mode)
146         and "-P <script>" (run script) command line options and API calls like
147         L{Blender.Save}, L{Blender.Load}, L{Blender.Quit} and the L{Library} and
148         L{Render} modules. 
149
150         Note that command line scripts are run before Blender initializes its windows
151         (and in '-b' mode no window will be initialized), so many functions that get
152         or set window related attributes (like most in L{Window}) don't work here.  If
153         you need those, use an ONLOAD script link (see L{Scene.Scene.addScriptLink})
154         instead -- it's also possible to use a command line script to write or set an
155         ONLOAD script link.  Check the L{Blender.mode} module var to know if Blender
156         is being executed in "background" or "interactive" mode.
157
158         L{Click here for command line and background mode examples<API_related>}.
159
160
161 Demo mode:
162 ----------
163
164         Blender has a demo mode, where once started it can work without user
165         intervention, "showing itself off".  Demos can render stills and animations,
166         play rendered or real-time animations, calculate radiosity simulations and
167         do many other nifty things.  If you want to turn a .blend file into a demo,
168         write a script to run the show and link it as a scene "OnLoad" scriptlink.
169         The demo will then be played automatically whenever this .blend file is
170         opened, B{unless Blender was started with the "-y" parameter}.
171
172 The Game Engine API:
173 --------------------
174
175         Blender has a game engine for users to create and play 3d games.  This
176         engine lets programmers add scripts to improve game AI, control, etc, making
177         more complex interaction and tricks possible.  The game engine API is
178         separate from the Blender Python API this document references and you can
179         find its own ref doc in the doc section of the main sites below.
180
181 Blender Data Structures:
182 ------------------------
183
184         Programs manipulate data structures.  Blender python scripts are no exception.
185         Blender uses an Object Oriented architecture.  The BPython interface tries to
186         present Blender objects and their attributes in the same way you see them
187         through the User Interface (the GUI).  One key to BPython programming is
188         understanding the information presented in Blender's OOPS window where Blender
189         objects and their relationships are displayed.
190
191         Each Blender graphic element (Mesh, Lamp, Curve, etc.) is composed from two
192         parts: an Object and ObData. The Object holds information about the position,
193         rotation and size of the element.  This is information that all elements have
194         in common.  The ObData holds information specific to that particular type of
195         element.  
196
197         Each Object has a link to its associated ObData.  A single ObData may be
198         shared by many Objects.  A graphic element also has a link to a list of
199         Materials.  By default, this list is associated with the ObData.
200
201         All Blender objects have a unique name.  However, the name is qualified by the
202         type of the object.  This means you can have a Lamp Object called Lamp.001
203         (OB:Lamp.001) and a Lamp ObData called Lamp.001 (LA:Lamp.001).
204
205         For a more in-depth look at Blender internals, and some understanding of why
206         Blender works the way it does, see the U{Blender Architecture document
207         <http://www.blender3d.org/cms/Blender_Architecture.336.0.html>}.
208
209
210 A note to newbie script writers:
211 --------------------------------
212
213         Interpreted languages are known to be much slower than compiled code, but for
214         many applications the difference is negligible or acceptable.  Also, with
215         profiling (or even simple direct timing with L{Blender.sys.time<Sys.time>}) to
216         identify slow areas and well thought optimizations, the speed can be
217         I{considerably} improved in many cases.  Try some of the best BPython scripts
218         to get an idea of what can be done, you may be surprised.
219
220 @author: The Blender Python Team
221 @requires: Blender 2.46 or newer.
222 @version: 2.46
223 @see: U{www.blender.org<http://www.blender.org>}: documentation and forum
224 @see: U{blenderartists.org<http://blenderartists.org>}: user forum
225 @see: U{projects.blender.org<http://projects.blender.org>}
226 @see: U{blender architecture<http://www.blender3d.org/cms/Blender_Architecture.336.0.html>}: blender architecture document
227 @see: U{www.python.org<http://www.python.org>}
228 @see: U{www.python.org/doc<http://www.python.org/doc>}
229 @see: U{Blending into Python<en.wikibooks.org/wiki/Blender_3D:_Blending_Into_Python>}: User contributed documentation, featuring a blender/python cookbook with many examples.
230
231 @note: the official version of this reference guide is only updated for each
232         new Blender release.  But you can build the current SVN
233         version yourself: install epydoc, grab all files in the
234         source/blender/python/api2_2x/doc/ folder of Blender's SVN and use the
235         epy_docgen.sh script also found there to generate the html docs.
236         Naturally you will also need a recent Blender binary to try the new
237         features.  If you prefer not to compile it yourself, there is a testing
238         builds forum at U{blender.org<http://www.blender.org>}.
239 """