Initial Commit
This commit is contained in:
@@ -0,0 +1,189 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Welcome to iMSTK-Unity — imstk-unity 1.0.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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/_sphinx_javascript_frameworks_compat.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" />
|
||||
<link rel="next" title="Introduction" href="documentation.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="#" class="icon icon-home"> imstk-unity
|
||||
</a>
|
||||
<div class="version">
|
||||
1.0.0
|
||||
</div>
|
||||
<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">Introduction</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html#setup-for-development">Setup for Development</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html#devices">Devices</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">User guide</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="guide.html">Tutorial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="guide.html#example-scenes">Example Scenes</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Class List</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="classes.html">Usage</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="classes.html#component-structure">Component Structure</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Release Notes</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Licensing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Apache License</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="#">imstk-unity</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="#" class="icon icon-home"></a> »</li>
|
||||
<li>Welcome to iMSTK-Unity</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<p class="centered">
|
||||
<strong><a class="reference internal" href="_images/imstk-logo.png"><img alt="image0" src="_images/imstk-logo.png" style="width: 3.5in; height: 1.28515625in;" /></a></strong></p><section id="welcome-to-imstk-unity">
|
||||
<h1>Welcome to iMSTK-Unity<a class="headerlink" href="#welcome-to-imstk-unity" title="Permalink to this heading"></a></h1>
|
||||
<p><a class="reference external" href="https://www.imstk.org/">iMSTK</a> is a free & open source C++ toolkit for the prototyping of interactive multi-modal surgical simulations. The iMSTK-Unity asset gives you access to its capabilities through the Unity authoring interface. While this asset is still under development you can already exercise a variety of parts of iMSTK inside of Unity. This guide will help you get acquainted with the architecture and workings of the plugin.</p>
|
||||
<p>The latest version of this documentation can be found on <a class="reference external" href="https://imstk-unity.readthedocs.io/en/latest/">readthedocs</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Introduction</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documentation.html#overview">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documentation.html#limitations">Limitations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documentation.html#project-structure">Project Structure</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html#setup-for-development">Setup for Development</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="documentation.html#devices">Devices</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documentation.html#debugging">Debugging</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">User guide</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="guide.html">Tutorial</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="guide.html#example-scenes">Example Scenes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Class List</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="classes.html">Usage</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="classes.html#component-structure">Component Structure</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="classes.html#infrastructure">Infrastructure</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="classes.html#models">Models</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="classes.html#interactions">Interactions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="classes.html#devices">Devices</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Release Notes</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Licensing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">Apache License</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section id="other-resources">
|
||||
<h2>Other Resources<a class="headerlink" href="#other-resources" title="Permalink to this heading"></a></h2>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p><a class="reference external" href="https://discourse.kitware.com/c/imstk/9">iMSTK Discourse Forum</a></p></li>
|
||||
<li><p><a class="reference external" href="https://gitlab.kitware.com/iMSTK/imstk-unity/">iMSTK-Unity Gitlab</a></p></li>
|
||||
<li><p><a class="reference external" href="https://imstk.readthedocs.io/en/latest/">iMSTK Documentation</a></p></li>
|
||||
<li><p><a class="reference external" href="https://gitlab.kitware.com/iMSTK/iMSTK">iMSTK Gitlab</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p class="centered">
|
||||
<strong><a class="reference internal" href="_images/kitware-logo.jpg"><img alt="image1" src="_images/kitware-logo.jpg" style="height: 1in;" /></a></strong></p></section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="documentation.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2022, Kitware.</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>
|
||||
Reference in New Issue
Block a user