CCV Development Guide - Revision history

Michael Murphy: /* Helpful People */

2016-05-17T16:35:33Z

Helpful People

← Older revision		Revision as of 16:35, 17 May 2016
Line 168:		Line 168:

	Ben is an energetic and useful ally to have in the tall grasses of the CCV. He, too, can help newcomers figure out what to do.		Ben is an energetic and useful ally to have in the tall grasses of the CCV. He, too, can help newcomers figure out what to do.

			===Johannes Novotny===

			Johannes is a PhD student working on the YURT and is another good source of practical information.

	===John Huffman===		===John Huffman===

	John Huffman, like Tom, has extensive knowledge of the inner workings of the CCV filesystem, as well as other devices like the VRPN server.		John Huffman, like Tom, has extensive knowledge of the inner workings of the CCV filesystem, as well as other devices like the VRPN server.

Michael Murphy: /* Shadertoy Visualizer */

2016-05-16T03:29:17Z

Shadertoy Visualizer

← Older revision		Revision as of 03:29, 16 May 2016
Line 151:		Line 151:
	===Shadertoy Visualizer===		===Shadertoy Visualizer===

	The Shadertoy Visualizer by mjm9 was built from the YURTCraft project skeleton. It compiles and links using QtCreator, which is conducive to porting over CS Department student projects from classes like CS123 and CS-1972. Furthermore, it uses the modern programmable shader pipeline OpenGL, and contains the code for reverse-engineering VRG3D's fixed-function pipeline.		The Shadertoy Visualizer by mjm9 was built from the YURTCraft project skeleton. It compiles and links using QtCreator, which is conducive to porting over CS Department student projects from classes like CS123 and CS-1972. Furthermore, it uses the modern programmable shader pipeline OpenGL and contains the code for reverse-engineering VRG3D's fixed-function pipeline.

	The project can be accessed in mjm9's publicly available home folder <code>mjm9/yurt/yurtcraft/project</code>. When you yourself log in, <code>cd ..</code> out of your home directory and then <code>cd</code> into mjm9's.		The project can be accessed in mjm9's publicly available home folder <code>mjm9/yurt/yurtcraft/project</code>. When you yourself log in, <code>cd ..</code> out of your home directory and then <code>cd</code> into mjm9's.

Michael Murphy: /* Getting Started */

2016-05-16T03:28:17Z

Getting Started

← Older revision		Revision as of 03:28, 16 May 2016
Line 133:		Line 133:
	=Getting Started=		=Getting Started=

	The best way to get started is to find an existing example project and learn from the source code. Most of VRG3D hooks into applications "at the top," by providing input and graphics information. The technical details of the program implementation after that are actually the same as for traditional flat media. After you ~~get~~ the wheel from VRG3D, the real (and cool) problems will be related to VR interaction, not OpenGL.		The best way to get started is to find an existing example project and learn from the source code. Most of VRG3D hooks into applications "at the top," by providing input and graphics information. The technical details of the program implementation after that are actually the same as for traditional flat media. After you take the wheel from VRG3D, the real (and cool) problems will be related to VR interaction, not OpenGL.

	==VRG3D Source Code & Documentation==		==VRG3D Source Code & Documentation==

Michael Murphy: /* Important Qt. pro File Data */

2016-05-16T03:24:03Z

Important Qt. pro File Data

← Older revision		Revision as of 03:24, 16 May 2016
Line 76:		Line 76:

	* <code>G</code>: Note that the environment variable must be set before starting QtCreator.		* <code>G</code>: Note that the environment variable must be set before starting QtCreator.
	* <code>-Xlinker --start-group ... -Xlinker --end-group</code>: These linker flags resolve circular/out of order library dependencies.		* <code>-Xlinker --start-group ... --Xlinker --end-group</code>: These linker flags resolve circular/out of order library dependencies.

	=Compiling and Running=		=Compiling and Running=

Michael Murphy: /* Modules needed for developing YURT programs */

2016-05-16T03:19:54Z

Modules needed for developing YURT programs

