Refinery on Mac OS X

From COLLADA Public Wiki
Revision as of 10:28, 9 October 2007 by Hfink (talk | contribs) (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...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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 **Install to /Library/Frameworks.
  • 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 bundlded 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.

The build-process creates two important components:

  • 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 copy

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

to /Library/Frameworks.


User-Directories

All user-related data resides 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:

./conditioners

Place additional conditioner-plugins in here.

./macros

Place user-created macro files in here.

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.


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