Recent changes to Building_and_installing

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v10
+++ v11
@@ -59,7 +59,9 @@

 4\. Press Generate. The selected projects will be generated. 

-## Windows (Visual Studio)
+## Compiling and installing
+
+### Windows (Visual Studio)

 Open the solution created by CMake: 

@@ -83,7 +85,7 @@

 A fast workaround to the above mentioned permission problem is to give modification access to the plug-ins directory for the user that is doing the compilation. You can also run Visual Studio as superuser when installing. 

-## Linux
+### Linux

 Open the project generated by CMake in the corresponding IDE (e.g., Codeblocks) or execute GNU Make to build the plug-in.

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v9
+++ v10
@@ -116,18 +116,25 @@

 This issue was solved in Maya 2011. 

-## Output
+## Troubleshooting

-The compiled plug-in will be stored in the 
-    
-    bin
+If Maya2OSG plug-in does not work, check the following: 

-directory under the directory for the chosen Maya version. It will be 
-    
-    maya2osg.mll
+  1. Make sure the plug-in (
+        
+        maya2osg.mll

-in Windows and 
-    
-    maya2osg.so
+or 
+        
+        maya2osg.so

-in Linux.
+) is placed in the right directory, where Maya can find it, and with the right file permissions. If it is not, Maya will show a message like this one: 
+        
+        // Error: Plug-in, "maya2osg.mll", was not found on MAYA_PLUG_IN_PATH.
+
+  2. Make sure all the libraries the plug-in depends on are available in the system or user PATH. Otherwise, Maya will show a message like this one: 
+        
+        // Error: The specified module could not be found.
+
+Check also that the OSG version installed in your system is the same version used to compile the plug-in. 
+  3. Check the Output Window (or the standard output in Linux) for error messages or debugging information during the execution of the Maya2OSG plug-in.

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v8
+++ v9
@@ -85,22 +85,19 @@

 ## Linux

-TO-DO ... 
+Open the project generated by CMake in the corresponding IDE (e.g., Codeblocks) or execute GNU Make to build the plug-in. 

-Change to the directory of the Maya version you intend to compile the plug-in for and then to the Linux folder. Execute GNU makefile to compile the plug-in. 
+You have a Makefile target called 
+    
+    install

-For example, the Maya 2010 plug-in for Linux can be built just type: 
+to install the plug-in and configuration files in your system. The user invoking make install must have write permissions in the Maya plug-ins directory. You can 'su' to root to install the plug-in. 

-    $ cd wherever_it_is/maya2osg/maya2010/Linux
-    $ make
+    $ sudo make install

-and it will create the 
-    
-    wherever_it_is/maya2osg/maya2010/bin/maya2osg.so
-
-file. 
+This will put each file in the right place to use the plug-in inside Maya.

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v7
+++ v8
@@ -61,19 +61,27 @@

 ## Windows (Visual Studio)

-Current Visual Studio project try to install the plug-in (
+Open the solution created by CMake: 
+    
+    Maya2OSG.sln
+
+. Select a configuration for the build. Release configuration is OK unless you want to develop or debug the plug-in. In this case, a better choice is Debug. 
+
+Build the project (maya2osg or the default selection ALL_BUILD). 
+
+You can install the built plug-in in your system by building the target INSTALL. 
+
+Visual Studio project will try to install the plug-in (

     maya2osg.mll

-) in the plug-ins directory of Maya in its default location (e.g. 
+) in the Maya plug-ins directory (its default location is 

     C:\Program Files\Autodesk\Maya 2011\bin\plug-ins

-) unless you have specified otherwise in the CMake options. The plug-in installation may fail in modern systems (such as Windows Vista or Windows 7) because of file permissions. 
+) unless you have specified otherwise in the CMake options. The plug-in installation may fail in modern systems (such as Windows Vista or Windows 7) because of file permissions. Additional files (MEL scripts, shelf buttons, ...) will also be automatically installed in the current user Maya default directory. 

-Additional files (MEL scripts, shelf buttons, ...) will also be automatically installed in the current user Maya default directory. 
-
-A fast workaround to the above mentioned permission problem is to give modification access to the plug-ins directory for the user that is doing the compilation. You can also run Visual Studio as superuser. 
+A fast workaround to the above mentioned permission problem is to give modification access to the plug-ins directory for the user that is doing the compilation. You can also run Visual Studio as superuser when installing. 

 ## Linux

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v6
+++ v7
@@ -38,7 +38,26 @@

 ## Generating the project

