YEI 3-Space Mocap Studio
=============================
##########
#Overview#
##########
The YEI 3-Space Mocap Studio is an open source motion capture application that
uses the YEI 3-Space Sensor devices. The interface is similar to other motion
capture applications (e.g. Blender), but is more convenient in getting started
with the 3-Space Sensor devices since the application was created for them. It
automatically searches for 3-Space Sensor devices already in use by the computer
on start-up of the application and can load in previous sessions that saved off
3-Space Sensor information. However, it can only set-up and record motion data.
It cannot edit or clean-up the motion data like other motion capture
applications. Do not sweat though, because the Mocap Studio can export its
motion data using the BVH (Biovision Hierarchy) format which is a widely used
form for motion capture data.
The Mocap Studio interfaces with the 3-Space Sensor devices through a Node Graph
interface window which allows the creation of complex node configurations to
facilitate communicate with 3-Space Sensor devices. It is within this window
that you can edit 3-Space Sensor settings and pair 3-Space Sensor Dongle devices
with 3-Space Sensor Wireless devices . The Node Graph can also manipulate the
orientation data coming from the 3-Space Sensor devices to allow to sensor
re-targeting or other complex mocap rigs.
###################
#File Descriptions#
###################
animator.py - The main script of the Mocap Studio. This is where the layout and
interactions are done for the main window and its dialog windows.
animator_utils.py - Holds the classes for the bones, skeletons, and recordings.
Also has some helper functions.
sensor_config.py - The script for the Sensor Configuration window. This is where
the layout and interactions are done for the window, the sensors get created
for the Mocap Studio and configurations for the sensors are.
node_graph.py - The script for the Node Graph window. This is where the layout
and interactions are done for the window.
base_node_graph.py - Holds the classes for the nodes. Also has some helper
functions for initial start-up of the Mocap Studio and doing streaming.
gl_scene_graph.py - Holds the classes for the OpenGl objects.
math_lib.py - Holds the classes for the math objects.
export_tsh.py - The script for exporting the recorded data as a tsh file.
import_tsh.py - The script for importing a tsh file.
export_bvh.py - The script for exporting the recorded data as a bvh file.
import_bvh.py - The script for importing a bvh file.
tsh_to_xml.py - The script for converting a tsh file into an xml file.
##############
#Dependencies#
##############
Python 2.7
3-Space Python API (latest version)
wxPython 2.8
PyOpenGL 3.0.2
numpy 1.7.0
PIL 1.1.7
##############
#Change Notes#
##############
2.0.2.5 - Fixed an issue with the AngleCalculator's math.
2.0.2.4 - Added support for the High-G accelerometer 3-Space Sensors.
2.0.2.3 - Added an option for setting the wireless retries. Added a bell sound
when starting to record.
2.0.2.2 - Fixed a bug with recording unique skeletons. Added an option for
resetting the position for the Pedestrian Tracking.
2.0.2.1 - Fixed a bug in the Node Graph for manipulating input nodes.
2.0.2.0 - Fixed deleting bone not destroying connection mesh. Fixed deleting
hip/root causing problems. Removed Esc key quit. Changed calibration
procedure to use accelerometer instead of two vector. Changed calibration
procedure to use the offset function on the sensor. Pedestrian Tracking now
properly resets when changing sessions. Fixed the reset Pedestrian Tracking
when "Home" key is pressed. Changed BoneMeshNode to inherit from OBJMeshNode
so that we can start to use meshes in the Mocap Studio. Optimized the
call_lock for the Skeleton and Bone classes. Fixed an issue with recording
while the Node Graph was up. Improved building the recording for the 3-Space
Sensor devices. Fixed an issue with initial start-up. Added some minor
updates to the base_node_graph.py for performance improvement and debugging.
Added bulk exporting of sessions. Added menu item Scene to allow user to
add, delete, and copy. Fixed some minor bugs, optimizations, and renamed and
added some internal variables.
2.0.1.0 - Added an AngleCalculator window to calculate/log angles between bones.
Removing the console from the exe. Fixed issue with the Interpolate nodes.
Moved the calibration process to be in the TSS_Node. Added Calibration tab
to TSS_Node configure properties.
2.0.0.0 - Beta Release for using the 2.0 version of firmware on 3-Space Sensor
devices
#########
#License#
#########
The YEI 3-Space Mocap Studio is released under the YEI 3-Space Open Source
License, which allows for both non-commercial use and commercial use with
certain restrictions.
License Overview
----------------
YEI provides two license options for YEI 3-Space Covered Works. Covered Works
include, but are not limited to, programs, project files, source files,
firmware, sample program output, and packaged assets created by YEI Corporation,
and described as being covered under the YEI 3-Space Open Source License.
Software and data considered Covered Works include, but are not limited to,
YEI 3-Space Suite, YEI 3-Space Mocap Studio, YEI 3-Space Blender Motion Capture
plug-in, demonstration programs, and the YEI 3-Space Open Source family of
firmware.
User Works outputted by Covered Works are considered program output, and all
rights and copyright remain in the User. Examples of User Works include motion
capture project files (such as .tsh files), node graph XML files, animation
files (such as .bvh files), sensor data logs (data output from the YEI 3-Space
Suite), and sensor data saved to an SD card (such as from the data logging
sensor).
YEI offers two license options for Covered Works, a Commercial Use License and a
Non- Commercial Use License. Before choosing and accepting the appropriate
license for your needs, please read both options carefully, including the key
Definitions below. If you are unsure of the appropriate licensing based on your
intended use, please contact us directly at (support@yeitechnology.com).
Definitions
-----------
"Compilation"means any work which combines Covered Works with any services,
programs, code or other products not governed by the terms of this License.
"Distribution" and "Distributed" mean the sale, re-sale, licensing, supplying,
redistribution, conveyance, packaging, shipping, copying, or public or private
posting of access to Covered Works.
"Improvement" means a modification to Covered Works that corrects a bug, defect
or error without affecting the overall functionality.
Modification means any alteration, addition to, or deletion from, the substance
or structure of Covered Works including, without limitation, (a) any addition to
or deletion from Covered Works, (b) any derivative of Covered Works, or (c) any
work that contains any part of Covered Works.
"Pecuniary Gain" means any action resulting in or intended to result in a direct
or indirect monetary gain or economic benefit to any person or entity involved
in the use, reproduction or distribution of Covered Works. Pecuniary gain may
be, but is not limited to, a license fee, a user fee, a packaging, distribution,
copying or shipping fee. However, the assessment of support fees, consulting
fees, or other service-related fees by third parties, so long as the fees are
not required as part of the distribution of Covered Works, and are not
incorporated into third party products and/or software, is not considered
Pecuniary Gain for the purposes of this License.
YEI 3-Space Non-Commercial Use License
---------------------------------------
For Non-Commercial Use, your use of Covered Works is governed by the GNU GPL
v.3, subject to the YEI 3-Space Open Source Licensing Overview and Definitions.
Non-Commercial Use, for the purposes of this License, prohibits the distribution
of Covered Works for Pecuniary Gain. Non-Commercial Use, for the purposes of
this License, does not permit Covered Works to be incorporated, in whole or in
part, in its original or any revised form, in any other software, application,
product, or service that is subsequently Distributed.
Non-Commercial Use, for the purposes of this License, allows users to copy,
modify and distribute the source code, with one very important exception.
The distribution cannot be done for the purpose of reaping a commercial profit
or gain. As an example, if a user embeds or relies on the Covered Works in a
product that is then sold to a third party either alone or as a package or
component with other products or services, this would be a violation of the
Non-Commercial Use License, even though this type of use would be permitted
under the GNU GPL.
The GNU General Public License (GPL) is available at:
http://www.gnu.org/licenses/gpl.html
YEI 3-Space Commercial Use License
-----------------------------------
For Commercial Use, a YEI Commercial/Redistribution License is required,
pursuant to the YEI 3-Space Open Source Licensing Overview and Definitions.
Commercial Use, for the purposes of this License, means the use, reproduction
and/or Distribution, either directly or indirectly, of the Covered Works or any
portion thereof, or a Compilation, Improvement, or Modification, for Pecuniary
Gain. A YEI Commercial/Redistribution License may or may not require payment,
depending upon the intended use. Contact us directly at
support@yeitechnology.com to inquire about or obtain a YEI
Commercial/Redistribution License.
Commercial Use, for the purposes of this License, includes but is not limited
to: (a) integrating Covered Works with other software or hardware for Pecuniary
Gain; (b) the licensing, selling, or Distributing of Covered Works for Pecuniary
Gain; (c) the use of Covered Works, in whole or in part, in any software,
application, product, or service, for Pecuniary Gain (excluding the User Works
that are outputted by Covered Works), or that is provided free of charge in
conjunction with, or bundled with, other software, application, products or
services for which a fee or payment is assessed.
############
#Contact Us#
############
YEI Corporation
630 Second Street
Portsmouth, OH 45662
(740) 355-9029
support@yeitechnology.com
©2014 YEI Corporation
rev. 17 Feb 2014
