159 lines
8.2 KiB
HTML
159 lines
8.2 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html class="writer-html5" lang="en" >
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8" />
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
|
|
<title>dna_viewer.model.joint — DNA Calibration documentation</title>
|
||
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="../../../_static/js/html5shiv.min.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
|
||
|
|
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
|
||
|
|
<script src="../../../_static/jquery.js"></script>
|
||
|
|
<script src="../../../_static/underscore.js"></script>
|
||
|
|
<script src="../../../_static/doctools.js"></script>
|
||
|
|
<script src="../../../_static/js/theme.js"></script>
|
||
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
||
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav">
|
||
|
|
<div class="wy-grid-for-nav">
|
||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
|
|
<div class="wy-side-scroll">
|
||
|
|
<div class="wy-side-nav-search" >
|
||
|
|
<a href="../../../index.html" class="icon icon-home"> DNA Calibration
|
||
|
|
</a>
|
||
|
|
<div role="search">
|
||
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html">DNA Calibration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html#overview">Overview</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html#examples">Examples</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html#notes">Notes</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html#license">License</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../index_.html#indices-and-tables">Indices and tables</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">Repository Organization</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../repository_organization_md.html">Repository Organization</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../repository_organization_md.html#folder-structure">Folder structure</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">DNACalib</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dnacalib_md.html">DNACalib</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">DNAViewer</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dna_viewer_md.html">DNAViewer</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dna_viewer_maya_md.html">Usage in Maya</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">DNAViewer API</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dna_viewer_api_md.html">Environment Setup</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dna_viewer_api_md.html#dna">DNA</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">Technical documentation</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dnacalib.html">dnacalib</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">dna_viewer</a></li>
|
||
|
|
</ul>
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">FAQ</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../faq_md.html">Frequently Asked Questions (FAQ)</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
|
|
<a href="../../../index.html">DNA Calibration</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div class="wy-nav-content">
|
||
|
|
<div class="rst-content">
|
||
|
|
<div role="navigation" aria-label="Page navigation">
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
<li><a href="../../../index.html" class="icon icon-home"></a> »</li>
|
||
|
|
<li><a href="../../index.html">Module code</a> »</li>
|
||
|
|
<li>dna_viewer.model.joint</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<hr/>
|
||
|
|
</div>
|
||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
|
<div itemprop="articleBody">
|
||
|
|
|
||
|
|
<h1>Source code for dna_viewer.model.joint</h1><div class="highlight"><pre>
|
||
|
|
<span></span><span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span>
|
||
|
|
|
||
|
|
<span class="kn">from</span> <span class="nn">..model.geometry</span> <span class="kn">import</span> <span class="n">Point3</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="viewcode-block" id="Joint"><a class="viewcode-back" href="../../../dna_viewer.model.html#dna_viewer.model.joint.Joint">[docs]</a><span class="nd">@dataclass</span>
|
||
|
|
<span class="k">class</span> <span class="nc">Joint</span><span class="p">:</span>
|
||
|
|
<span class="sd">"""</span>
|
||
|
|
<span class="sd"> A model class for holding data about a single joint</span>
|
||
|
|
|
||
|
|
<span class="sd"> Attributes</span>
|
||
|
|
<span class="sd"> ----------</span>
|
||
|
|
<span class="sd"> @type name: str</span>
|
||
|
|
<span class="sd"> @param name: The name of the joint</span>
|
||
|
|
|
||
|
|
<span class="sd"> @type translation: Point3</span>
|
||
|
|
<span class="sd"> @param translation: A point in 3 dimensional space which represents the translation of the joint</span>
|
||
|
|
|
||
|
|
<span class="sd"> @type orientation: Point3</span>
|
||
|
|
<span class="sd"> @param orientation: A point in 3 dimensional space which represents the orientation of the joint</span>
|
||
|
|
|
||
|
|
<span class="sd"> @type parent_name: str</span>
|
||
|
|
<span class="sd"> @param parent_name: The name of the parent joint</span>
|
||
|
|
<span class="sd"> """</span>
|
||
|
|
|
||
|
|
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
|
|
<span class="n">translation</span><span class="p">:</span> <span class="n">Point3</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">Point3</span><span class="p">)</span>
|
||
|
|
<span class="n">orientation</span><span class="p">:</span> <span class="n">Point3</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">Point3</span><span class="p">)</span>
|
||
|
|
<span class="n">parent_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
|
||
|
|
</pre></div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>© Copyright 2022, Epic Games.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
|
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<script>
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|