aboutsummaryrefslogtreecommitdiff
path: root/mayaPlug/README-samples.win
blob: c5478c94a3ba70d0b362884993854d3a4f31d717 (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
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 and its corresponding link
library, both also found in this directory:

	libShaveEngine.dll
	libShaveEngine.lib

To use the DLL library you must either place it in a folder which is in
your PATH, or else add the folder it is currently in to your PATH.


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


Maya Plugin API
---------------
The Maya plugin API consists of the following two header files:

	shaveAPI.h
	shaveItHair.h

as well as the following dynamic library:

	libShaveAPI.dll

and its associated link library:

	libShaveAPI.lib

The header files contain complete documentation on the plugin API.

These files are located in the appropriate sub-directories of the Shave
install directory. E.g:

	c:\Program Files\Epic Games\shaveHaircut\maya2018\include\maya
	c:\Program Files\Epic Games\shaveHaircut\maya2018\bin
	c:\Program Files\Epic Games\shaveHaircut\maya2018\lib


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