* Added more doc files for epydoc and a test for the camera module.
* Moved public declarations in camera and lamp to a new file: bpy_types.h. * Fixed minor bugs in material, rgbTuple and Lamp + other minor changes. * Made part of the changes to conform to decided naming conventions.
This commit is contained in:
58
source/blender/python/api2_2x/doc/Blender.py
Normal file
58
source/blender/python/api2_2x/doc/Blender.py
Normal file
@@ -0,0 +1,58 @@
|
||||
# The Blender Module
|
||||
|
||||
"""
|
||||
Here goes the Introduction to Blender Python
|
||||
|
||||
Let's see::
|
||||
- What scripting is, why have it
|
||||
- What is Python, links
|
||||
- More about what scripting can give us
|
||||
- Overview of the Blender Python modules
|
||||
- Links to Blender, Blender Python, later: script lists
|
||||
@author: The Blender Python Team
|
||||
@requires: Blender 2.28 or newer, Python 2.? (2.0, 2.1, 2.2 ???) or newer
|
||||
@version: 0.1
|
||||
@see: U{www.blender.org<http://www.blender.org>}
|
||||
@see: U{projects.blender.org<http://projects.blender.org>}
|
||||
"""
|
||||
|
||||
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):
|
||||
"""
|
||||
Define whether the global Python Interpreter dictionary should be cleared
|
||||
after the script is run. Default is to clear (non-zero bool).
|
||||
@type bool: an int, actually
|
||||
@param bool: The flag to release (non-zero bool) or not (bool = 0) the dict.
|
||||
if no argument is passed, this function simply returns the current
|
||||
behavior.
|
||||
@rtype: int
|
||||
@return: A bool value (0 or 1) telling the current behavior.
|
||||
"""
|
Reference in New Issue
Block a user