Skip to content
This repository has been archived by the owner on Oct 7, 2021. It is now read-only.

Commit

Permalink
Docs: Animbits docs finished #16
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcampos committed Sep 20, 2018
1 parent 011e22e commit 9009b9d
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
2 changes: 1 addition & 1 deletion animbits
23 changes: 18 additions & 5 deletions docs/source/animbitsUserDocumentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ In the ST main control we can find a falloff channel to control the area of defo
:align: center
:scale: 95%


SoftTweak Manager GUI
---------------------

Expand All @@ -41,14 +42,18 @@ By default the SoftTweak is design to be used by shot and not part of a rig. How


**File Menu:**

* **Export Selected:** Exports selected ST from the list
* **Export All:** Exports all the ST from the list. If search filter is used, will not affect the export. But export will make a distinction between regular SoftTweak and asset SoftTweak
* **Import:** Import ST configuration from a file.


**GUI:**

* **Search Filter:** (1) Quick search filter of the SoftTweak list.
* **SoftTweaks List:** (2) ST selection list.
* **Create Auto Tweak:** Create a tweak based on the current selection.

1. Select the objects to apply the ST
2. Last element selected should be a control. This will be the parent of the ST. Also the ST will take the Name and the group(set) from the parent
3. Click Crete Auto Tweak
Expand All @@ -69,13 +74,21 @@ By default the SoftTweak is design to be used by shot and not part of a rig. How
* **Suffix Name:** (3) Suffix name for the new ST.


API:
API
-----
To import a softTweak configuration from script editor or Shifter Custom Step:

.. codeblock:: python
from mgear.animbits import softTweaks
softTweaks.importConfigurationFromFile(filePath= path to the .smt configuration file)
.. code-block:: python
# To import a softTweak configuration from script editor or Shifter Custom Step:
from mgear.animbits import softTweaks as st
st.importConfigurationFromFile(filePath= path to the .smt configuration file)
# to export configuration
# list the softtweaks in the scene
softtweaks = st._listSoftModTweaks(is_asset=False)
# export
st.exportConfiguration(softtweaks)
Smart reset Attribute/SRT
Expand Down
2 changes: 1 addition & 1 deletion excons
Submodule excons updated 1 files
+9 −24 __init__.py

0 comments on commit 9009b9d

Please sign in to comment.