← Older revision		Revision as of 03:19, 16 May 2016
Line 26:		Line 26:

	* <code>centos-libs/6.7</code> These are the updated OS libs. Check to see that your version is not 6.5.		* <code>centos-libs/6.7</code> These are the updated OS libs. Check to see that your version is not 6.5.
	* <code>vprn/7.31</code> VRPN is the input server for tracking input devices like wands and glasses.		* <code>vprn/7.31</code> VRPN is the input server for tracking the movement of input devices like wands and glasses.
	* <code>cave/ccv</code> Has cave modules such as VRG3D and other important libraries.		* <code>cave/ccv</code> Has cave modules such as VRG3D and other important libraries.
	* <code>cave/jnh</code> John Huffman's alternate version of the former. May be more up to date.		* <code>cave/jnh</code> John Huffman's alternate version of the former. May be more up to date.

Michael Murphy: /* Modules needed for developing YURT programs */

2016-05-16T03:19:26Z

Modules needed for developing YURT programs

← Older revision		Revision as of 03:19, 16 May 2016
Line 26:		Line 26:

	* <code>centos-libs/6.7</code> These are the updated OS libs. Check to see that your version is not 6.5.		* <code>centos-libs/6.7</code> These are the updated OS libs. Check to see that your version is not 6.5.
	* <code>vprn/7.31</code> VRPN is the input server for tracking input devices like ~~wand~~ and glasses ~~movement~~.		* <code>vprn/7.31</code> VRPN is the input server for tracking input devices like wands and glasses.
	* <code>cave/ccv</code> Has cave modules such as VRG3D and other important libraries.		* <code>cave/ccv</code> Has cave modules such as VRG3D and other important libraries.
	* <code>cave/jnh</code> John Huffman's alternate version of the former. May be more up to date.		* <code>cave/jnh</code> John Huffman's alternate version of the former. May be more up to date.

Michael Murphy at 21:11, 15 May 2016

2016-05-15T21:11:26Z

