Package bpy :: Package ops :: Module wm
[hide private]
[frames] | no frames]

Module wm

Functions [hide private]
 
call_menu(name='')
(undocumented operator)
 
context_cycle_enum(path='', reverse=False)
Toggle a context value.
 
context_cycle_int(path='', reverse=False)
Set a context value.
 
context_set_boolean(path='', value=True)
Set a context value.
 
context_set_enum(path='', value='')
Set a context value.
 
context_set_float(path='', value=0.0)
Set a context value.
 
context_set_int(path='', value=0)
Set a context value.
 
context_set_string(path='', value='')
Set a context value.
 
context_toggle(path='')
Toggle a context value.
 
context_toggle_enum(path='', value_1='', value_2='')
Toggle a context value.
 
debug_menu(debugval=0)
Open a popup to set the debug level.
 
doc_edit(doc_id='', doc_new='')
Load online reference docs
 
doc_view(doc_id='')
Load online reference docs
 
exit_blender()
Quit Blender.
 
keyconfig_export(path='')
Export key configuration to a python script.
 
keyitem_add()
Add key map item.
 
keyitem_remove()
Remove key map item.
 
keymap_edit()
Edit key map.
 
keymap_restore(all=False)
Restore key map(s).
 
link_append(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=1, link=True, autoselect=True, active_layer=True, relative_paths=True, files=None)
Link or Append from a Library .blend file
 
memory_statistics()
Print memory statistics to the console.
 
open_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, load_ui=True)
Open a Blender file.
 
open_recentfile(file='/shared/durian/Tests/Rigging/arm_example_7.blend')
Open recent files list.
 
open_recentfile_splash(file='/shared/durian/Tests/Rigging/arm_example_7.blend')
Open recent files list.
 
properties_add(path='')
Internal use (edit a property path)
 
properties_edit(path='', property='', value='', min=0.0, max=1.0, description='')
Internal use (edit a property path)
 
properties_remove(path='', property='')
Internal use (edit a property path)
 
read_homefile(factory=False)
Open the default file (doesn't save the current file).
 
recover_auto_save(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=False, filemode=8)
Open an automatically saved file to recover it.
 
recover_last_session()
Open the last closed file ("quit.blend").
 
redraw_timer(type='DRAW', iterations=10)
Simple redraw timer to test the speed of updating the interface.
 
reload_scripts()
Load online reference docs
 
save_as_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, compress=False)
Save the current file in the desired location.
 
save_homefile()
Make the current file the default .blend file.
 
save_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, compress=False)
Save the current Blender file.
 
search_menu()
(undocumented operator)
 
splash()
Opens a blocking popup region with release info
 
window_duplicate()
Duplicate the current Blender window.
 
window_fullscreen_toggle()
Toggle the current window fullscreen.
Function Details [hide private]

call_menu(name='')

 

(undocumented operator)

Parameters:
  • name (string)

context_cycle_enum(path='', reverse=False)

 

Toggle a context value.

Parameters:
  • path (string)
  • reverse (boolean)

context_cycle_int(path='', reverse=False)

 

Set a context value. Useful for cycling active material, vertex keys, groups' etc.

Parameters:
  • path (string)
  • reverse (boolean)

context_set_boolean(path='', value=True)

 

Set a context value.

Parameters:
  • path (string)
  • value (boolean)

context_set_enum(path='', value='')

 

Set a context value.

Parameters:
  • path (string)
  • value (string)

context_set_float(path='', value=0.0)

 

Set a context value.

Parameters:
  • value (float) - Assignment value in (-inf, inf)
  • path (string)

context_set_int(path='', value=0)

 

Set a context value.

Parameters:
  • value (int) - Assign value in (-inf, inf)
  • path (string)

context_set_string(path='', value='')

 

Set a context value.

Parameters:
  • path (string)
  • value (string)

context_toggle(path='')

 

Toggle a context value.

Parameters:
  • path (string)

context_toggle_enum(path='', value_1='', value_2='')

 

Toggle a context value.

Parameters:
  • path (string)
  • value_1 (string)
  • value_2 (string)

debug_menu(debugval=0)

 

Open a popup to set the debug level.

Parameters:
  • debugval (int) - in (-10000, 10000)

doc_edit(doc_id='', doc_new='')

 

Load online reference docs

Parameters:
  • doc_id (string)
  • doc_new (string)

doc_view(doc_id='')

 

Load online reference docs

Parameters:
  • doc_id (string)

keyconfig_export(path='')

 

Export key configuration to a python script.

Parameters:
  • path (string)

keymap_restore(all=False)

 

Restore key map(s).

Parameters:
  • all (boolean)

link_append(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=1, link=True, autoselect=True, active_layer=True, relative_paths=True, files=None)

 

Link or Append from a Library .blend file

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • files (collection)
  • filter_text (boolean)
  • filter_sound (boolean)
  • autoselect (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • active_layer (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • link (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • relative_paths (boolean)
  • filter_folder (boolean)

open_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, load_ui=True)

 

Open a Blender file.

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • load_ui (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

open_recentfile(file='/shared/durian/Tests/Rigging/arm_example_7.blend')

 

Open recent files list.

Parameters:
  • file (enum) - in ()

open_recentfile_splash(file='/shared/durian/Tests/Rigging/arm_example_7.blend')

 

Open recent files list.

Parameters:
  • file (enum) - in ()

properties_add(path='')

 

Internal use (edit a property path)

Parameters:
  • path (string)

properties_edit(path='', property='', value='', min=0.0, max=1.0, description='')

 

Internal use (edit a property path)

Parameters:
  • min (float) - in (-inf, inf)
  • max (float) - in (-inf, inf)
  • description (string)
  • value (string)
  • path (string)
  • property (string)

properties_remove(path='', property='')

 

Internal use (edit a property path)

Parameters:
  • path (string)
  • property (string)

read_homefile(factory=False)

 

Open the default file (doesn't save the current file).

Parameters:
  • factory (boolean)

recover_auto_save(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=False, filemode=8)

 

Open an automatically saved file to recover it.

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

redraw_timer(type='DRAW', iterations=10)

 

Simple redraw timer to test the speed of updating the interface.

Parameters:
  • type (enum) - in (DRAW, DRAW_SWAP, DRAW_WIN, DRAW_WIN_SWAP, ANIM_STEP, UNDO)
  • iterations (int) - Number of times to redraw in (1, inf)

save_as_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, compress=False)

 

Save the current file in the desired location.

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • compress (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

save_mainfile(path='', filename='', directory='', filter_blender=True, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=8, compress=False)

 

Save the current Blender file.

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • compress (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)