Willian Padovani Germano
1ff3066a9a
-- Added two new functions to the Draw module, to display int and float popup buttons:
Both contributed by Campbell Barton, thanks!
-- Fixed a couple warnings.
107 lines
2.8 KiB
Python
107 lines
2.8 KiB
Python
# The Blender Module
|
|
|
|
# The module files in this folder are used to create the API documentation.
|
|
# Doc system used: epydoc - http://epydoc.sf.net
|
|
# command line:
|
|
|
|
# epydoc -o BPY_API_230 --url "http://www.blender.org" -t Blender.py \
|
|
# -n "Blender" --no-private --no-frames Blender.py \
|
|
# Types.py Scene.py Object.py NMesh.py Material.py Camera.py Lamp.py \
|
|
# Armature.py Metaball.py Effect.py Curve.py Ipo.py World.py BGL.py Window.py \
|
|
# Draw.py Image.py Text.py Lattice.py Texture.py Registry.py Sys.py Mathutils.py
|
|
|
|
"""
|
|
The main Blender module.
|
|
|
|
The Blender Python API Reference
|
|
================================
|
|
|
|
Submodules:
|
|
-----------
|
|
|
|
- L{Armature}
|
|
- L{Bone}
|
|
- L{NLA} (new)
|
|
- L{BGL}
|
|
- L{Camera}
|
|
- L{Curve}
|
|
- L{Draw}
|
|
- L{Effect}
|
|
- L{Image}
|
|
- L{Ipo}
|
|
- L{Lamp}
|
|
- L{Lattice}
|
|
- L{Library} (new)
|
|
- L{Material}
|
|
- L{Mathutils} (new)
|
|
- L{Metaball}
|
|
- L{NMesh}
|
|
- L{Noise} (new)
|
|
- L{Object}
|
|
- L{Registry}
|
|
- L{Scene}
|
|
- L{Render} (new)
|
|
- L{Text}
|
|
- L{Texture}
|
|
- L{Types}
|
|
- L{Window}
|
|
- L{World}
|
|
- L{sys<Sys>} (added time function)
|
|
|
|
Introduction:
|
|
-------------
|
|
|
|
This Reference documents the Blender Python API, a growing collection of
|
|
Python modules (libs) that give access to part of the program's internal data
|
|
and functions.
|
|
|
|
Through scripting, Blender can be extended in realtime. Possibilities range
|
|
from simple functionality to importers / exporters and even more complex
|
|
"applications". Blender scripts are written in
|
|
U{Python <www.python.org>}, an impressive high level, multi-paradigm,
|
|
open-source language.
|
|
|
|
@author: The Blender Python Team
|
|
@requires: Blender 2.33 or newer.
|
|
@version: 2.33a
|
|
@see: U{www.blender.org<http://www.blender.org>}
|
|
@see: U{projects.blender.org<http://projects.blender.org>}
|
|
@see: U{www.python.org<http://www.python.org>}
|
|
@see: U{www.python.org/doc<http://www.python.org/doc>}
|
|
"""
|
|
|
|
def Set (request, data):
|
|
"""
|
|
Update settings in Blender.
|
|
@type request: string
|
|
@param request: The setting to change:
|
|
- 'curframe': the current animation frame
|
|
@type data: int
|
|
@param data: The new value.
|
|
"""
|
|
|
|
def Get (request):
|
|
"""
|
|
Retrieve settings from Blender.
|
|
@type request: string
|
|
@param request: The setting data to be returned:
|
|
- 'curframe': the current animation frame
|
|
- 'curtime' : the current animation time
|
|
- 'staframe': the start frame of the animation
|
|
- 'endframe': the end frame of the animation
|
|
- 'filename': the name of the last file read or written
|
|
- 'version' : the Blender version number
|
|
@return: The requested data.
|
|
"""
|
|
|
|
def Redraw ():
|
|
"""
|
|
Redraw all 3D windows.
|
|
"""
|
|
|
|
def ReleaseGlobalDict (bool = None):
|
|
"""
|
|
@depreciated: this function doesn't work anymore and will be removed.
|
|
Look at the L{Registry} submodule for a better alternative.
|
|
"""
|