412 lines
19 KiB
HTML
412 lines
19 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en" data-content_root="./">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Pose Wrangler Overview" href="overview.html" />
|
||
|
||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||
<title>Pose Driver Connect Documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="#"><div class="brand">Pose Driver Connect Documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
|
||
|
||
<div class="sidebar-logo-container">
|
||
<img class="sidebar-logo" src="_static/epic.png" alt="Logo"/>
|
||
</div>
|
||
|
||
<span class="sidebar-brand-text">Pose Driver Connect Documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Pose Wrangler Overview</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to 2.0.0+</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="skeleton_config.html">Skeleton Configs</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="extensions.html">Extensions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container">
|
||
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<section id="pose-driver-connect-documentation">
|
||
<h1>Pose Driver Connect Documentation<a class="headerlink" href="#pose-driver-connect-documentation" title="Link to this heading">#</a></h1>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Pose Wrangler Overview</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#ui-overview">UI Overview</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to 2.0.0+</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="skeleton_config.html">Skeleton Configs</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="skeleton_config.html#retargeting-exporting">Retargeting/Exporting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="skeleton_config.html#mirror-mapping">Mirror Mapping</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="extensions.html">Extensions</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="extensions.html#epic_pose_wrangler.v2.model.base_extension.PoseWranglerExtension"><code class="docutils literal notranslate"><span class="pre">PoseWranglerExtension</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="api.html#pose-wrangler-v2-main">pose_wrangler.v2.main</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
|
||
</ul>
|
||
</div>
|
||
<section id="overview">
|
||
<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">#</a></h2>
|
||
<a class="reference internal image-reference" href="_images/v2.png"><img alt="UI Overview" src="_images/v2.png" style="width: 800px;" /></a>
|
||
<p>Pose Wrangler is the Maya portion of Pose Driver Connect, a pipeline for creating RBF data for Pose Driver nodes in
|
||
Unreal leveraging the MayaUERBFPlugin.</p>
|
||
<section id="stay-up-to-date">
|
||
<h3>Stay Up To Date<a class="headerlink" href="#stay-up-to-date" title="Link to this heading">#</a></h3>
|
||
<p>Updates to this tool can be found via the Unreal Marketplace here: <a class="reference external" href="https://www.unrealengine.com/marketplace/en-US/product/pose-driver-connect">https://www.unrealengine.com/marketplace/en-US/product/pose-driver-connect</a>.</p>
|
||
</section>
|
||
<section id="further-learning">
|
||
<h3>Further Learning<a class="headerlink" href="#further-learning" title="Link to this heading">#</a></h3>
|
||
<p>For an in depth breakdown of the RBF solver and it’s settings, check out the official tutorial on the Epic Developer
|
||
Community here: <a class="reference external" href="https://dev.epicgames.com/community/learning/tutorials/r04p/unreal-engine-authoring-secondary-animation-in-maya-and-unreal-with-pose-driver-connect">https://dev.epicgames.com/community/learning/tutorials/r04p/unreal-engine-authoring-secondary-animation-in-maya-and-unreal-with-pose-driver-connect</a></p>
|
||
</section>
|
||
<section id="release-history">
|
||
<h3>Release History<a class="headerlink" href="#release-history" title="Link to this heading">#</a></h3>
|
||
<section id="id1">
|
||
<h4>2.4.0:<a class="headerlink" href="#id1" title="Link to this heading">#</a></h4>
|
||
<blockquote>
|
||
<div><dl class="simple">
|
||
<dt>New Serializer Version:</dt><dd><ul class="simple">
|
||
<li><p>Bumped version number to 1.2.0</p></li>
|
||
<li><p>Driven transforms now serialize using deltas so they can be retargeted to skeletons with different driven positions</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt>Misc bug fixes:</dt><dd><ul class="simple">
|
||
<li><p>Added support for decompose matrix to take an MMatrix or a List</p></li>
|
||
<li><p>Fixed a bug where drivers that had been zero’d out would raise a driver indices error when the file was reopened</p></li>
|
||
<li><p>Added support for mirror axes to be defined for translation and orientation in case PoseWrangler is not used with Z up and -Y forward</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
</section>
|
||
<section id="id2">
|
||
<h4>2.3.0:<a class="headerlink" href="#id2" title="Link to this heading">#</a></h4>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Maya 2020-2024 Support</p></li>
|
||
</ul>
|
||
<dl class="simple">
|
||
<dt>New skeleton config file:</dt><dd><ul class="simple">
|
||
<li><p>Replaces the existing mirror mapping file, encompassing that data and enabling additional skeleton related data to be stored and customized.</p></li>
|
||
<li><p>New retargeting feature to support driver/bind skeleton setups.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt>New serialization interface</dt><dd><ul class="simple">
|
||
<li><p>New serializers can be made as the tool matures, ensuring backwards compatibility and upgrade steps for previous versions</p></li>
|
||
<li><p>All current saved files prior to this update will use the 1.0.0 serializer and automatically be upgraded to 1.1.0 upon next save.</p></li>
|
||
<li><p>1.1.0 introduces a new <cite>metadata</cite> field and stores the solver data under a new <cite>solvers</cite> field</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt>New Pose Exporter:</dt><dd><ul class="simple">
|
||
<li><p>Pose Wrangler now ships with the Pose Exporter extension, a simple to use interface that handles the exporting of poses and solver data into a format that the Unreal Pose Driver Connect plugin can interpret.</p></li>
|
||
<li><p>Pose Wrangler must be on your <cite>PYTHONPATH</cite> in order for the exporter to work, otherwise the export will fail with the exporter unable to find <cite>epic_pose_wrangler</cite></p></li>
|
||
<li><p>Pose Exporter exports out each solver’s poses as an FBX animation sequence, that Pose Driver Connect in Unreal can use to generate AnimSequences and PoseAssets.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
</section>
|
||
<section id="id3">
|
||
<h4>2.0.0:<a class="headerlink" href="#id3" title="Link to this heading">#</a></h4>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Supports scenes created with the UERBFSolverNode</p></li>
|
||
<li><p>Multiple Driver Support</p></li>
|
||
<li><p>Initial blendshape support (WIP)</p></li>
|
||
<li><p>Supports Maya 2018-2022</p></li>
|
||
<li><p>Support for custom mirror mappings to allow for rigs with naming conventions that deviate from the default UE5 conventions</p></li>
|
||
<li><p>Fully automatable via Python and MayaPy</p></li>
|
||
<li><p>Serialization/deserialization to dictionary or JSON file</p></li>
|
||
<li><p>Support for custom extensions and context menu actions</p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</section>
|
||
<section id="id4">
|
||
<h4>1.0.0:<a class="headerlink" href="#id4" title="Link to this heading">#</a></h4>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Supports legacy scenes created with the UE4RBFSolverNode</p></li>
|
||
<li><p>Supports Maya 2018-2022</p></li>
|
||
<li><p>Provides upgrade workflow to migrate to V2</p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</section>
|
||
</section>
|
||
<section id="contributors">
|
||
<h3>Contributors<a class="headerlink" href="#contributors" title="Link to this heading">#</a></h3>
|
||
<ul class="simple">
|
||
<li><p>Chris Theodosius</p></li>
|
||
<li><p>Chris Evans</p></li>
|
||
<li><p>Judd Simantov</p></li>
|
||
<li><p>David Corral</p></li>
|
||
<li><p>Borna Berc</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="indices-and-tables">
|
||
<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">#</a></h3>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="overview.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Pose Wrangler Overview</div>
|
||
</div>
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2023, Epic Games, Inc.
|
||
</div>
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Pose Driver Connect Documentation</a><ul>
|
||
<li><a class="reference internal" href="#overview">Overview</a><ul>
|
||
<li><a class="reference internal" href="#stay-up-to-date">Stay Up To Date</a></li>
|
||
<li><a class="reference internal" href="#further-learning">Further Learning</a></li>
|
||
<li><a class="reference internal" href="#release-history">Release History</a><ul>
|
||
<li><a class="reference internal" href="#id1">2.4.0:</a></li>
|
||
<li><a class="reference internal" href="#id2">2.3.0:</a></li>
|
||
<li><a class="reference internal" href="#id3">2.0.0:</a></li>
|
||
<li><a class="reference internal" href="#id4">1.0.0:</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#contributors">Contributors</a></li>
|
||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><script src="_static/documentation_options.js?v=c3c8ae58"></script>
|
||
<script src="_static/doctools.js?v=888ff710"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
|
||
</body>
|
||
</html> |