-... TO-DO 
+To generate the project for your system, you need a recent version of CMake. I am currently using 2.8.4 in Windows and 2.8.0 in Linux. It may work with previous versions, however. 
+
+CMake has a command line version (cmake) and a GUI (cmake-gui). For detailed instructions about using CMake, consult its documentation in http://www.cmake.org/cmake/help/documentation.html. 
+
+[[img src=cmake.jpg]] 
+
+1\. Launch the CMake GUI and set the location of all dependencies: OSG and OpenThreads libraries can be easily located if OSG_DIR environment variable is defined before calling cmake-gui. 
+
+2\. Check the Maya version you want the plug-in installed into and set it and the directories needed to create the project. 
+    
+    * MAYA_ARCH - This is currently unused in 32-bit. You can safely let it to x64.
+    * MAYA_VERSION - Maya version you want to install the plug-in into.
+    * MAYA_ROOT - Maya installation directory. This is the location where to look for the Maya SDK.
+    * MAYA_PLUGINS_DIR - Destination directory to install the plug-in into.
+    * MAYA_USER_DIR - Directory where the Maya user configuration is stored. By default, the maya folder at the home directory or [My ]Documents.
+    
+
+3\. Press Configure. Select the kind the project for your favourite development environment. 
+
+4\. Press Generate. The selected projects will be generated. 

 ## Windows (Visual Studio)

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v5
+++ v6
@@ -9,7 +9,7 @@

 ## Prerequisites

-To use the Maya2OSG plug-in, the following dependencies must be installed in the system: 
+To build and install the Maya2OSG plug-in, the following dependencies must be installed in the system: 

   * Maya SDK (installs automatically with Maya). 
   * [OpenSceneGraph](http://www.openscenegraph.org) libraries and headers. 
@@ -35,9 +35,6 @@
   * OpenSceneGraph 2.6.x 
   * OpenSceneGraph 2.8.x 
   * OpenSceneGraph 2.9.x 
-
-  
-

 ## Generating the project

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:31 -0000

--- v4
+++ v5
@@ -1,9 +1,10 @@
+_NOTE: The old pages, that were appliable until 0.4.2c have been replaced by this page when porting the building system to CMake. They are still available in the following links:_
+
+  * _[Compilation_instructions]_
+  * _[Installation_instructions]_
+
 NOTE: This page is kept up to date with SVN code of Maya2OSG. For instructions regarding a specific release, look in the README file.

-The old pages, that were appliable until 0.4.2c have been replaced by this page when porting the building system to CMake. They are still available in the following links: 
-
-  * [Compilation_instructions] 
-  * [Installation_instructions] 
 [TOC]

 ## Prerequisites

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:30 -0000

--- v3
+++ v4
@@ -1,7 +1,9 @@
-NOTE: The old pages, appliable until 0.4.2c have been replaced by this page when porting the building system to CMake. They are still available in [Compilation_instructions_(deprecated)] and [Installation_instructions]) 
+NOTE: This page is kept up to date with SVN code of Maya2OSG. For instructions regarding a specific release, look in the README file.

-This page is kept up to date with SVN code of Maya2OSG. For instructions regarding a specific release, look in the README file. 
+The old pages, that were appliable until 0.4.2c have been replaced by this page when porting the building system to CMake. They are still available in the following links: 

+  * [Compilation_instructions] 
+  * [Installation_instructions] 
 [TOC]

 ## Prerequisites
@@ -32,6 +34,9 @@
   * OpenSceneGraph 2.6.x 
   * OpenSceneGraph 2.8.x 
   * OpenSceneGraph 2.9.x 
+
+  
+

 ## Generating the project

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:30 -0000

--- v2
+++ v3
@@ -1,4 +1,4 @@
-(The old page, appliable until 0.4.2c has being replaced when porting to CMake. It is still available in [Compilation_instructions_(deprecated)]) 
+NOTE: The old pages, appliable until 0.4.2c have been replaced by this page when porting the building system to CMake. They are still available in [Compilation_instructions_(deprecated)] and [Installation_instructions])

 This page is kept up to date with SVN code of Maya2OSG. For instructions regarding a specific release, look in the README file.

Building_and_installing modified by Javier Taibo

Javier Taibo — Wed, 21 May 2014 09:47:30 -0000