1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
# Blender.Scene module and the Scene PyType object
"""
The Blender.Scene submodule.
Scene
=====
This module provides access to B{Scenes} in Blender.
Example::
import Blender
from Blender import Scene, Object, Camera
#
camdata = Camera.New('ortho') # create new camera data
camdata.setName('newCam')
camdata.setLens(16.0)
camobj = Object.New('Camera') # create a new camera object
camobj.link(camdata) # link data to object
scene = Scene.New('NewScene') # create a new scene
scene.link(camobj) # link object to scene
scene.frameSettings(1, 100 ,1) # set start, end and current frames
scene.setWinSize(640, 480) # set the render window dimensions
scene.makeCurrent() # make this the current scene
"""
def New (name = 'Scene'):
"""
Create a new Scene in Blender.
@type name: string
@param name: The Scene name.
@rtype: Blender Scene
@return: The created Scene.
"""
def Get (name = None):
"""
Get the Scene(s) from Blender.
@type name: string
@param name: The name of a Scene.
@rtype: Blender Scene or a list of Blender Scenes
@return: It depends on the I{name} parameter:
- (name): The Scene with the given I{name};
- (): A list with all Scenes currently in Blender.
"""
def GetCurrent():
"""
Get the currently active Scene in Blender.
@rtype: Blender Scene
@return: The currently active Scene.
"""
def Unlink(scene):
"""
Unlink (delete) a Scene from Blender.
@type scene: Blender Scene
@param scene: The Scene to be unlinked.
"""
class Scene:
"""
The Scene object
================
This object gives access to Scene data in Blender.
@cvar name: The Scene name.
"""
def getName():
"""
Get the name of this Scene.
@rtype: string
"""
def setName(name):
"""
Set the name of this Scene.
@type name: string
@param name: The new name.
"""
def getWinSize():
"""
Get the current x,y resolution of the render window. These are the
dimensions of the image created by the Blender Renderer.
@rtype: list of two ints
@return: [width, height].
"""
def setWinSize(dimensions):
"""
Set the width and height of the render window. These are the dimensions
of the image created by the Blender Renderer.
@type dimensions: list of two ints
@param dimensions: The new [width, height] values.
"""
def copy(duplicate_objects = 1):
"""
Make a copy of this Scene.
@type duplicate_objects: int
@param duplicate_objects: Defines how the Scene children are duplicated:
- 0: Link Objects;
- 1: Link Object Data;
- 2: Full copy.
@rtype: Scene
@return: The copied Blender Scene.
"""
def startFrame(frame = None):
"""
Get (and optionally set) the start frame value.
@type frame: int
@param frame: The start frame. If None, this method simply returns the
current start frame.
@rtype: int
@return: The start frame value.
"""
def endFrame(frame = None):
"""
Get (and optionally set) the end frame value.
@type frame: int
@param frame: The end frame. If None, this method simply returns the
current end frame.
@rtype: int
@return: The end frame value.
"""
def currentFrame(frame = None):
"""
Get (and optionally set) the current frame value.
@type frame: int
@param frame: The current frame. If None, this method simply returns the
current frame value.
@rtype: int
@return: The current frame value.
"""
def frameSettings(start = None, end = None, current = None):
"""
Get (and optionally set) the start, end and current frame values.
@type start: int
@type end: int
@type current: int
@param start: The start frame value.
@param end: The end frame value.
@param current: The current frame value.
@rtype: tuple
@return: The frame values in a tuple: [start, end, current].
"""
def makeCurrent():
"""
Make this Scene the currently active one in Blender.
"""
def link(object):
"""
Link an Object to this Scene.
@type object: Blender Object
@param object: A Blender Object.
"""
def unlink(object):
"""
Unlink an Object from this Scene.
@type object: Blender Object
@param object: A Blender Object.
"""
def getRenderdir():
"""
Get the current directory where rendered images are saved.
@rtype: string
@return: The path to the current render dir
"""
def getBackbufdir():
"""
Get the location of the backbuffer image.
@rtype: string
@return: The path to the chosen backbuffer image.
"""
def getChildren():
"""
Get all objects linked to this Scene.
@rtype: list
@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.
"""
|