README
1LICENSE
2--------
3
4This software is copyright 2001 E-Publishing Group Inc. Permission is granted
5to use the code and/or make changes to the code provided that the original
6copyright and author attribution is included in each file.
7
8The license does not make any warranty of liability, merchantability, or
9fitness for any specific purpose.
10
11Please contact the author <jshore@e-shuppan.com> if you have any questions
12about the license or the software.
13
14
15BUILDING
16--------
17
18Build the java library and the native library, running make in the java
19directory (the current directory) and "native" directory respectively.
20
21The java build will produce a jswf.jar file which can be included in your
22classpath. The native directory creates a libjswf.so file. This can be
23placed anywhere (I typically put it in the same installation directory as
24my jar files).
25
26
27USING IT
28--------
29
30To compile or run against this library should do the following (csh):
31
32 setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:<directory-with-.so-files>
33
34 java or javac -classpath <old-path>:<jar dir>/jswf.jar
35
36
37Make sure you also include libming.so in the directory with your libjswf.so.
38Alternatively, add the ming library to your LD_LIBRARY_PATH.
39
40
41NOTES
42-----
43
44The Java class heirarchy and methods closely mirror the PHP and python
45interfaces. I've added some additional convenience functions and new
46functionality.
47
48Also, have separated the implementation from the interface definition. This
49makes browsing the API easier and also allows for other implementations.
50Methods that result SWF objects will return SWF interfaces rather than the
51explicit objects. For example:
52
53 SWFMovie movie = new SWFMovie();
54 ...
55 SWFDisplayItemI item = movie.add (shape);
56 item.moveTo (23,30);
57
58The add method returns SWFDisplayItemI rather than SWFDisplayItem. No big
59deal. Just be aware that interfaces (identified with an "I" suffix) are
60used most of the time.
61
62
63EXTENDED API
64------------
65
66If you are interested in more advanced functionality, we have a not-yet
67publicly available high-level API built on top of this. Currently includes
68the following:
69
70 - supports wide variety of image formats (ming only supports jpeg and dbl)
71 - timeline & animation classes
72 - text and object align to arbitrary paths (and path animation)
73 - movie (mpeg, qt, avi, etc) to flash (in progress)
74 - others
75
76Please contact me if you would like more information about this.
77
78
79CONTACT
80-------
81
82Jonathan Shore <jshore@e-shuppan.com>
83