Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 8, 2023
1 parent f499d75 commit a780a84
Show file tree
Hide file tree
Showing 18 changed files with 258 additions and 207 deletions.
411 changes: 244 additions & 167 deletions Custom/README.md

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion Custom/doc/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The Pattern Generation Tool provides a user interface for creating, editing, and
patterns
entities
extra
contributing



Expand Down
9 changes: 3 additions & 6 deletions Custom/doc/_sources/introduction.rst.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
Introduction
================

`Access to Pattern Creation Tool <https://didsr.github.io/WebXR-tools/Custom/>`_
-----------------------------------------------------------------------------------------------

`View the source code <https://github.com/DIDSR/WebXR-tools/tree/main/Custom>`_
`Access to Pattern Creation Tool <https://brendanc490.github.io/WebVR-Test-Patterns/Custom/>`_
-----------------------------------------------------------------------------------------------

Features
Expand Down Expand Up @@ -37,6 +34,6 @@ Demo



<video controls src="./_static/demoVid.mp4" width="620" height="620">
<video controls src="_static/demoVid.webm" width="620" height="620">

</video>
</video>
1 change: 0 additions & 1 deletion Custom/doc/entities.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down
3 changes: 0 additions & 3 deletions Custom/doc/extra.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
<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="Contributing" href="contributing.html" />
<link rel="prev" title="Entities" href="entities.html" />
</head>

Expand Down Expand Up @@ -52,7 +51,6 @@
<li class="toctree-l2"><a class="reference internal" href="#easy-debugging">Easy Debugging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down Expand Up @@ -135,7 +133,6 @@ <h2>Easy Debugging<a class="headerlink" href="#easy-debugging" title="Permalink
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="entities.html" class="btn btn-neutral float-left" title="Entities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
1 change: 0 additions & 1 deletion Custom/doc/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Pattern Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down
7 changes: 0 additions & 7 deletions Custom/doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Pattern Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down Expand Up @@ -81,7 +80,6 @@ <h1>Welcome to Pattern Generation Tool’s documentation!<a class="headerlink" h
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#id1">Access to Pattern Creation Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#id2">View the source code</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#demo">Demo</a></li>
</ul>
Expand Down Expand Up @@ -125,11 +123,6 @@ <h1>Welcome to Pattern Generation Tool’s documentation!<a class="headerlink" h
<li class="toctree-l2"><a class="reference internal" href="extra.html#easy-debugging">Easy Debugging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#asking-a-question">Asking a question</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#reporting-bugs">Reporting bugs</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand Down
9 changes: 2 additions & 7 deletions Custom/doc/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">Access to Pattern Creation Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">View the source code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#demo">Demo</a></li>
</ul>
Expand All @@ -53,7 +52,6 @@
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Pattern Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down Expand Up @@ -83,10 +81,7 @@
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
<div class="section" id="id1">
<h2><a class="reference external" href="https://didsr.github.io/WebXR-tools/Custom/">Access to Pattern Creation Tool</a><a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="id2">
<h2><a class="reference external" href="https://github.com/DIDSR/WebXR-tools/tree/main/Custom">View the source code</a><a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<h2><a class="reference external" href="https://brendanc490.github.io/WebVR-Test-Patterns/Custom/">Access to Pattern Creation Tool</a><a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -119,7 +114,7 @@ <h2>Features<a class="headerlink" href="#features" title="Permalink to this head
</div>
<div class="section" id="demo">
<h2>Demo<a class="headerlink" href="#demo" title="Permalink to this headline"></a></h2>
<video controls src="./_static/demoVid.mp4" width="620" height="620">
<video controls src="_static/demoVid.webm" width="620" height="620">

</video></div>
</div>
Expand Down
Binary file modified Custom/doc/objects.inv
Binary file not shown.
1 change: 0 additions & 1 deletion Custom/doc/packages.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Pattern Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down
1 change: 0 additions & 1 deletion Custom/doc/patterns.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down
1 change: 0 additions & 1 deletion Custom/doc/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Pattern Content</a></li>
<li class="toctree-l1"><a class="reference internal" href="entities.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>

</div>
Expand Down
2 changes: 1 addition & 1 deletion Custom/doc/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Custom/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
</select>
</p>
<div>
Upload Package: <button style="text-align:center; width:20%; float: right;" class="button add" onclick="saveSelected()" title="Save Package"><i class="fa-solid fa-download"></i></button>
Upload Package:
</div>
<p><input style="width: 100%; padding-top: 10" type="file" id="scene-disp-input" accept=".json" multiple></p>
<div> Recent packages: <select class="select" id="recentPackages" onchange="changeUrl(this)">
Expand Down
7 changes: 3 additions & 4 deletions Custom/pastebinInterface.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var fileContent = await fetch(url).then((res) => {
//console.log(url)
return res.json()
}
});
}).catch((error) => alert('Failed to import from: '+url+' with error '+error));

if(fileContent == null){
alert('No package found')
Expand Down Expand Up @@ -183,7 +183,7 @@ function compressTextures(textures){
}
})
}
})
}).catch((error) => alert('Failed to import from: '+url+' with error '+error))
}

/* Posts content to pastebin.
Expand All @@ -203,7 +203,6 @@ async function pastebinPost(useTextures){
code['textures']['textureValues'] = textures
code['textures']['uploadedTextureFormats'] = uploadedTextureFormat
} else {
console.log('made it')
for (const pattern of Object.keys(scenes[packageSelect.value])){
for (const ent of Object.keys(scenes[packageSelect.value][pattern])){
if(ent.includes('plane')){
Expand Down Expand Up @@ -256,7 +255,7 @@ async function pastebinPost(useTextures){
console.error('Failed to copy: ', err);
return false
}
})
}).catch((error) => alert('Failed to post with error '+error))
}

/* Adds packages to local storage.
Expand Down
2 changes: 1 addition & 1 deletion Custom/sharing.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ async function validateLink(url){
console.log(url)
return res.json()
}
});
}).catch((error) => alert('Failed to fetch from: '+url+' with error '+error));
if(fileContent == null || !fileContent.hasOwnProperty('filename') || !fileContent.hasOwnProperty('date') || !fileContent.hasOwnProperty('scenes') || !fileContent.hasOwnProperty('textures')){
return false;
}
Expand Down
2 changes: 0 additions & 2 deletions Custom/utility.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ function removeEntity(){
}
if(els.length == 0){
utility.checked = false;
selectedEntity = null;
toggleAddEdit(true);

} else {
Expand Down Expand Up @@ -351,7 +350,6 @@ function revertChanges(){
bullseyeNum = 0;
textureNum = 0;
numAdded = 0;
selectedEntity = null;
}

names = {'default' : {'red':1,'green':1,'blue':1,'white':1,'grille':1,'crosshair':1,'line':1,'circular dot array':1,'dot array':1,'checkerboard (w)':1,'checkerboard (b)':1,'ring_w5':1,'ring_w10':1,'ring_w20':1,'bullseye':1}}
Expand Down
Loading

0 comments on commit a780a84

Please sign in to comment.