← Older revision		Revision as of 21:11, 15 May 2016
Line 45:		Line 45:
	QtCreator provides a tremendous productivity boost over makefiles, the traditional form of project coordination for a number of YURT applications. However, compiling and linking programs with QtCreator with VRG3D is not straightforward. The .pro file requires special attention:		QtCreator provides a tremendous productivity boost over makefiles, the traditional form of project coordination for a number of YURT applications. However, compiling and linking programs with QtCreator with VRG3D is not straightforward. The .pro file requires special attention:

	* The best way to start a new Qt project is to build off of a previous .pro file. ~~<code>~~mjm9~~</code>~~'s home directory is open, and the project contained in <code>~yurt/yurtcraft/project</code> provides an example of how to properly set up a Qt .pro file in order to compile and link on development machines.		* The best way to start a new Qt project is to build off of a previous .pro file. mjm9's home directory is open, and the project contained in <code>~yurt/yurtcraft/project</code> provides an example of how to properly set up a Qt .pro file in order to compile and link on development machines.
	* There are a large number of libraries required for VRG3D. These must be enclosed using <code>-Xlinker --start-group</code> and <code>-Xlinker --end-group</code>. This is slightly different from makefile templates, which include <code>-Xlinker</code> before every linked library in the list.		* There are a large number of libraries required for VRG3D. These must be enclosed using <code>-Xlinker --start-group</code> and <code>-Xlinker --end-group</code>. This is slightly different from makefile templates, which include <code>-Xlinker</code> before every linked library in the list.
	* The <code>G</code> and <code>GARCH</code> environment variables must be set before opening QtCreator from the command line, as they are referenced from within the Qt .pro file. These are magic environment variables required by the build process. Note that these only work on the CCV machines. Use <code>export</code> from the command line to set the variables:		* The <code>G</code> and <code>GARCH</code> environment variables must be set before opening QtCreator from the command line, as they are referenced from within the Qt .pro file. These are magic environment variables required by the build process. Note that these only work on the CCV machines. Use <code>export</code> from the command line to set the variables:
	** <code>G=/gpfs/data/dhl/gfx/G/</code>		** <code>G=/gpfs/data/dhl/gfx/G/</code>
	** <code>GARCH=linux</code>		** <code>GARCH=linux</code>
	* To add a library to your project, right-click the .pro file in the text-editing pane (not the file icon in the file viewer). Go through the steps of adding the external library as usual, and Qt will automatically add three chunks of text to the .pro file. You must '''delete''' the last chunk. The chunk in question is commented out in ~~<code>~~mjm9~~</code>~~'s .pro file as an example.		* To add a library to your project, right-click the .pro file in the text-editing pane (not the file icon in the file viewer). Go through the steps of adding the external library as usual, and Qt will automatically add three chunks of text to the .pro file. You must '''delete''' the last chunk. The chunk in question is commented out in mjm9's .pro file as an example.

	===Important Qt. pro File Data===		===Important Qt. pro File Data===

Michael Murphy: /* The Test Wall */

2016-05-15T21:08:19Z

The Test Wall

← Older revision		Revision as of 21:08, 15 May 2016
Line 118:		Line 118:
	Useful facts:		Useful facts:

	* The test wall has its own kiosk, which can be ~~access~~ from <code>172.20.8.9/wall</code> in the web browser. The kiosk can conveniently be run from any machine.		* The test wall has its own kiosk, which can be accessed from <code>172.20.8.9/wall</code> in the web browser. The kiosk can conveniently be run from any machine.
	* In case your project continued running after you ~~have~~ hit the kill button, you will have to ssh into dev10 and kill the processes by hand.		* In case your project continued running after you hit the kill button, you will have to ssh into dev10 and kill the processes by hand.
	* In order to run a project on the test wall, use the <code>run-wall</code> script, which should already be in your path, using your program name as an argument.		* In order to run a project on the test wall, use the <code>run-wall</code> script, which should already be in your path, using your program name as an argument.
	* The projectors are similar to those that run in the YURT in that they burn out over time. As such, it is best not to turn them on and off very much, for the heating and cooling process erodes the hardware. Try to work in fewer, longer chunks of time rather than more numerous and shorter chunks of time.		* The projectors are similar to those that run in the YURT in that they burn out over time. As such, it is best not to turn them on and off very much, for the heating and cooling process erodes the hardware. Try to work in fewer, longer chunks of time rather than more numerous and shorter chunks of time.

Michael Murphy: /* Nonuniform disk images */

2016-05-15T21:06:13Z

Nonuniform disk images

← Older revision		Revision as of 21:06, 15 May 2016
Line 102:		Line 102:
	===Nonuniform disk images===		===Nonuniform disk images===

	While all of the machines are on the same filesystem, ~~at the time~~ of ~~this writing~~ not all of the disk images on each of the machines is identical. Changes made to your home directory will persist across different machines (dev, cave, etc.) however dependencies may change. To ensure that your project can run in the YURT, make to compile and link it on <code>login001</code> to avoid any issues. You don't ~~physically~~ need to go to the kiosk - simply ssh in from a dev machine.		While all of the machines are on the same filesystem, as of May 2016 not all of the disk images on each of the machines are identical. Changes made to your home directory will persist across different machines (dev, cave, etc.) however dependencies may change. To ensure that your project can run in the YURT, make sure to compile and link it on <code>login001</code> to avoid any issues. You don't need to physically go to the kiosk - simply ssh in from a dev machine.

	==Recommended Build Process for QtCreator users==		==Recommended Build Process for QtCreator users==

Michael Murphy: /* Important Qt. pro File Data */

2016-05-15T21:03:23Z

Important Qt. pro File Data

← Older revision		Revision as of 21:03, 15 May 2016
Line 76:		Line 76:

	* <code>G</code>: Note that the environment variable must be set before starting QtCreator.		* <code>G</code>: Note that the environment variable must be set before starting QtCreator.
	* <code>-~~Xlinder~~ --start-group ... -~~Xlinder~~ --end-group</code>: These linker flags resolve circular/out of order library dependencies.		* <code>-Xlinker --start-group ... -Xlinker --end-group</code>: These linker flags resolve circular/out of order library dependencies.

	=Compiling and Running=		=Compiling and Running=