DOCS.md

Back to README.md

DOCUMENTATION TABLE OF CONTENTS

This is the documentation for the project OpenVR_Simple_Tracking.

INSTRUCTIONS.md

0. HOW TO USE THIS TEMPLATE

1. HOW TO INSTALL ANACONDA

2. HOW TO CREATE CONDA ENVIRONMENT

4. HOW TO INSTALL REQUIREMENTS

A. HOW TO REMOVE CONDA ENVIRONMENT

API

Documentation For \main.py

> function update_plot

def update_plot(list_of_objects, ax):

Documentation For \toolbox\base_station_control.py

> function turn_base_stations_on

def turn_base_stations_on():

> function turn_base_stations_off

def turn_base_stations_off():

Documentation For \toolbox\plot_data_2d.py

> function update_ax

def update_ax(ax):

> function initialize_plot

def initialize_plot():

> function wait_for_button_press

def wait_for_button_press():

> function update_plot

def update_plot(list_of_objects, ax):

> function draw

def draw(fig):

Documentation For \toolbox\plot_data_3d.py

> function update_ax

def update_ax(ax):

> function initialize_plot

def initialize_plot():

> function wait_for_button_press

def wait_for_button_press():

> function update_plot

def update_plot(list_of_objects, ax):

> function draw

def draw(fig):

Documentation For \toolbox\trackerpositions.py

> function get_position_rotation_from_hmd_pose

def get_position_rotation_from_hmd_pose(hmd_pose):

> function get_all_poses

def get_all_poses():

> function get_base_station_pose

def get_base_station_pose(base_station_index):

> function get_headset_pose

def get_headset_pose():

> function get_left_controller_pose

def get_left_controller_pose():

> function get_right_controller_pose

def get_right_controller_pose():

> function get_tracker_pose

def get_tracker_pose(index:int):