Window

CameraView(camtov3d=0)

Parameters:

camtov3d - if nonzero it's the camera that gets positioned at the current view, instead of the view being changed to that of the camera.
           (type=int (bool))

DrawProgressBar(done, text)

Parameters:

done - A float in [0.0, 1.0] that tells the advance in the progress bar.
           (type=float)

text - Info about what is currently being done "behind the scenes".
           (type=string)

EditMode(enable=-1)

Get and optionally set the current edit mode status: in or out.

 in_editmode = Window.EditMode()
 # MUST leave edit mode before changing an active mesh:
 if in_editmode: Window.EditMode(0)
 # ...
 # make changes to the mesh
 # ...
 # be nice to the user and return things to how they were:
 if in_editmode: Window.EditMode(1)

Parameters:

enable - get/set current status:

• -1: just return current status (default);
• 0: leave edit mode;

• 1: enter edit mode.

  It's not an error to try to change to a state that is already the current one, the function simply ignores the request.

           (type=int)

Returns:

0 if Blender is not in edit mode right now, 1 otherwise.
           (type=int (bool))

Warning: this is an important function. NMesh operates on normal Blender meshes, not edit mode ones. If a script changes an active mesh while in edit mode, when the user leaves the mode the changes will be lost, because the normal mesh will be rebuilt based on its unchanged edit mesh.

FileSelector(callback, title='SELECT FILE', filename='<default>')

 import Blender
 #
 def my_function(filename):
   print 'The selected file was:', filename
 #
 Blender.Window.FileSelector (my_function, 'SAVE FILE')

Parameters:

callback - The function that must be provided to FileSelector() and will receive the selected filename as parameter.
           (type=function that accepts a string: f(str))

title - The string that appears in the button to confirm the selection and return from the file selection window.
           (type=string)

filename - A filename. This defaults to Blender.Get('filename').
           (type=string)

GetAreaID()

GetAreaSize()

Returns:

a [width, height] list.
           (type=list with two ints)

Note: the returned values are 1 pixel bigger than what GetScreenInfo returns for the 'vertices' of the same area.

GetCursorPos()

Returns:

the current position: [x, y, z].
           (type=list of three floats)

GetKeyQualifiers()

Returns:

an or'ed combination of values in Window.Qual.
           (type=int)

GetMouseButtons()

Returns:

an or'ed flag with the currently pressed buttons.
           (type=int)

GetMouseCoords()

Returns:

a [x, y] list with the coordinates.
           (type=list with two ints)

GetScreenInfo(type=-1, rect='win', screen='')

Parameters:

type - the space type (see Window.Types) to restrict the results to. If -1 (the default), info is reported about all available areas.
           (type=int)

rect - the rectangle of interest. This defines if the corner coordinates returned will refer to:

• the whole area: 'total'
• only the header: 'header'
• only the window content part (default): 'win'

           (type=string)

screen - the name of an available screen. The current one is used by default.
           (type=string)

Returns:

a list of dictionaries, one for each area in the screen. Each dictionary has these keys (all values are ints):

• 'vertices': [xmin, ymin, xmax, ymax] area corners;
• 'win': window type, see Types;
• 'id': this area's id.

           (type=list of dictionaries)

GetScreens()

Returns:

a list of names that can be passed to SetScreen.
           (type=list of strings)

GetScreenSize()

Returns:

a [width, height] list.
           (type=list with two ints)

GetViewMatrix()

Returns:

the current matrix.
           (type=4x4 float matrix)

GetViewOffset(ofs)

Returns:

a list with three floats: [x,y,z].
           (type=list of floats)

GetViewQuat()

Returns:

the quaternion as a list of four float values.
           (type=list of floats)

GetViewVector()

Returns:

the current vector: [x, y, z].
           (type=list of three floats)

ImageSelector(callback, title='SELECT IMAGE', filename='<default>')

 import Blender
 #
 def my_function(imagename):
   print 'The selected image was:', imagename
 #
 Blender.Window.ImageSelector (my_function, 'LOAD IMAGE')

Parameters:

