aboutsummaryrefslogtreecommitdiff
path: root/mayaPlug/README-samples.osx
blob: 678e60e8346e6b8d18e615aee5690610db5250cf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
Shave And A Haircut APIs
------------------------
There are two APIs for use with Shave: a standalone API for building
applications which process Shave archive files (such as those produced by
the 'shaveRender -createDRAFile' command in Maya), and a plugin API for
building Maya plugins which can access Shave's data from within Maya.


Standalone API
--------------
The standalone API consists of the following two header files, found in this
directory:

  shaveEngine.h
  shaveSDKTYPES.h

as well as the following dynamic library, also found in this directory:

  libShaveEngine.dylib


Maya Plugin API
---------------
The Maya plugin API consists of the following two header files, found in the
same directory as Maya's own API header files
(e.g.  /Applications/Alias/maya7.0/devkit/include/maya):

  shaveAPI.h
  shaveItHair.h

as well as the following dynamic libraries, found in Maya's shared 'plug-ins'
directory (e.g. /Users/Shared/Alias/maya/7.0/plug-ins):

  libShave.dylib
  libShaveAPI.dylib

The header files contain complete documentation on the plugin API.


Sample Code
-----------
'shaveAPITestCmd.cpp' is a sample Maya plugin using Shave's plugin API.

'shaveAPITestApp.cpp' is a sample application using Shave's standalone API.

To build them, set your MAYA_LOCATION environment variable to point to the
Maya.app/Contents directory for the version of Maya you plan on using the
plugin with.  E.g:

  setenv MAYA_LOCATION /Applications/Alias/maya7.0/Maya.app/Contents

Then execute the following command:

  make

To execute a standalone application, either run the application from the
same directory which contains the libShaveEngine.dylib file, or else
set the DYLD_LIBRARY_PATH environment variable to point to that directory.
E.g:

  setenv DYLD_LIBRARY_PATH /Users/Shared/Epic Games/shaveHaircut/maya2017/samples