Difference between revisions of "DOM guide: Setting up"

From COLLADA Public Wiki
Jump to navigation Jump to search
m (Note dead link)
 
(95 intermediate revisions by 9 users not shown)
Line 1: Line 1:
This article describes how to set up your software and system to use the [[COLLADA DOM]].
+
This article describes how to obtain the Collada DOM and use it in a program.
 
 
==Overview==
 
To use the COLLADA DOM in a client application, you must:
 
* Download the DOM
 
* Download the external libraries that the DOM uses
 
* Build the DOM
 
* Build your client application
 
{{editor|what= Include a discussion of how to build on Linux.}}
 
  
 
==Downloading the COLLADA DOM==
 
==Downloading the COLLADA DOM==
The COLLADA DOM is available royalty free and open source for download from SourceForge at http://sourceforge.net/projects/collada-dom.
+
The latest official release of the DOM is version 2.2, which is available as a [http://sourceforge.net/project/showfiles.php?group_id=157838 download] on Sourceforge.
 
 
The COLLADA 1.4.1 DOM 1.3.0 is the latest release package. It comes in three varieties:
 
* A source-code-only distribution
 
* A binary installer for Visual Studio .NET 2005 (VC8)
 
* A binary installer for Visual Studio .NET 2003 (VC7)
 
  
The COLLADA DOM is packaged for release only a few times a year. The latest COLLADA DOM code, containing the most recent bug fixes and features, can be downloaded directly from the Subversion repository on SourceForge. To grab the code from Subversion, you'll first need to download and install a Subversion client for your platform from http://subversion.tigris.org/project_packages.html. Then, open a console and run the command:
+
You can also get the DOM from the SVN repository on Sourceforge. For that you'll need a [http://subversion.tigris.org/project_packages.html Subversion client]. To check out version 2.2, open a shell and run
  <nowiki>svn co https://collada-dom.svn.sourceforge.net/svnroot/collada-dom/COLLADA_DOM/trunk COLLADA_DOM</nowiki>
+
  svn co <nowiki>https://collada-dom.svn.sourceforge.net/svnroot/collada-dom/tags/2.2</nowiki> colladadom
That downloads the latest copy of the COLLADA DOM to the COLLADA_DOM subdirectory (as specified by the last parameter).
+
or, to check out the trunk, run
 +
svn co <nowiki>https://collada-dom.svn.sourceforge.net/svnroot/collada-dom/trunk</nowiki> colladadom
  
===External Libraries===
+
==Windows (Visual Studio)==
 +
===Building the DOM===
 +
Project and solution files for Visual Studio are in
 +
<dom-path>\projects
 +
Project files for both VS 2005 and VS 2008 are provided. Open dom.sln and build the <code>dom</code> project for the DLL DOM, or build <code>dom-static</code> for the DOM static lib. The output goes to the <code>''<dom-path>''\build</code> folder. Before building the DOM static lib be sure to include daeZAEUncompressHandler.cpp in the project source files. This can be found in <code>''<dom-path>''\include\dae</code> folder.
  
====Windows====
+
===Building client applications===
The COLLADA DOM and all client applications have three external dependencies, libxml2, zlib, and iconv. The most current Windows binaries for these libraries can be downloaded from http://www.zlatkovic.com/libxml.en.html. For convenience, these libraries are packaged together in the "External Libaries" package available from the COLLADA DOM SourceForge download page.
 
  
Building the COLLADA DOM requires that the files for the external libraries on which it depends be in a specific directory structure. An environment variable, <code>COLLADA_EXTERNAL_LIBS_LOCATION</code>, needs to be set to the directory that contains the following files:
+
In several paths below you'll see "vc8". That's for Visual C++ 8 (Visual Studio 2005). If you're using Visual C++ 9 (Visual Studio 2008), substitute "vc9" for "vc8" everywhere.
libxml2/win32/include/libxml/* - The libxml2 headers from the distribution
 
libxml2/win32/include/iconv.h
 
libxml2/win32/include/zlib.h
 
libxml2/win32/lib/iconv_a.lib
 
libxml2/win32/lib/libxml2_a.lib
 
libxml2/win32/lib/zlib.lib
 
  
==Building Client Applications with Visual Studio==
+
You'll also see "1.4" and "14", which refers to COLLADA 1.4. If you're using COLLADA 1.5, use "1.5" and "15" instead.
VisualStudio.NET requires additional path and dependency information to properly compile and link
 
applications using the COLLADA DOM.  
 
  
===Setting up include directories===
+
====Setting up include directories====
Add the following information to your project:
+
*In your project, add these lines to the '''Additional include directories''' field in the '''General''' tab for the '''C/C++''' project configuration settings:
*Add the following lines to the '''Additional include directories''' field in the '''General''' tab for the '''C/C++''' project configuration settings:
+
  <dom-path>\include
  <COLLADA_DOM-path>\include
+
  <dom-path>\include\1.4
  <COLLADA_DOM-path>\include\1.4
+
<dom-path>\external-libs\boost
  
===Linking with the static COLLADA DOM libararies===
+
====Setting up preprocessor definitions====
The COLLADA DOM is provided as both static and dynamic link libraries.
+
*In '''dom''' or '''dom-static''' project, add these lines to the '''Preprocessor Definitions''' field in the '''Preprocessor''' tab for the '''C/C++''' project configuration settings:
 +
BOOST_ALL_NO_LIB
 +
PCRE_STATIC
 +
DOM_INCLUDE_LIBXML
  
To link with the static COLLADA DOM libraries:
+
====Linking with the COLLADA DOM static lib====
 
*Add the following lines to the '''Additional library directories''' field in the '''General''' tab for the '''Linker''' project configuration settings:
 
*Add the following lines to the '''Additional library directories''' field in the '''General''' tab for the '''Linker''' project configuration settings:
  <COLLADA_DOM-path>\lib\vc8\1.4
+
  ''<dom-path>''\build\vc8-1.4 (release) or ''<dom-path>''\build\vc8-1.4-d (debug)
  <libxml2, zlib, and iconv lib directory-path>  
+
  ''<dom-path>''\external-libs\libxml2\win32\lib
 +
''<dom-path>''\external-libs\pcre\lib\vc8
 +
''<dom-path>''\external-libs\minizip\win32\lib\
 +
''<dom-path>''\external-libs\boost\lib\vc8
 
*Add the following lines to the '''Additional Dependencies''' field in the '''Input''' tab for the '''Linker''' project configuration settings:
 
*Add the following lines to the '''Additional Dependencies''' field in the '''Input''' tab for the '''Linker''' project configuration settings:
  libcollada_dae.lib
+
  libcollada14dom22-s.lib (release) or libcollada14dom22-sd.lib (debug)
libcollada_dom.lib
 
libcollada_STLDatabase.lib
 
libcollada_LIBXMLPlugin.lib
 
libcollada_stdErrPlugin.lib
 
 
  libxml2_a.lib
 
  libxml2_a.lib
iconv_a.lib
 
 
  zlib.lib
 
  zlib.lib
 
  wsock32.lib
 
  wsock32.lib
 +
pcre.lib (release) or pcre-d.lib (debug)
 +
pcrecpp.lib (release) or pcrecpp-d.lib (debug)
 +
minizip.lib (release) or minizip-d.lib (debug)
 +
libboost_filesystem.lib (release) or libboost_filesystem-d.lib (debug)
 +
libboost_system.lib (release) or libboost_system-d.lib (debug)
 +
 +
=====Linker warnings/Runtime errors=====
 +
When you build an application that links against the DOM statically, you might get a Visual Studio warning like this:
 +
LINK : warning LNK4098: defaultlib 'MSVCRT' conflicts with use of other libs; use /NODEFAULTLIB:library
 +
If you ignore this warning, you'll then get a runtime failure message that says
 +
This application has failed to start because MSVCR80.dll was not found. ...
 +
If you have this problem, go to the '''Ignore Specific Library''' section in the linker settings of your project and add <code>msvcrt</code>. Then relink your project. The link warning should be gone and your application should run fine.
  
===Linking with the dynamic COLLADA DOM library===
+
====Linking with the COLLADA DOM DLL====
To link with the dynamic COLLADA DOM library:
+
*Add the following line to the '''Preprocessor Definitions''' field in the '''Preprocessor''' tab for the '''C/C++''' project configuration settings:
*Add the following line to the '''Preprecessor Definitions''' field in the '''Preprocessor''' tab for the '''C/C++''' project configuration settings:
 
 
  DOM_DYNAMIC
 
  DOM_DYNAMIC
*Add the following line to the '''Additional library directories''' field in the '''General''' tab for the '''Linker''' project configuration settings:
+
*Add the following to the '''Additional library directories''' field in the '''General''' tab for the '''Linker''' project configuration settings:
  <COLLADA_DOM-path>\lib\vc8
+
  <dom-path>\build\vc8-1.4 (release) or <dom-path>\build\vc8-1.4-d (debug)
*Add the following line to the '''Additional Dependencies''' field in the '''Input''' tab for the '''Linker''' project configuration settings:
+
<dom-path>\external-libs\boost\lib\vc8
  libcollada141dom13.lib
+
*Add the following to the '''Additional Dependencies''' field in the '''Input''' tab for the '''Linker''' project configuration settings:
 +
  libcollada14dom22.lib (release) or libcollada14dom22-d.lib (debug)
 +
libboost_filesystem.lib (release) or libboost_filesystem-d.lib (debug)
 +
libboost_system.lib (release) or libboost_system-d.lib (debug)
 +
 
 +
==Linux==
 +
===Preparing the external libraries===
 +
You need both the libxml and [http://www.pcre.org/ PCRE] headers and libs installed to build the DOM. For the domTest program you also need the [http://www.boost.org/doc/libs/1_35_0/libs/filesystem/doc/index.htm Boost Filesystem] library installed. These libraries are fairly popular and it's expected that most Linux distributions will provide them via the package manager, so these libraries aren't provided with the Linux DOM as they are for Windows and Mac. For example, in Ubuntu you could install these libraries using aptitude:
 +
aptitude install libxml2-dev libpcre3-dev libboost-filesystem-dev
 +
 
 +
===Building the DOM===
 +
On Linux, the DOM builds as both a static lib (.a) and as a shared lib (.so). All output goes to the <code>''<dom-path>''/build</code> folder.
 +
 
 +
Go to the COLLADA DOM directory and run
 +
make
 +
 
 +
This builds a release version of the DOM. More extensive documentation of our make build system is available in the [http://collada-dom.svn.sourceforge.net/viewvc/collada-dom/trunk/dom/make/readme?view=markup ''<dom-path>''/make/readme] ''(DEAD LINK)'' file included with the DOM.
 +
 
 +
'''Important:''' <code>make</code> version 3.81 or higher is required to build COLLADA DOM. <code>make</code> 3.80 will fail with strange error messages. Also, g++ version 3.4 or higher is required; version 3.3 is known not to be able to build the source code.
 +
 
 +
===Building client applications===
 +
 
 +
====Building a client app====
 +
If you have a file named test.cpp that works with the COLLADA DOM, you can build it to use the static DOM lib with g++ like this:
 +
g++ -I''<dom-path>''/include -I''<dom-path>''/include/1.4 test.cpp -L''<dom-path>''/build/linux-1.4
 +
  ''<dom-path>''/build/linux-1.4/libcollada14dom.a -lxml2 -lpcre -lpcrecpp -lboost_filesystem -lminizip -o test
 +
'''NOTE:''' you may need to add -lcollada14dom after specifying where the libraries are with -L.
 +
 
 +
Or you can build to use the DOM shared lib:
 +
g++ -I''<dom-path>''/include -I''<dom-path>''/include/1.4 test.cpp  -L''<dom-path>''/build/linux-1.4
 +
  ''<dom-path>''/build/linux-1.4/libcollada14dom.so -lxml2 -lpcre -lpcrecpp -lboost_filesystem -lminizip -o test
 +
 
 +
====Installing the DOM for easier setup====
 +
When building client applications on Linux, it's convenient to install headers and libs to a standard system path, such as /usr/[include,lib] or /usr/local/[include,lib]. To install, go to the COLLADA DOM directory and run
 +
make install
 +
which puts the headers in /usr/local/include and the libs in /usr/local/lib. The make install rule also takes a 'prefix' argument that allows you to specify where to install to. See the [http://collada-dom.svn.sourceforge.net/viewvc/collada-dom/trunk/dom/make/readme?view=markup make readme] for more info.
 +
 
 +
You can uninstall by running
 +
make uninstall
 +
The DOM remembers your installation location and uninstalls itself from that location.
 +
 
 +
The main benefit of this is that you can make sure that the DOM shared lib is in your PATH, so you can easily run a program that links against the shared lib.
 +
 
 +
==Mac==
 +
'''Note:''' The only officially supported version of OS X is 10.5 (Leopard), but the DOM used to work on Tiger and might still work, as long as you have GNU make 3.81 (available via Macports).
 +
 
 +
===Building the DOM===
 +
====Using Xcode====
 +
Xcode project files are in
 +
''<dom-path>''/projects
 +
The build output goes to the <code>''<dom-path>''/build</code> folder.
 +
 
 +
====Using make and gcc====
 +
The Mac uses the same make build architecture as Linux and PS3. Simply run 'make' in the DOM folder to build a release framework. See the [http://collada-dom.svn.sourceforge.net/viewvc/collada-dom/trunk/dom/make/readme?view=markup make readme] for more info. The build output goes to ''<dom-path>''/build.
 +
 
 +
'make install' is also available to copy the DOM framework to /Library/Frameworks.
 +
 
 +
===Building client applications===
 +
====Using Xcode====
 +
In Xcode, add the DOM framework to your project (''Project->Add to Project''). In the build configuration of your target, add ''<dom-path>''/Collada14Dom.framework/Headers to '''Header Search Paths'''. For a debug build, the framework name is Collada14Dom-d.framework, so adjust paths accordingly.
 +
 
 +
'''Important!''' By default, Xcode 3 adds two preprocessor flags (_GLIBCXX_DEBUG=1 and _GLIBCXX_DEBUG_PEDANTIC=1) to the debug build of an application to enable extra debugging of the C++ standard library. These settings are incompatible with the DOM or any library that isn't compiled with those settings. These settings cause the DOM to crash when it tries to use C++ containers like std::map. To fix this, remove those flags from your debug build settings (make sure to check the target settings, not just the normal project settings). Another option is to rebuild the DOM with those flags set. To do so:
 +
# Open the ''<dom>''/make/common.mk file.
 +
# Add "<code>-D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC</code>" to the line "<code>ccFlags += -g -D_DEBUG</code>".
 +
 
 +
====Using make and gcc====
 +
Additional gcc compiler arguments:
 +
-I''<dom-path>''/Collada14Dom.framework/Headers
 +
Additional linker arguments: 
 +
-F''<dom-path>'' (if the DOM isn't in a standard path such as /Library/Frameworks)
 +
-framework Collada14Dom
 +
For a debug build, the framework name is Collada14Dom-d.framework, so adjust the gcc arguments accordingly.
 +
 
 +
====Using different installation locations for DOM framework====
 +
You can install the DOM framework in a different location than /Library/Frameworks. For example, you might use it as an embedded framework in your application bundle. To avoid linker errors, you can either:
 +
* Change the '''Installation Directory''' build setting in the DOM Xcode project and rebuild the project
 +
* Use '''otool''' and '''install_name_tool''' to modify an existing framework.
 +
For more information, see
 +
man otool
 +
and
 +
man install_name_tool
 +
 
 +
==Windows (MinGW)==
 +
The DOM can be built on Windows with the MinGW compiler, which can be obtained from [http://sourceforge.net/project/showfiles.php?group_id=2435 Sourceforge]. The compiler that comes with the MinGW 5.1.3 automated installer was used for testing and building the external libs. The external libs should also work with newer versions of the compiler but that hasn't been tested.
 +
 
 +
In addition to the compiler you need a Unix environment that includes GNU make 3.81. For this there are at least two choices: MSYS (which can be downloaded from the Sourceforge link above) and [http://www.cygwin.com/ Cygwin]. Both should work fine.
 +
 
 +
===Building the DOM===
 +
On Windows, the DOM builds as both a static lib (.a) and as a shared lib (.dll). All output goes to the <code>''<dom-path>''/build</code> folder.
  
===Additional configuration options===
+
Go to the ''<dom-path>'' directory and run
*If you are using Visual Studio .NET 2003, sunbstitute '''vc7''' for '''vc8''' in the '''Additional library directories''' field.
+
make
*To use the debug version of the libraries:
 
*# Append "_d" to the end of the COLLADA DOM library names, for example, libcollada_dae_d.lib.
 
*# Replace "lib" with "lib-dbg" in the library path.
 
*Make sure that your application is using the correct runtime libraries. The '''Runtime Library''' field in the '''Code Generation''' tab for the '''C/C++''' configuration options should be set to:
 
** "Multi-threaded DLL" if using the release builds of the library
 
** "Multi-threaded Debug DLL" if using the debug builds
 
  
==Building the COLLADA DOM==
+
The MinGW build is very similar to the Linux build, so refer to that section and the [http://collada-dom.svn.sourceforge.net/viewvc/collada-dom/trunk/dom/make/readme?view=markup make readme] for more information.
Though most developers can use the previously built libraries, the distribution of the COLLADA DOM includes
 
full source code and Visual Studio projects for rebuilding the libraries from scratch. Project and solution files for Visual Studio .NET 2003 can be found in
 
<COLLADA_DOM-directory>/projects/VC++7
 
Project and solution files for Visual Studio .NET 2005 can be found in
 
<COLLADA_DOM-directory>/projects/VC++8
 
  
===External Libraries===
+
==PS3==
Building the COLLADA DOM requires that the files for the external libraries on which it depends be in a specific directory structure. An environment variable, <code>COLLADA_EXTERNAL_LIBS_LOCATION</code>, needs to be set to the directory that contains the following files:
+
The DOM works on the Cell OS Level 2, for example to be used in a PS3 game. The DOM uses the same make build architecture for PS3 as it does for Mac and Linux, so the same info applies. Run 'make os=ps3' in the DOM directory to do a release build. See the [http://collada-dom.svn.sourceforge.net/viewvc/collada-dom/trunk/dom/make/readme?view=markup make readme] for more info.  
libxml2/win32/include/libxml/* - The libxml2 headers from the distribution
 
libxml2/win32/include/iconv.h
 
libxml2/win32/include/zlib.h
 
libxml2/win32/lib/iconv_a.lib
 
libxml2/win32/lib/libxml2_a.lib
 
libxml2/win32/lib/zlib.lib
 
  
{{DOM navigation}}
+
Some notes about the PS3 build:
 +
* Cell OS Level 2 doesn't support shared libraries, so only static DOM libs are built.
 +
* The DOM on PS3 uses TinyXml instead of libxml for XML parsing. You'll need to link TinyXml into your app.
 +
* PS3 libraries for PCRE and TinyXml are provided in the external-libs folder.
 +
* It should be possible to build the PS3 version of the DOM on Windows using the GNU makefiles via MinGW/MSYS, but this hasn't been tested.
  
[[Category:DOM tutorial|Setting up]]
+
[[Category:COLLADA DOM|Setting up]]

Latest revision as of 01:33, 16 July 2013

This article describes how to obtain the Collada DOM and use it in a program.

Downloading the COLLADA DOM

The latest official release of the DOM is version 2.2, which is available as a download on Sourceforge.

You can also get the DOM from the SVN repository on Sourceforge. For that you'll need a Subversion client. To check out version 2.2, open a shell and run

svn co https://collada-dom.svn.sourceforge.net/svnroot/collada-dom/tags/2.2 colladadom

or, to check out the trunk, run

svn co https://collada-dom.svn.sourceforge.net/svnroot/collada-dom/trunk colladadom

Windows (Visual Studio)

Building the DOM

Project and solution files for Visual Studio are in

<dom-path>\projects

Project files for both VS 2005 and VS 2008 are provided. Open dom.sln and build the dom project for the DLL DOM, or build dom-static for the DOM static lib. The output goes to the <dom-path>\build folder. Before building the DOM static lib be sure to include daeZAEUncompressHandler.cpp in the project source files. This can be found in <dom-path>\include\dae folder.

Building client applications

In several paths below you'll see "vc8". That's for Visual C++ 8 (Visual Studio 2005). If you're using Visual C++ 9 (Visual Studio 2008), substitute "vc9" for "vc8" everywhere.

You'll also see "1.4" and "14", which refers to COLLADA 1.4. If you're using COLLADA 1.5, use "1.5" and "15" instead.

Setting up include directories

  • In your project, add these lines to the Additional include directories field in the General tab for the C/C++ project configuration settings:
<dom-path>\include
<dom-path>\include\1.4
<dom-path>\external-libs\boost

Setting up preprocessor definitions

  • In dom or dom-static project, add these lines to the Preprocessor Definitions field in the Preprocessor tab for the C/C++ project configuration settings:
BOOST_ALL_NO_LIB
PCRE_STATIC
DOM_INCLUDE_LIBXML

Linking with the COLLADA DOM static lib

  • Add the following lines to the Additional library directories field in the General tab for the Linker project configuration settings:
<dom-path>\build\vc8-1.4 (release) or <dom-path>\build\vc8-1.4-d (debug)
<dom-path>\external-libs\libxml2\win32\lib
<dom-path>\external-libs\pcre\lib\vc8
<dom-path>\external-libs\minizip\win32\lib\
<dom-path>\external-libs\boost\lib\vc8
  • Add the following lines to the Additional Dependencies field in the Input tab for the Linker project configuration settings:
libcollada14dom22-s.lib (release) or libcollada14dom22-sd.lib (debug)
libxml2_a.lib
zlib.lib
wsock32.lib
pcre.lib (release) or pcre-d.lib (debug)
pcrecpp.lib (release) or pcrecpp-d.lib (debug)
minizip.lib (release) or minizip-d.lib (debug)
libboost_filesystem.lib (release) or libboost_filesystem-d.lib (debug)
libboost_system.lib (release) or libboost_system-d.lib (debug)
Linker warnings/Runtime errors

When you build an application that links against the DOM statically, you might get a Visual Studio warning like this:

LINK : warning LNK4098: defaultlib 'MSVCRT' conflicts with use of other libs; use /NODEFAULTLIB:library

If you ignore this warning, you'll then get a runtime failure message that says

This application has failed to start because MSVCR80.dll was not found. ...

If you have this problem, go to the Ignore Specific Library section in the linker settings of your project and add msvcrt. Then relink your project. The link warning should be gone and your application should run fine.

Linking with the COLLADA DOM DLL

  • Add the following line to the Preprocessor Definitions field in the Preprocessor tab for the C/C++ project configuration settings:
DOM_DYNAMIC
  • Add the following to the Additional library directories field in the General tab for the Linker project configuration settings:
<dom-path>\build\vc8-1.4 (release) or <dom-path>\build\vc8-1.4-d (debug)
<dom-path>\external-libs\boost\lib\vc8
  • Add the following to the Additional Dependencies field in the Input tab for the Linker project configuration settings:
libcollada14dom22.lib (release) or libcollada14dom22-d.lib (debug)
libboost_filesystem.lib (release) or libboost_filesystem-d.lib (debug)
libboost_system.lib (release) or libboost_system-d.lib (debug)

Linux

Preparing the external libraries

You need both the libxml and PCRE headers and libs installed to build the DOM. For the domTest program you also need the Boost Filesystem library installed. These libraries are fairly popular and it's expected that most Linux distributions will provide them via the package manager, so these libraries aren't provided with the Linux DOM as they are for Windows and Mac. For example, in Ubuntu you could install these libraries using aptitude:

aptitude install libxml2-dev libpcre3-dev libboost-filesystem-dev

Building the DOM

On Linux, the DOM builds as both a static lib (.a) and as a shared lib (.so). All output goes to the <dom-path>/build folder.

Go to the COLLADA DOM directory and run

make

This builds a release version of the DOM. More extensive documentation of our make build system is available in the <dom-path>/make/readme (DEAD LINK) file included with the DOM.

Important: make version 3.81 or higher is required to build COLLADA DOM. make 3.80 will fail with strange error messages. Also, g++ version 3.4 or higher is required; version 3.3 is known not to be able to build the source code.

Building client applications

Building a client app

If you have a file named test.cpp that works with the COLLADA DOM, you can build it to use the static DOM lib with g++ like this:

g++ -I<dom-path>/include -I<dom-path>/include/1.4 test.cpp -L<dom-path>/build/linux-1.4
 <dom-path>/build/linux-1.4/libcollada14dom.a -lxml2 -lpcre -lpcrecpp -lboost_filesystem -lminizip -o test

NOTE: you may need to add -lcollada14dom after specifying where the libraries are with -L.

Or you can build to use the DOM shared lib:

g++ -I<dom-path>/include -I<dom-path>/include/1.4 test.cpp  -L<dom-path>/build/linux-1.4 
 <dom-path>/build/linux-1.4/libcollada14dom.so -lxml2 -lpcre -lpcrecpp -lboost_filesystem -lminizip -o test

Installing the DOM for easier setup

When building client applications on Linux, it's convenient to install headers and libs to a standard system path, such as /usr/[include,lib] or /usr/local/[include,lib]. To install, go to the COLLADA DOM directory and run

make install

which puts the headers in /usr/local/include and the libs in /usr/local/lib. The make install rule also takes a 'prefix' argument that allows you to specify where to install to. See the make readme for more info.

You can uninstall by running

make uninstall

The DOM remembers your installation location and uninstalls itself from that location.

The main benefit of this is that you can make sure that the DOM shared lib is in your PATH, so you can easily run a program that links against the shared lib.

Mac

Note: The only officially supported version of OS X is 10.5 (Leopard), but the DOM used to work on Tiger and might still work, as long as you have GNU make 3.81 (available via Macports).

Building the DOM

Using Xcode

Xcode project files are in

<dom-path>/projects

The build output goes to the <dom-path>/build folder.

Using make and gcc

The Mac uses the same make build architecture as Linux and PS3. Simply run 'make' in the DOM folder to build a release framework. See the make readme for more info. The build output goes to <dom-path>/build.

'make install' is also available to copy the DOM framework to /Library/Frameworks.

Building client applications

Using Xcode

In Xcode, add the DOM framework to your project (Project->Add to Project). In the build configuration of your target, add <dom-path>/Collada14Dom.framework/Headers to Header Search Paths. For a debug build, the framework name is Collada14Dom-d.framework, so adjust paths accordingly.

Important! By default, Xcode 3 adds two preprocessor flags (_GLIBCXX_DEBUG=1 and _GLIBCXX_DEBUG_PEDANTIC=1) to the debug build of an application to enable extra debugging of the C++ standard library. These settings are incompatible with the DOM or any library that isn't compiled with those settings. These settings cause the DOM to crash when it tries to use C++ containers like std::map. To fix this, remove those flags from your debug build settings (make sure to check the target settings, not just the normal project settings). Another option is to rebuild the DOM with those flags set. To do so:

  1. Open the <dom>/make/common.mk file.
  2. Add "-D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC" to the line "ccFlags += -g -D_DEBUG".

Using make and gcc

Additional gcc compiler arguments:

-I<dom-path>/Collada14Dom.framework/Headers

Additional linker arguments:

-F<dom-path> (if the DOM isn't in a standard path such as /Library/Frameworks)
-framework Collada14Dom

For a debug build, the framework name is Collada14Dom-d.framework, so adjust the gcc arguments accordingly.

Using different installation locations for DOM framework

You can install the DOM framework in a different location than /Library/Frameworks. For example, you might use it as an embedded framework in your application bundle. To avoid linker errors, you can either:

  • Change the Installation Directory build setting in the DOM Xcode project and rebuild the project
  • Use otool and install_name_tool to modify an existing framework.

For more information, see

man otool

and

man install_name_tool

Windows (MinGW)

The DOM can be built on Windows with the MinGW compiler, which can be obtained from Sourceforge. The compiler that comes with the MinGW 5.1.3 automated installer was used for testing and building the external libs. The external libs should also work with newer versions of the compiler but that hasn't been tested.

In addition to the compiler you need a Unix environment that includes GNU make 3.81. For this there are at least two choices: MSYS (which can be downloaded from the Sourceforge link above) and Cygwin. Both should work fine.

Building the DOM

On Windows, the DOM builds as both a static lib (.a) and as a shared lib (.dll). All output goes to the <dom-path>/build folder.

Go to the <dom-path> directory and run

make

The MinGW build is very similar to the Linux build, so refer to that section and the make readme for more information.

PS3

The DOM works on the Cell OS Level 2, for example to be used in a PS3 game. The DOM uses the same make build architecture for PS3 as it does for Mac and Linux, so the same info applies. Run 'make os=ps3' in the DOM directory to do a release build. See the make readme for more info.

Some notes about the PS3 build:

  • Cell OS Level 2 doesn't support shared libraries, so only static DOM libs are built.
  • The DOM on PS3 uses TinyXml instead of libxml for XML parsing. You'll need to link TinyXml into your app.
  • PS3 libraries for PCRE and TinyXml are provided in the external-libs folder.
  • It should be possible to build the PS3 version of the DOM on Windows using the GNU makefiles via MinGW/MSYS, but this hasn't been tested.