callback - The function that must be provided to ImageSelector() and will receive the selected filename as parameter.
           (type=function that accepts a string: f(str))

title - The string that appears in the button to confirm the selection and return from the image selection window.
           (type=string)

filename - A filename. This defaults to Blender.Get('filename').
           (type=string)

QAdd(win, event, val, after=0)

Parameters:

win - the window id, see GetScreenInfo.
           (type=int)

event - the event to add, see events in Draw.
           (type=positive int)

val - 1 for a key press, 0 for a release.
           (type=int)

after - if nonzero the event is put after the current queue and added later.
           (type=int (bool))

QHandle(winId)

Parameters:

winId - the window id, see GetScreenInfo.
           (type=int)

Note: see QAdd for how to send events to a particular window.

QRead()

Get the next pending event from the event queue.

# let's catch all events and move the 3D Cursor when user presses
# the left mouse button.
from Blender import Draw, Window
done = 0
while not done:  # enter a 'get event' loop
  evt, val = Window.QRead() # catch next event
  if evt in [Draw.ESCKEY, Draw.QKEY]: done = 1 # end loop
  elif evt == Draw.SPACEKEY:
    Draw.PupMenu("Hey!|What did you expect?")
  elif evt == Draw.Redraw: # catch redraw events to handle them
    Window.RedrawAll() # redraw all areas
  elif evt == Draw.LEFTMOUSE and val: # left button pressed
    v3d = Window.ScreenInfo(Window.Types.VIEW3D)
    id = v3d[0]['id'] # get the (first) VIEW3D's id
    Window.QAdd(id, evt, 1) # add the caught mouse event to it
    # actually we should check if the event happened inside that area,
    # using Window.GetMouseCoords() and v3d[0]['vertices'] values.
    Window.QHandle(id) # process the event
    # do something fancy like putting some object where the
    # user positioned the 3d cursor, then:
    Window.Redraw() # show the change in the VIEW3D areas.

Returns:

[event, val], where:

• event: int - the key or mouse event (see Draw);
• val: int - 1 for a key press, 0 for a release, new x or y coordinates for mouse events.

           (type=list)

QRedrawAll()

QTest()

Returns:

1 if there are pending events, 0 otherwise.
           (type=bool)

Redraw(spacetype='<Types.VIEW3D>')

Parameters:

spacetype - the space type, see Types. By default the 3d Views are redrawn. If spacetype < 0, all currently visible spaces are redrawn.
           (type=int)

RedrawAll()

SetCursorPos(coords)

Parameters:

coords - The new x, y, z coordinates.
           (type=3 floats or a list of 3 floats)

Note: if visible, the 3d View must be redrawn to display the change. This can be done with Redraw.

SetKeyQualifiers(qual)

Parameters:

qual - an or'ed combination of values in Window.Qual.
           (type=int)

Returns:

the current state, that should be equal to 'qual'.
           (type=int)

Warning: remember to reset the qual keys to 0 once they are not necessary anymore.

SetMouseCoords(coords)

Parameters:

coords - can be passed as x, y or [x, y] and are clamped to stay inside the screen. If not given they default to the coordinates of the middle of the screen.
           (type=(list of) two ints)

SetScreen(name)

Parameters:

name - the name of an existing screen. Use GetScreens to get a list with all screen names.
           (type=string)

SetViewQuat(quat)

Parameters:

quat - four floats or a list of four floats.
           (type=floats or list of floats)

ViewLayer(layers=[])

Parameters:

layers - a list with indexes of the layers that will be visible. Each index must be in the range [1, 20]. If not given or equal to [], the function simply returns the visible ones without changing anything.
           (type=list of ints)

Returns:

the currently visible layers.
           (type=list of ints)

WaitCursor(bool)

Set cursor to wait or back to normal mode.

 Blender.Window.WaitCursor(1)
 Blender.sys.sleep(2000) # do something that takes some time
 Blender.Window.WaitCursor(0) # back

Parameters:

bool - if nonzero the cursor is set to wait mode, otherwise to normal mode.
           (type=int (bool))

Note: when the script finishes execution, the cursor is set to normal by Blender itself.