diff options
author | Nathan Vegdahl <cessen@cessen.com> | 2010-12-02 05:15:59 +0300 |
---|---|---|
committer | Nathan Vegdahl <cessen@cessen.com> | 2010-12-02 05:15:59 +0300 |
commit | a79931600cc49a7570365afa6bf83ce7ba0404f0 (patch) | |
tree | 2ef2ebdf88bc562d021bc5a98d0d4321f866175d /rigify/README | |
parent | 123dd495bd8bc035a471a836cbed57bec72364d4 (diff) |
Update to the Rigify readme, so explain how to have a rig type generate a
python UI for the generated rig.
Diffstat (limited to 'rigify/README')
-rw-r--r-- | rigify/README | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/rigify/README b/rigify/README index ae26c806..39e8cda6 100644 --- a/rigify/README +++ b/rigify/README @@ -236,3 +236,17 @@ especially with more complex samples. There is a function in utils.py that will generate the code for create_sample() for you, based on a selected armature. The function is called write_metarig() + +GENERATING A PYTHON UI +---------------------- +The generate() method can also, optionally, return python code as a string. +This python code is added to the "rig properties" panel that gets +auto-generated along with the rig. This is useful for exposing things like +IK/FK switches in a nice way to the animator. + +The string must be returned in a list: + +return ["my python code"] + +Otherwise it won't work. + |