Difference between revisions of "Refinery on Mac OS X"

From COLLADA Public Wiki
Jump to: navigation, search
(New page: For the OS X version of the Refinery you will find a Xcode project file to build an application bundle and an external framework. This allows you to have access to the bundled conditioners...)
 
Line 6: Line 6:
  
 
*Collada141Dom.framework for Mac OS X
 
*Collada141Dom.framework for Mac OS X
**Go [http://www.collada.org/mediawiki/index.php/DOM_guide:_Setting_up#Mac_2 here] for build-instructions on the OS X ColladaDom-Framework **Install to /Library/Frameworks.
+
:Go [http://www.collada.org/mediawiki/index.php/DOM_guide:_Setting_up#Mac_2 here] for build-instructions on the OS X ColladaDom-Framework  
  
 
*JavaVM.framework
 
*JavaVM.framework
**Shipped with OS X Tiger already, no need to install.
+
:Shipped with OS X Tiger already, no need to install.
 
  
 
== Building ==
 
== Building ==
Line 21: Line 20:
 
#Creating the JNI Wrapper for the conditioner C++ interface.
 
#Creating the JNI Wrapper for the conditioner C++ interface.
 
#Creating the ColladaRefineryConditioner.framework which can be used for external conditioner-plugins.
 
#Creating the ColladaRefineryConditioner.framework which can be used for external conditioner-plugins.
#Compiling the default conditioners that are bundlded with the Refinery
+
#Compiling the default conditioners that are bundled with the Refinery
 
#Packaging the Java-Application into an Application bundle convenient for Mac OS X Tiger.
 
#Packaging the Java-Application into an Application bundle convenient for Mac OS X Tiger.
  
 
Note that using the Release-configuration all builds are '''Universal Binary''' for PPC- and Intel-architecture.
 
Note that using the Release-configuration all builds are '''Universal Binary''' for PPC- and Intel-architecture.
  
The build-process creates two important components:
+
After building the default target, you end up with two important build-products:
*Refinery Application Bundle
+
*'''Refinery Application Bundle'''
**The Java-frame in a Mac-fashioned App-Bundle. Already includes the default conditioners that are shipped with the Refinery.
+
:The Java-frame in a Mac-fashioned App-Bundle. Already includes the default conditioners that are shipped with the Refinery.
* ColladaRefineryConditioner.framework  
+
*'''ColladaRefineryConditioner.framework'''
**Interface to import conditioner-plugins that allows users to create their own conditioners. Each conditioner has to link against this library.  
+
:Interface to import conditioner-plugins that allows users to create their own conditioners. Each conditioner has to link against this library.  
  
 
== Installation ==
 
== Installation ==
Line 36: Line 35:
 
Copy
 
Copy
 
  <COLLADA_REFINERY-directory>/projects/Xcode/build/Release/Collada Refinery.app
 
  <COLLADA_REFINERY-directory>/projects/Xcode/build/Release/Collada Refinery.app
to your Applications-folder.
+
to your Applications-folder, and  
 
 
and copy
 
 
  <COLLADA_REFINERY-directory>/projects/Xcode/build/Release/ColladaRefineryConditioner.framework
 
  <COLLADA_REFINERY-directory>/projects/Xcode/build/Release/ColladaRefineryConditioner.framework
 
to /Library/Frameworks.
 
to /Library/Frameworks.
 
  
 
== User-Directories ==
 
== User-Directories ==
  
All user-related data resides in  
+
All user-related data reside in  
  
 
  ~/Library/Application Support/Collada Refinery
 
  ~/Library/Application Support/Collada Refinery
Line 51: Line 47:
 
which is created on first launch of the Refinery.
 
which is created on first launch of the Refinery.
  
In this location you will find preferences.xml, the Refinery-configuration file and two subdirs:
+
In this location you will find preferences.xml, the Refinery-configuration file, and two subdirs:
  
 +
directory for additional conditioner-plugins:
 
  ./conditioners
 
  ./conditioners
Place additional conditioner-plugins in here.
 
  
 +
directory for user-created macro files:
 
  ./macros
 
  ./macros
Place user-created macro files in here.
 
  
 
== Debugging ==
 
== Debugging ==
  
You can debug the Refinery out of Xcode, which might be useful for debugging your own conditioners as well. When running the Refinery from Xcode note that the ColladaRefineryConditioner.framework in Xcode's build-directory is used instead of the framework in /Library/Frameworks. The Xcode project is already configured to start the Refinery from Xcode itself.
+
You can debug the Refinery out of Xcode, which might be useful for debugging your own conditioners as well. When running the Refinery from Xcode note that the ColladaRefineryConditioner.framework in Xcode's build-directory is used instead of the framework in /Library/Frameworks.  
 
 
  
 
== Example project ==
 
== Example project ==

Revision as of 10:38, 9 October 2007

For the OS X version of the Refinery you will find a Xcode project file to build an application bundle and an external framework. This allows you to have access to the bundled conditioners and even to easily create your own conditioner-plugins.

Dependencies

  • Get the latest Xcode Tools suite from here.
  • Collada141Dom.framework for Mac OS X
Go here for build-instructions on the OS X ColladaDom-Framework
  • JavaVM.framework
Shipped with OS X Tiger already, no need to install.

Building

Building the default target performs all necessary build-stages to bundle the Refinery-tool.

Those are:

  1. Compiling the Java-sources
  2. Creating the JNI Wrapper for the conditioner C++ interface.
  3. Creating the ColladaRefineryConditioner.framework which can be used for external conditioner-plugins.
  4. Compiling the default conditioners that are bundled with the Refinery
  5. Packaging the Java-Application into an Application bundle convenient for Mac OS X Tiger.

Note that using the Release-configuration all builds are Universal Binary for PPC- and Intel-architecture.

After building the default target, you end up with two important build-products:

  • Refinery Application Bundle
The Java-frame in a Mac-fashioned App-Bundle. Already includes the default conditioners that are shipped with the Refinery.
  • ColladaRefineryConditioner.framework
Interface to import conditioner-plugins that allows users to create their own conditioners. Each conditioner has to link against this library.

Installation

Copy

<COLLADA_REFINERY-directory>/projects/Xcode/build/Release/Collada Refinery.app

to your Applications-folder, and

<COLLADA_REFINERY-directory>/projects/Xcode/build/Release/ColladaRefineryConditioner.framework

to /Library/Frameworks.

User-Directories

All user-related data reside in

~/Library/Application Support/Collada Refinery

which is created on first launch of the Refinery.

In this location you will find preferences.xml, the Refinery-configuration file, and two subdirs:

directory for additional conditioner-plugins:

./conditioners

directory for user-created macro files:

./macros

Debugging

You can debug the Refinery out of Xcode, which might be useful for debugging your own conditioners as well. When running the Refinery from Xcode note that the ColladaRefineryConditioner.framework in Xcode's build-directory is used instead of the framework in /Library/Frameworks.

Example project

As a starting point you can use the following example project. You will find an already set up Xcode project file in

<MyConditioner-directory>/projects/Xcode/MyConditioner.xcodeproj

MyConditionerCore.cpp/.h are the only sourcefiles. The important steps to intialize your conditioners are commented and should give you an easy start for your conditioner.

To test your conditioner with the Refinery, copy

<MyConditioner-directory>/projects/Xcode/build/Release/libMyConditioner.dylib

to

~/Library/Application Support/Collada Refinery/conditioners

Screenshots