------------------------------------------------------------------ UVRip 1.05 by Brendan Hack Copyright © 1999 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. Explicit permission is given to link these file with the tsxapi.lib library supplied with the trueSpace API Software Developers Kit The complete GNU public license is at the end of this file. ------------------------------------------------------------------ For more information on this program, or to find a more recent version, look at http://www.bendys.com ------------------------------------------------------------------ UVRip 1.05 23 April 1999 ================================================================== UVRip is a Truespace 3.x extension which rips the UV map of a polyhedra and saves if to a TGA file. The file can then be used as a template to paint a texture or applied directly to the object as a mesh texture. UVRip contains controls for image size, foreground and background colour, antialiased lines and remapping of invalid UV map entries. REQUIREMENTS trueSpace v3.0 or above and API Software Developers Kit. INSTALLATION Unzip all files with directory names into your Projects directory. Open the UVrip.dsw workspace in Microsoft Visual C++ 5.0 and set the library and include file directories (menu Tools/Options/Directories) so they point to the location of your trueSpace 3.0 (or above) API include and library files. That's all there should be to it, hit F7 and the TSX will build. Once you have compiled the TSX simply fire up Truespace 3.0 or later, open the 3D Plugins window and load 'UVRip.tsx' into the plugin panel. If trueSpace reports "Library not found" or the TSX Extender refuses to load the plugin please download the file mfc42u.dll from my webpage and install it. This should fix the problem. However you shouldn't have this problem cause you just compile the program so you ought to have that dll. NOTES This code was developed under Microsoft Visual C++ 5.0. It shouldn't be too hard to port it to MSVC 4 (Caligaris supported platform). I don't recommend trying to build TSXs under Borland C++ Builder at this time as Borland does not support the library format that tsxapi.lib is in. The 'support' files for controlling TGA files, edgelists and line drawing are not fully commented as they don't relate directly to TSX coding. The methodology I have used to create this TSX is not the only way to construct TSXs and is almost certainly not the best. TO BUILD YOUR OWN TSX This is not a detailed description of how to write Windows MFC dlls. It simply outlines what is necessary to setup a TSX so it can interface with trueSpace. I am assuming you already know how to create and use MFC dialogs. A trueSpace TSX is simply a Windows dll which contains four exported functions called tsxGetData, tsxOnLeftClick, tsxOnRightClick and tsxDeactivate. These interface functions are what trueSpace calls to load and execute the TSX. tsxGetData: Called when the TSX is loaded. Used to pass information about the plugin to trueSpace and check the version #. tsxDeactivate: Called when the TSX is unloaded. Used to close down the dialog box and perform housekeeping. tsxOnLeftClick: Called when the user left clicks on the TSX icon. Usually displays a dialog box for the user to work with. tsxOnRightClick: Called when the user right clicks on the TSX icon. Used to display an About box or parameters. trueSpace provides an API (Application Programmer Interface) containing library functions which are used to control and manipulate trueSpace. These are the heart of plugin programming and allow you to create objects, animate attributes, modify polyhedra and many many other functions. The API consists of a library and a set of header files. It is necessary to include the header file in all files using the API and the library must be linked to the DLL. There are currently five versions of the API one for each version of trueSpace that adds TSX functionality (3.0,3.1,3.2,4.1,42). As a programmer you should have all five versions and you should use the oldest version of the API that you can. This ensures that the largest group of users will be able to use your plugin. So, if you're not using any of the new features in version 3.2, don't use it, just use 3.1. 1. Creating the TSX. Make a new 'MFC AppWizard' (dll) project (menu file/new) (either shared or static) in MSVC. A static dll links the standard MFC library at compile time and should be fully selfcontained. A shared dll won't link the standard MFC library with the TSX. It will be dynamically loaded when the TSX is run. This reduces the size of the TSX however users will need to have the file 'mfc42u.dll' installed under Windows. This is a standard file and most people will have it, if they don't it is distributable and I have a copy at my TSX web site (http://www.bendys.com). Your new project will have a number of items already created. Firstly a class 'CNameApp' and implementation files will exist which can be used to store and control the TSX dialog. An instance of this class will also be defined as 'theApp'. Other files include a '.def' file, standard system includes file and resource files. 2. Specify API. MSVC needs to know where to find the TSX API files. Goto Options under the Tools menu and add your TSX API include and library directories to their respective search paths. Finally you need to specify link options under the Project/Settings menu. Under the link tab enter the output file name ('name.tsx') and add 'tsxapi.lib' to Object/Library modules. 3. Export functions. Now we need to export the interface functions. Open the '.def' file and add the four interface function names (tsxGetData, tsxOnLeftClick, tsxOnRightClick and tsxDeactivate) to the EXPORTS section of the file. The '.def' file is used to define the dll and is read and link time to find out if we're compiling an exe or dll and what functions to export. 4. Resources. TSXs require 2 resources to be defined, a bitmap to use as the icon and a string to display in the trueSpace status bar. To create these click on the ResourceView tab in the InfoView window. Right click on the resources tree and select insert. Select Bitmap and hit insert. Repeat this to add a string table. Open the resource tree and double click on the new bitmap resource to open it. Hit Alt-Enter to display the properties and set the size to 32x32. Now you can make your icon. Alternativly you can import a bitmap you made elsewhere and use it as the icon. Open the string table and add a new string to use as the message trueSpace displays. Note the IDs that these resources are given as you'll need to use them in the tsxGetData function. In addition to these you will of course need to make at least one dialog box as the user interface to the TSX. This dialog will control the TSX and its code will call the trueSpace API to do the actual work. You may also want to create a help dialog. Everything is now setup and you can begin coding. 5. Starting coding, TSX setup. Now we can begin to write the actual code. To control the dialog box and active state of the TSX I use the CNameApp class which MSVC created when we started. First, create a simple dialog box which just has a Close button. Add a BN_CLICKED event handler to the object which calls DestroyWindow() to close the window. Don't worry about functionality until you get the TSX coming up in trueSpace. Once you have made the dialog box and added a class for it (select the dialog box and open the Class Wizard (ctrl-w)) you need to define a pointer to store the dialog in the CNameApp class and a BOOL to indicate if the TSX is active or not. Also include the file 'resource.h' in the header file. You will also need code to show and hide the dialog box, set and check the active state and to create and destroy the class. Check out 'UVRip.h' and 'UVRip.cpp' for details. 6. Starting coding, interface functions. The four interface functions is the last step in preparing the TSX. These functions are implemented in the class implementation file 'Name.cpp'. These functions can be found in the file 'UVRip.cpp'. int tsxGetData(tsxData* tsx_data, int tsxid) tsxGetData is used to initialise the plugin on loading. It returns a code indicating if the initialisation was successful or not (tsxPLUG_tsxDONE or tsxPLUG_FAILED). This function should fill the tsx_data structure with information about the TSX. struct tsxData { char m_Title[32]; //Brief name of this eXtension. char m_Author[64]; //Name of author|company. short m_ResidBtnBmp; //Resource id used for Button Bitmap short m_ResidBtnHelp; //Resource id used for Button Help Message }; The tsxid variable is a unique ID for this TSX. It is used with callback functions to identify the TSX. This value should be stored for later use. You should also call tsxGetTsVersionNbrs to check which version of trueSpace is running and that it supports your TSX. int tsxOnLeftClick(void) tsxOnLeftClick is called when the user runs the plugin by clicking on its icon. Here we activate the TSX and display the dialog box so the user can use it. This function returns a value indicating if the plugin is finished or not (tsxPLUG_DONE or tsxPLUG_STAYON). If tsxPLUG_STAYON is returned then the plugin will be unloaded when the user selects a standard trueSpace function. Because of this UVRip returns a tsxPLUG_DONE so that trueSpace believes the plugin is finished. However, the dialog remains active and the TSX can still be used. void tsxOnRightClick(void) tsxOnRightClick is called when the TSXs icon is right clicked. It usually displays an about dialog. Simply create a dialog box and display it. void tsxDeactivate(void) tsxDeactivate is called when the plugin is deactivated. It simply makes the plugin inactive and hides the dialog box. For more information on when a plugin becomes deactivated read the readme.txt file that comes with the API. 7. All the rest Add a line in 'Name.cpp' to set the plugin to start as inactive 'BOOL CnameApp::sm_bIsActive = FALSE;'. You should now be able to build your tsx and load it up into trueSpace. If you click on the icon the dialog should appear with it's close buttons. You can now start adding functionality. You may use my UVRip code as a base but note that any TSX you release which is derivative of this one (IE: contains code directly from it) it will have to be released in accordance with the GNU public license. The main implication of this is that the source code must be distributed with your software and others who use the code must be able to distribute their versions as well. Basically, it must remain "Open Source" in the truest sense of the term. Read license.txt for more information. In addition you will need to add the disclamer giving explicit permission to link with tsxapi.lib. This is due to some issues involving the GPL and plugins to non-GPL products. Important factors to remember when building TSXs: You _must_ export the 4 trueSpace interface functions tsxGetData, tsxOnLeftClick, tsxOnRightClick and tsxDeactivate. Remember to make sure your dialog boxes are marked visible. MSVC5 makes dialogs invisible by default. If you don't the nothing will happen when you click on the TSX icon. You may get a compiler error of the form 'fatal error C1010: unexpected end of file while looking for precompiled header directive'. This occurs when you write your own cpp files rather than creating classes using MSVCs add class function. If your code isn't using MFC code you can simply turn off precompiled headers for that file (right click on the filename, select settings, C++ tab, Precompiled Headers category. Now select the 'Not using precompiled headers' radio button). Alternativly, if you are using MFC or you still wish to use precompiled headers add the line #include "stdafx.h" as the first include in the source file. For more information on coding TSXs and details on the functions provided see the documentation that comes with the SDK. Version 3.1 contains the best docs. FILES AALines.cpp - Antialiased lines implementation AALines.h - Antialiased lines definition AATables.cpp - Antialiased lines lookup tables ColorButton.cpp - Coloured button control implementation ColorButton.h - Coloured button control definition CompDlg.cpp - Compression dialog implementation CompDlg.h - Compression dialog definition EdgeList.cpp - Edgelist implementation EdgeList.h - Edgelist definition icon.BMP - Icon image previewbg.bmp - Preview window backgroun image Resource.h - Resource header rgba.cpp - RGBA manipulation implementation rgba.h - RGBA definition ripwnd.cpp - Preview window implementation ripwnd.h - Preview window implementation StdAfx.cpp - Standard system source StdAfx.h - Standard system includes Tga.cpp - TGA file implementaion Tga.h - TGA file definition TSXAbout.cpp - About box implementation TSXAbout.h - About box definition TSXDIALOG.cpp - Dialog box control and UV map code TSXDIALOG.h - Dialog box definition UVRip.cpp - Main UVRip code to talk to trueSpace UVRip.def - Exported function list UVRip.dsp - MSVC5 project UVRip.dsw - MSVC5 workspace UVRip.h - Main UVRip definition UVRip.rc - UVRip resources uvripsrc.txt - this document res\UVRip.rc2 - Manually created resources VERSION HISTORY 1.05 23 April 1999. Added preview window, alpha channel and compression. 1.02 30 March 1999. Added trueSpace 3.0 support (internal version) 1.01 13 June 1998. Source code released. Minor internal code changes. Added check to ensure that the correct object is selected when saving. 1.0 10 May 1998. First release KNOWN BUGS Not a bug but some objects cannot have their UV maps properly ripped. If you get strange output then please compare it to the output from other UV unwrappers before submitting a bug report. Also, the anti-alias engine is a bit buggy, if you get bizarre UV maps you may want to try turning anti-aliasing off. There seems to be a bug in the anti-aliasing code. HOW TO GET IN TOUCH Please send any comments, suggestions, and bug reports to bendy@bendys.com. If submitting a bug report please put the word 'bug' in the subject of the message. Point your web browser to http://www.bendys.com for updates to UVRip and other plugins. TrueSpace is a product of Caligari, Inc. Their web site is at http://www.caligari.com. LICENCE INFORMATION GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it!