diff options
author | Willian Padovani Germano <wpgermano@gmail.com> | 2004-06-24 13:43:13 +0400 |
---|---|---|
committer | Willian Padovani Germano <wpgermano@gmail.com> | 2004-06-24 13:43:13 +0400 |
commit | 61efb63b0c7e4bdb62d2d4007205db34ed627623 (patch) | |
tree | a1ba4ec29dbd028b9bd930c81d67284affcab3b9 /source/blender/python/api2_2x/doc/Scene.py | |
parent | 5b57d007a4f123a23f704a8d4aff431588e439b7 (diff) |
BPython:
- Added function Blender.Save(filename) to save .blend files.
- Added scriptlink-related methods (get, clear, add) to Scene and Materials. Will still add method remove and add these methods to World, Object, Camera and Lamp.
- Updates and small fixes in docs.
Diffstat (limited to 'source/blender/python/api2_2x/doc/Scene.py')
-rw-r--r-- | source/blender/python/api2_2x/doc/Scene.py | 71 |
1 files changed, 65 insertions, 6 deletions
diff --git a/source/blender/python/api2_2x/doc/Scene.py b/source/blender/python/api2_2x/doc/Scene.py index f2ae61270d7..232ce33d567 100644 --- a/source/blender/python/api2_2x/doc/Scene.py +++ b/source/blender/python/api2_2x/doc/Scene.py @@ -3,6 +3,8 @@ """ The Blender.Scene submodule. +B{New}: scriptLink methods: L{Scene.getScriptLinks}, ... + Scene ===== @@ -91,12 +93,12 @@ class Scene: def getWinSize(): """ - @warn: B{Depricated}: use RenderData.imageSizeX() and RenderData.imageSizeY() + @warn: B{Deprecated}: use RenderData.imageSizeX() and RenderData.imageSizeY() """ def setWinSize(dimensions): """ - @warn: B{Depricated}: use RenderData.imageSizeX() and RenderData.imageSizeY + @warn: B{Deprecated}: use RenderData.imageSizeX() and RenderData.imageSizeY """ def copy(duplicate_objects = 1): @@ -113,22 +115,22 @@ class Scene: def startFrame(frame = None): """ - @warn: B{Depricated}: use RenderData.startFrame() + @warn: B{Deprecated}: use RenderData.startFrame() """ def endFrame(frame = None): """ - @warn: B{Depricated}: use RenderData.endFrame() + @warn: B{Deprecated}: use RenderData.endFrame() """ def currentFrame(frame = None): """ - @warn: B{Depricated}: use RenderData.currentFrame + @warn: B{Deprecated}: use RenderData.currentFrame """ def frameSettings(start = None, end = None, current = None): """ - @warn: B{Depricated}: use RenderData.startFrame(), RenderData.endFrame, RenderData.currentFrame + @warn: B{Deprecated}: use RenderData.startFrame(), RenderData.endFrame, RenderData.currentFrame """ def makeCurrent(): @@ -147,6 +149,37 @@ class Scene: The "full" update is a recent addition to this method. """ + def getRenderdir(): + """ + @warn: B{Deprecated}: use RenderData.getRenderPath() + """ + + def getBackbufdir(): + """ + @warn: B{Deprecated}: use RenderData.getBackbufPath() + """ + + def getChildren(): + """ + Get all objects linked to this Scene. + @rtype: list of Blender Objects + @return: A list with all Blender Objects linked to this Scene. + """ + + def getCurrentCamera(): + """ + Get the currently active Camera for this Scene. + @rtype: Blender Camera + @return: The currently active Camera. + """ + + def setCurrentCamera(camera): + """ + Set the currently active Camera in this Scene. + @type camera: Blender Camera + @param camera: The new active Camera. + """ + def link(object): """ Link an Object to this Scene. @@ -160,3 +193,29 @@ class Scene: @type object: Blender Object @param object: A Blender Object. """ + + def getScriptLinks (event): + """ + Get a list with this Scene's script links of type 'event'. + @type event: string + @param event: "FrameChanged", "OnLoad" or "Redraw". + @rtype: list + @return: a list with Blender L{Text} names (the script links of the given + 'event' type) or None if there are no script links at all. + """ + + def clearScriptLinks (): + """ + Delete all this Scene's script links. + @rtype: bool + @return: 0 if some internal problem occurred or 1 if successful. + """ + + def addScriptLink (text, event): + """ + Add a new script link to this Scene. + @type text: string + @param text: the name of an existing Blender L{Text}. + @type event: string + @param event: "FrameChanged", "OnLoad" or "Redraw". + """ |