Yamyam: 1版をインポートしました

2018-06-28T21:23:12Z

1版をインポートしました

2018年5月29日 (火) 07:13にwiki>Raaによる

2018-05-29T07:13:08Z

新規ページ

<div style="width:640px; margin:0 auto">

= Scripting =

= Tutorials =

* '''Video:''' [https://vimeo.com/28203314 Introduction to Scripting with Python in Blender]
* '''Video:''' [https://www.youtube.com/watch?v=ZZWSvUgR38Y Task Automation with Python Scripting in Blender]
* [https://wiki.python.org/moin/BeginnersGuide/NonProgrammers Python for Non-Programmers]
* [https://docs.blender.org/api/blender_python_api_current/info_quickstart.html Blender/Python Quickstart]
* [https://docs.blender.org/api/blender_python_api_current/ Blender Documentation Contents]

= Global Variables =

{{User:Raa/Templates/Doc
|'''menu'''
|desc=Name of the active menu
}}

{{User:Raa/Templates/Doc
|'''slot'''
|desc=Name of the active slot
}}

{{User:Raa/Templates/Doc
|'''C'''
|desc=bpy.context
}}

{{User:Raa/Templates/Doc
|'''D'''
|desc=bpy.data
}}

{{User:Raa/Templates/Doc
|'''O'''
|desc=bpy.ops
}}

{{User:Raa/Templates/Doc
|'''T'''
|desc=bpy.types
}}

{{User:Raa/Templates/Doc
|'''P'''
|desc=bpy.props
}}

{{User:Raa/Templates/Doc
|'''L'''
|desc=Current [https://docs.blender.org/api/blender_python_api_current/bpy.types.UILayout.html UILayout] object
|ex=<source lang="python">
L.box().label("My Label")
</source>
}}

{{User:Raa/Templates/Doc
|'''E'''
|desc=Current [https://docs.blender.org/api/blender_python_api_current/bpy.types.Event.html Event] object
|ex=<source lang="python">
E.ctrl and E.shift and message_box("Ctrl+Shift")
</source>
}}

= Global Functions =

== Common Functions ==

{{User:Raa/Templates/Doc
|'''execute_script''' (path, **kwargs)
|desc=Execute external python script
|args='''path''' - Path to file
|returns=Value of local variable ''return_value'' or ''True''
|ex=
Display 'Hello World!' message:
<source lang="python">
execute_script("scripts/hello_world.py", msg="Hello World!")
</source>
scripts/hello_world.py:
<source lang="python">
message_box(kwargs["msg"])
</source>
Display 'Hi!' message:
<source lang="python">
message_box(execute_script("scripts/hi.py"))
</source>
scripts/hi.py:
<source lang="python">
return_value = "Hi!"
</source>
}}

{{User:Raa/Templates/Doc
|'''props''' (name{{=}}None, value{{=}}None)
|desc=Get or set the value of the Property
|args=
<div>'''name''' - Name of the property</div>
<div>'''value''' - New value of the property</div>
|returns=The value of the Property by its name, if ''value'' is ''None'', ''True'' otherwise
|ex=<source lang="python">
value = props("MyProperty")
value = props().MyProperty
props("MyProperty", value)
props().MyProperty = value
</source>
}}

{{User:Raa/Templates/Doc
|'''paint_settings''' ()
|returns=Context sensitive paint settings
|ex=<source lang="python">
ps = paint_settings(); ps and L.template_ID_preview(ps, 'brush')
</source>
}}

{{User:Raa/Templates/Doc
|'''find_by''' (collection, key, value)
|desc=Find the first item in ''collection'' by ''key'' value
|returns=Collection item if found, ''None'' otherwise
|ex=<source lang="python">
m = find_by(C.active_object.modifiers, "type", 'SUBSURF')
</source>
}}

{{User:Raa/Templates/Doc
|'''setattr''' (object, name, value)
|desc=Same as [https://docs.python.org/3/library/functions.html#setattr setattr()], but returns ''True''
|returns=True
}}

== Command Tab Functions ==

{{User:Raa/Templates/Doc
|'''open_menu''' (name, slot{{=}}None, **kwargs)
|desc=Open menu, pie menu, popup dialog or execute stack key, sticky key, modal operator or macro operator
|args=
<div>'''name''' - Name of the menu</div>
<div>'''slot''' - Index or name of the ''Stack Key's'' slot you want to execute</div>
<div>'''kwargs''' - Allows to pass the arguments to Modal/Macro Operator and use them as local variables</div>
|returns=''True'' if the menu exists, ''False'' otherwise
|ex=Open the menu depending on the active object's type:
<source lang="python">
open_menu("Lamp Pie Menu" if C.active_object.type == 'LAMP' else "Object Pie Menu")
</source>
Call ''My Stack Key's'' slot depending on {{Shortcut|Ctrl}} key modifier:
<source lang="python">
open_menu("My Stack Key", "Ctrl slot" if E.ctrl else "Shift slot")
</source>
}}

{{User:Raa/Templates/Doc
|'''toggle_menu''' (name, value{{=}}None)
|desc=Enable or disable menu
|args=
<div>'''name''' - Name of the menu</div>
<div>'''value''' - ''True'' - enable, ''False'' - disable, ''None'' - toggle</div>
|returns=''True'' if the menu exists, ''False'' otherwise
}}

{{User:Raa/Templates/Doc
|'''tag_redraw''' (area{{=}}None, region{{=}}None)
|desc=Redraw UI
|args=
<div>'''area''' - [https://docs.blender.org/api/blender_python_api_current/bpy.types.Area.html#bpy.types.Area.type Type] of the areas to redraw. Redraw all areas if ''None''.</div>
<div>'''region''' - [https://docs.blender.org/api/blender_python_api_current/bpy.types.Region.html#bpy.types.Region.type Type] of the regions to redraw. Redraw all regions if ''None''.</div>
|returns=''True''
}}

{{User:Raa/Templates/Doc
|'''close_popups''' ()
|desc=Close all popups
|returns=''True''
}}

{{User:Raa/Templates/Doc
|'''overlay''' (text, **kwargs)
|desc=Draw overlay message
|args=
<div>'''text''' - Message to display</div>
<div>'''alignment''' - Alignment, enum in ['TOP', 'TOP_LEFT', 'TOP_RIGHT', 'BOTTOM', 'BOTTOM_LEFT', 'BOTTOM_RIGHT']</div>
<div>'''duration''' - Duration</div>
<div>'''offset_x''' - X Offset</div>
<div>'''offset_y''' - Y Offset</div>
|returns=''True''
}}

{{User:Raa/Templates/Doc
|'''message_box''' (text, icon{{=}}'INFO', title{{=}}"Pie Menu Editor")
|desc=Show message box
|args='''text''' - Message to display
|returns=''True''
}}

{{User:Raa/Templates/Doc
|'''input_box''' (func{{=}}None, prop{{=}}None)
|desc=Show input box
|args=
<div>'''func''' - Function to call</div>
<div>'''prop''' - Path to property</div>
|returns=''True''
|ex=Rename object:
<source lang="python">
input_box(prop="C.active_object.name")
</source>
Display input value:
<source lang="python">
input_box(func=lambda value: overlay(value))
</source>
}}

== Custom Tab Functions ==

{{User:Raa/Templates/Doc
|'''draw_menu''' (name, frame{{=}}True, dx{{=}}0, dy{{=}}0)
|desc=Draw popup dialog inside another popup dialog or a pie menu
|args=
<div>'''name''' - Name of the menu</div>
<div>'''frame''' - Use frame</div>
<div>'''dx''' - Horizontal offset</div>
<div>'''dy''' - Vertical offset</div>
|returns=''True'' if the popup dialog exists, ''False'' otherwise
}}

{{User:Raa/Templates/Doc
|'''operator''' (layout, operator, text{{=}}"", icon{{=}}'NONE', emboss{{=}}True, icon_value{{=}}0, **kwargs)
|desc=Same as [https://docs.blender.org/api/blender_python_api_current/bpy.types.UILayout.html#bpy.types.UILayout.operator UILayout.operator()], but allows to fill operator properties.
|args=
<div>'''layout''' - Layout</div>
<div>'''operator''' - Identifier of the operator</div>
|returns=[https://docs.blender.org/api/blender_python_api_current/bpy.types.OperatorProperties.html OperatorProperties] object
|ex=
<source lang="python">
operator(L, "wm.context_set_int", "Material Slot 1", data_path="active_object.active_material_index", value=0)
</source>
Same as:
<source lang="python">
op = L.operator("wm.context_set_int", "Material Slot 1")
op.data_path = "active_object.active_material_index"
op.value = 0
</source>
}}

{{User:Raa/Templates/Doc
|'''custom_icon''' (filename)
|desc=Icon value
|args=
<div>'''filename''' - Icon filename without extension</div>
|returns=Returns value of the custom icon
|ex=Display text message with custom (''pie_menu_editor/icons/p1.png'') icon.
<source lang="python">
L.label("My Custom Icon", icon_value=custom_icon("p1"))
</source>
}}

{{User:Raa/Templates/Doc
|'''panel''' (id, frame{{=}}True, header{{=}}True, expand{{=}}None)
|desc=Draws panel by it's ID.
|args=
<div>'''id''' - ID of the panel</div>
<div>'''frame''' - Use frame</div>
<div>'''header''' - Draw header</div>
<div>'''expand''' - ''True'' - expanded, ''False'' - collapsed, ''None'' - use current state</div>
|returns=True
|ex=<source lang="python">
panel("MATERIAL_PT_context_material", True, True, True)
</source>
}}

= Auto-run Scripts =

The addon allows you to write python scripts that will be executed when you start Blender. Just copy ''.py'' files, folders or symlinks to ''pie_menu_editor/scripts/autorun'' folder.

= Custom Global Functions =

To use your functions in PME you need to copy your scipt to ''pie_menu_editor/scripts/autorun'' folder and register the functions using ''pme.context.add_global()'':
<source lang="python">
def hello_world():
print("Hello World")

pme.context.add_global("hello", hello_world)
</source>

Now you can use ''hello()'' function in ''Command, Custom'' tabs and external scripts.

</div>

← 古い版	2018年6月28日 (木) 21:23時点における版
(相違点なし)

利用者:Raa/Addons/Pie Menu Editor/Scripting - 版の履歴

Yamyam: 1版 をインポートしました

2018年5月29日 (火) 07:13にwiki>Raaによる

Yamyam: 1版をインポートしました