Skip to content

Commit

Permalink
Add missing docs, build
Browse files Browse the repository at this point in the history
  • Loading branch information
brentyi committed Jun 15, 2023
1 parent 35011ea commit 634df8a
Show file tree
Hide file tree
Showing 10 changed files with 322 additions and 8 deletions.
19 changes: 19 additions & 0 deletions docs/source/client_handles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Client Handles

A handle is created for each client that connects to a server. Handles can be
used to communicate with just one client, as well as for reading and writing of
camera state.

<!-- prettier-ignore-start -->

.. autoapiclass:: viser.ClientHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.CameraHandle
:members:
:undoc-members:
:inherited-members:

<!-- prettier-ignore-end -->
8 changes: 4 additions & 4 deletions docs/source/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ In this note, we describe the coordinate frame conventions used in `viser`.
## Scene tree naming

Each object that we add to the scene in viser is instantiated as a node in a
scene tree. The hierarchical relationships in this tree are determined entirely
by the names used in this tree.
scene tree. The structure of this tree is determined by the names assigned to
the nodes.

If we add a coordinate frame called `/base_link/shoulder/wrist`, it signifies
that are three nodes: the `wrist` is a child of the `shoulder` which is a child
of the `base_link`.
three nodes: the `wrist` is a child of the `shoulder` which is a child of the
`base_link`.

If we set the transformation of a given node like `/shoulder`, both it and all
of its children will move. Its parent, `/base_link`, will be unaffected.
Expand Down
33 changes: 33 additions & 0 deletions docs/source/gui_handles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# GUI Handles

A handle is created for each GUI element that is added. Handles can be used to
read and write state.

When a GUI element is added to a server (for example, via
:func:`ViserServer.add_gui_text()`), state is synchronized between all connected
clients. When a GUI element is added to a client (for example, via
:func:`ClientHandle.add_gui_text()`), state is local to a specific client.

<!-- prettier-ignore-start -->

.. autoapiclass:: viser.GuiHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.GuiButtonHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.GuiButtonGroupHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.GuiDropdownHandle
:members:
:undoc-members:
:inherited-members:

<!-- prettier-ignore-end -->
53 changes: 53 additions & 0 deletions docs/source/scene_handles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Scene Handles

A handle is created for each object that is added to the scene. These can be
used to read and set state, as well as detect clicks.

When a scene node is added to a server (for example, via
:func:`ViserServer.add_frame()`), state is synchronized between all connected
clients. When a scene node is added to a client (for example, via
:func:`ClientHandle.add_frame()`), state is local to a specific client.

<!-- prettier-ignore-start -->

.. autoapiclass:: viser.SceneNodeHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.CameraFrustumHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.FrameHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.ImageHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.LabelHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.MeshHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.PointCloudHandle
:members:
:undoc-members:
:inherited-members:

.. autoapiclass:: viser.TransformControlsHandle
:members:
:undoc-members:
:inherited-members:

<!-- prettier-ignore-end -->
14 changes: 14 additions & 0 deletions docs/source/server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Viser Server

The core `viser` API is designed around :class:`viser.ViserServer`, which (a)
launches a thread with a visualization server and (b) provides a high-level API
for communicating with clients.

<!-- prettier-ignore-start -->

.. autoapiclass:: viser.ViserServer
:members:
:undoc-members:
:inherited-members:

<!-- prettier-ignore-end -->
6 changes: 3 additions & 3 deletions viser/client/build/asset-manifest.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"files": {
"main.css": "/static/css/main.82973013.css",
"main.js": "/static/js/main.cf7baeba.js",
"main.js": "/static/js/main.78d359b6.js",
"index.html": "/index.html",
"main.82973013.css.map": "/static/css/main.82973013.css.map",
"main.cf7baeba.js.map": "/static/js/main.cf7baeba.js.map"
"main.78d359b6.js.map": "/static/js/main.78d359b6.js.map"
},
"entrypoints": [
"static/css/main.82973013.css",
"static/js/main.cf7baeba.js"
"static/js/main.78d359b6.js"
]
}
2 changes: 1 addition & 1 deletion viser/client/build/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.svg"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>Viser</title><script defer="defer" src="/static/js/main.cf7baeba.js"></script><link href="/static/css/main.82973013.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.svg"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>Viser</title><script defer="defer" src="/static/js/main.78d359b6.js"></script><link href="/static/css/main.82973013.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
3 changes: 3 additions & 0 deletions viser/client/build/static/js/main.78d359b6.js

Large diffs are not rendered by default.

191 changes: 191 additions & 0 deletions viser/client/build/static/js/main.78d359b6.js.LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
/*!
* assign-symbols <https://github.com/jonschlinkert/assign-symbols>
*
* Copyright (c) 2015, Jon Schlinkert.
* Licensed under the MIT License.
*/

/*!
* camera-controls
* https://github.com/yomotsu/camera-controls
* (c) 2017 @yomotsu
* Released under the MIT License.
*/

/*!
* for-in <https://github.com/jonschlinkert/for-in>
*
* Copyright (c) 2014-2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*!
* get-value <https://github.com/jonschlinkert/get-value>
*
* Copyright (c) 2014-2015, Jon Schlinkert.
* Licensed under the MIT License.
*/

/*!
* is-extendable <https://github.com/jonschlinkert/is-extendable>
*
* Copyright (c) 2015, Jon Schlinkert.
* Licensed under the MIT License.
*/

/*!
* is-extendable <https://github.com/jonschlinkert/is-extendable>
*
* Copyright (c) 2015-2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*!
* is-plain-object <https://github.com/jonschlinkert/is-plain-object>
*
* Copyright (c) 2014-2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*!
* isobject <https://github.com/jonschlinkert/isobject>
*
* Copyright (c) 2014-2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*!
* set-value <https://github.com/jonschlinkert/set-value>
*
* Copyright (c) 2014-2015, 2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*!
* split-string <https://github.com/jonschlinkert/split-string>
*
* Copyright (c) 2015-2017, Jon Schlinkert.
* Released under the MIT License.
*/

/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

/**
* @license
* Copyright 2010-2023 Three.js Authors
* SPDX-License-Identifier: MIT
*/

/**
* @license React
* react-dom.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react-jsx-runtime.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react-reconciler-constants.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react-reconciler.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* scheduler.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* use-sync-external-store-shim.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* use-sync-external-store-shim/with-selector.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @mui/styled-engine v5.11.16
*
* @license MIT
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* postprocessing v6.31.0 build Sun May 07 2023
* https://github.com/pmndrs/postprocessing
* Copyright 2015-2023 Raoul van Rüschen
* @license Zlib
*/

/** @license React v16.13.1
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
1 change: 1 addition & 0 deletions viser/client/build/static/js/main.78d359b6.js.map

Large diffs are not rendered by default.

0 comments on commit 634df8a

Please sign in to comment.