Skip to content

Commit aa129ce

Browse files
ahmed-shariffahmed-shariff
committed
Update docs
1 parent 409c262 commit aa129ce

File tree

4 files changed

+83
-6
lines changed

4 files changed

+83
-6
lines changed

‎Documentation~/docs/usage.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ This can be imported as a git package in Unity. The package is built to use [Uni
33

44
## Scene setup
55
- Setup the Scene with an XR Origin & XR Interaction Manager (see documentation [XRI documentation for more details](https://docs.unity3d.com/Packages/[email protected]/manual/general-setup.html#create-the-xr-origin-camera-rig-for-tracked-devices)).
6-
- Setup the `HPUIInteractor`
7-
- For each hand, add `hpuiinteractorright` and `HPUIInteractorLeft` prefabs to the scene.
8-
- Setup an HPUI Interactable. (TODO)
9-
- HPUIInteractor is an extention of `XRPokeInteractor`. You would be able to use `XRPokeFilter` on any of the HPUI Interactables. Note that, with the `HPUIContinuousInteractable`, the associated `XRPokeFilter` needs to be enabled after the surface is created. By default, once the surface is created, it will enable any XRPokeFilter component on the same GameObject, right before `continuousSurfaceCreatedEvent` is invoked.
6+
- Place atleast one HPUIInteractor component. You may use the `HPUIInteractable` prefab that is provided with the package.
7+
- Create intractables with the HPUI Interactables components added to them (i.e., `HPUIBaseInteractable` & `HPUIContinuousInteractable`).
8+
- Add and configure the `JointFollower` component to all gameobjects with HPUI Interactables or HPUI Interactor. This component makes sure the game objects location is set to the respective joint(s) of a given hand. The Interactor and Interactables don't depend on these, but they play nice with each other - i.e., the HPUI Interactables and HPUI Interactors will respect the configuration (Handedness) of the JointFollower.
9+
10+
Note that, the HPUI interactor/interactables do not have to be under the `XROrigin` even though the data from the XRHands subsystem is relative to the `XROrigin`. `JointFollower` transforms the location so that its not necessay for the components to be under the `XROrigin`.
1011

1112
## Interactables
1213
TODO

‎Documentation~/doxygen-awesome-css

‎Documentation~/doxygen-custom/header.html

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!-- HTML header for doxygen 1.9.6-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
7+
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
9+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
10+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
11+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
12+
<!--BEGIN DISABLE_INDEX-->
13+
<!--BEGIN FULL_SIDEBAR-->
14+
<script type="text/javascript">var page_layout=1;</script>
15+
<!--END FULL_SIDEBAR-->
16+
<!--END DISABLE_INDEX-->
17+
<script type="text/javascript" src="$relpath^jquery.js"></script>
18+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
19+
$treeview
20+
$search
21+
$mathjax
22+
$darkmode
23+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
24+
$extrastylesheet
25+
</head>
26+
<body>
27+
<!--BEGIN DISABLE_INDEX-->
28+
<!--BEGIN FULL_SIDEBAR-->
29+
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
30+
<!--END FULL_SIDEBAR-->
31+
<!--END DISABLE_INDEX-->
32+
33+
<a href="https://github.com/ovi-lab/HPUI-Core" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:--page-background-color; color:--page-foreground-color; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
34+
35+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36+
37+
<!--BEGIN TITLEAREA-->
38+
<div id="titlearea">
39+
<table cellspacing="0" cellpadding="0">
40+
<tbody>
41+
<tr id="projectrow">
42+
<!--BEGIN PROJECT_LOGO-->
43+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
44+
<!--END PROJECT_LOGO-->
45+
<!--BEGIN PROJECT_NAME-->
46+
<td id="projectalign">
47+
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
48+
</div>
49+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
50+
</td>
51+
<!--END PROJECT_NAME-->
52+
<!--BEGIN !PROJECT_NAME-->
53+
<!--BEGIN PROJECT_BRIEF-->
54+
<td>
55+
<div id="projectbrief">$projectbrief</div>
56+
</td>
57+
<!--END PROJECT_BRIEF-->
58+
<!--END !PROJECT_NAME-->
59+
<!--BEGIN DISABLE_INDEX-->
60+
<!--BEGIN SEARCHENGINE-->
61+
<!--BEGIN !FULL_SIDEBAR-->
62+
<td>$searchbox</td>
63+
<!--END !FULL_SIDEBAR-->
64+
<!--END SEARCHENGINE-->
65+
<!--END DISABLE_INDEX-->
66+
</tr>
67+
<!--BEGIN SEARCHENGINE-->
68+
<!--BEGIN FULL_SIDEBAR-->
69+
<tr><td colspan="2">$searchbox</td></tr>
70+
<!--END FULL_SIDEBAR-->
71+
<!--END SEARCHENGINE-->
72+
</tbody>
73+
</table>
74+
</div>
75+
<!--END TITLEAREA-->
76+
<!-- end header part -->

‎Doxyfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1285,7 +1285,7 @@ HTML_FILE_EXTENSION = .html
12851285
# of the possible markers and block names see the documentation.
12861286
# This tag requires that the tag GENERATE_HTML is set to YES.
12871287

1288-
HTML_HEADER =
1288+
HTML_HEADER = Documentation~/doxygen-custom/header.html
12891289

12901290
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
12911291
# generated HTML page. If the tag is left blank doxygen will generate a standard

0 commit comments

Comments
 (0)