uvAutoRatio Pro


Last Updated 10 December 2012

Copyright © 2007-2012 RenderHeads Limited. All rights reserved.

1. Introduction 1.1 What Is This? 1.2 Key Features 2. Getting Started 2.1 Requirements 2.2 Installation 2.2.1 Windows Installation 2.2.2 Windows Uninstalling 2.2.3 Linux Installation 2.2.4 Linux Uninstalling 2.2.5 Mac Installation 2.2.6 Mac Uninstalling 2.2.7 Network Installation 2.3 Launching the Plugin 2.4 Licensing 3. Quickstart 4. The User Interface 4.1 UVAutoRatio Tab 4.1.1 Ratio Tool 4.1.2 Other Tools 4.1.3 UV Shell Finder Tool 4.1.4 UV Tools 4.2 Settings Tab 4.2.1 UV Set Settings 4.2.2 Display Options 4.2.3 Layout Options 4.2.4 Misc Options 4.2.5 Auto-Update Options 4.3 About Tab 5. Other 5.1 Tips 5.2 Known Issues 5.2.1 "Can't perform polyMoveUV on Selection" 5.3 Scripting 5.3.1 GetSurfaceUVArea Command 5.3.2 UVAutoRatioPro Command 6. Usage Examples 6.1 Example 1 6.2 Example 2 7. Release Notes 8. Support

Copyright © 2007-2012 RenderHeads Limited. All rights reserved.

1. Introduction
1.1 What Is This?
UVAutoRatio 2.0 Pro is a tool to help Maya artists get their UVs (texture coordinates) to the right scale. It unifies the '2D texture area' to '3D surface area' ratio across multiple meshes or mesh regions (UV shells). This sounds rather complex, but really it's simple: By scaling an objects UVs, its 2D texture area is scale relative to it's 3D surface area. So objects with large 3D surface area will get a large texture area, and objects with a small 3D surface area will get a smaller texture area. UVAutoRatio does this all automatically for you. It is very fast and can quickly process scenes with a multitude of meshes or very high polygon meshes. It also offers a host of options for customising the way operation are performed.

1.2 Key Features
● ● ● ● ● ● ● ● ● ● ●
Very fast algorithm! Can quickly process thousands of objects/shells and very high polygon meshes. Simple and flexible workflow. Just a few clicks to wield supreme power. Operates on both meshes and UV shells. Automatically fixes overlapping UV shells in a non destructive manner. Maintains usage settings between sessions. Supports all major 32 and 64-bit versions of Maya on Windows, Mac and Linux Windows installer for painless installation. Multi-language support. Automatic version update notification system. Unit-aware. No matter what distance units you're using it will give the correct results. Professional support.

2. Getting Started
2.1 Requirements
The following versions of Maya are supported:

Copyright © 2007-2012 RenderHeads Limited. All rights reserved.

5. 6. 2009.0. 3.0. 2013 and 2013 Apple Mac OS X: ● 32-bit Intel: 8. 2012 and 2013 ● 64-bit: 8. 2010. . 2. double-click the installer to launch it.0 Pro is downloaded as an executable installer file. 8.1 Windows Installation UVAutoRatio 2. 2010. and after a few seconds the plugin will be installed. 8.2. 8. The first screen asks you to select the folder that you would like the plugin to be installed to on your system. 2008. 2. 2009. Once the file has downloaded.5. 2010 and 2011 Please let us know about your platform requirements.0.5. 7.5. Now you can click 'Install'.0. Automatic Licensing during Installation Copyright © 2007-2012 RenderHeads Limited. 2010. 2008 ● 64-bit Intel: 2011 and 2012 Linux: ● 32-bit: 8.5. Launch Maya.2 Installation 2. 2011.Microsoft Windows: ● 32-bit: 6. 8. 2008.0.5. 4. All rights reserved. 2008. 2009. 2009.5. 8.0. 2008. 2011. 2008 ● 64-bit: 8. 2011 and 2012 ● 32-bit PPC: 8. 1.

Decompress the archive to the directory where you want the plugin to live.txt.app/Contents/modules/ Copyright © 2007-2012 RenderHeads Limited.2 Windows Uninstalling Simply run the uninstaller from the Start Menu in "RenderHeads . 3. 2. 2. All rights reserved.You can create a text file "license. 2. Silent Installation You can run the installation silently by specifying the "/S" parameter. Copy UVAutoRatioProModule. This should be somewhere like "~/UVAutoRatio 2. The installation folder can be specified by adding “/D=C:\Program Files\MyFolder”. This should be somewhere like "/Applications/UVAutoRatioPro/".2.txt into the "modules" folder of Maya.0 Pro".5 Mac Installation 1.2. Open the file UVAutoRatioProModule. Copy UVAutoRatioProModule. When the installer runs it will find this file and automatically license the product. UVAutoRatio 2. Decompress the archive to the directory where you want the plugin to live.txt" containing the license key in the same folder as your installer.0 Pro". 2. 2.2. which is usually found in: /Applications/Autodesk/maya2008/maya.txt.2.3 Linux Installation 1.txt from your Maya/modules folder.txt into the "modules" folder of Maya.4 Linux Uninstalling Simply delete the folder containing the plugin. 3. . Launch Maya 2. and edit the path at the bottom to be the folder where you've put this plugin in step 1. Open the file UVAutoRatioProModule. and edit the path at the bottom to be the folder where you've put this plugin in step 1. and remove the UVAutoRatioProModule. which is usually found in: /usr/autodesk/maya2008 (The folder may need to be created if it doesn't already exist) 4.

7 Network Installation UVAutoRatio Pro can also be installed centrally on a server with all the clients just accessing that single instance of the software. Copyright © 2007-2012 RenderHeads Limited. For more information on how to do this please contact RenderHeads. .6 Mac Uninstalling Simply delete the folder containing the plugin. On the server copy over all the UVAutoRatio files and make the folder publically available.2. Launch Maya.2.(The folder may need to be created if it doesn't already exist) (To open maya. This makes maintaining software versions and upgrades much easier in a multi-user environment.txt from your maya.app/Contents/modules folder.app. and remove the UVAutoRatioProModule. 2. For each client you'll need to create an entry for the plugin in their /modules folder pointing to the plugin location on the server. All rights reserved. 2. go the the gear icon in Finder and click "Show Package Contents") 4.

This will display the UVAutoRatio window. All rights reserved. The button icon added to the shelf: Copyright © 2007-2012 RenderHeads Limited.3 Launching the Plugin To launch the plugin type "UVAutoRatioProUI" into the command-line window in Maya. The user interface has a button in the settings tab labelled "Add to Shelf" which will add this command to the current shelf using it's own icon graphic. To save typing you may want to add this command to your shelf.2. .

The license key will something like this: bill@initech. you can either click "Get 15-Day Free Trial Key" which will take you to the website where you can claim your free trial key or "Purchase Key" to launch the license shop website. .com-(1 user license)-Bill Lumbergh-Initech-UVAutoRatio 2. 2.4 Licensing UVAutoRatio Pro won't work until it has been given a valid license key.0 Pro-3ABC-5Q2T-6A0N-2C13-0I0K-5Q2T-6A0N-9Z13-634M-0A4S-5Z1Y-3I3W Copyright © 2007-2012 RenderHeads Limited. this will bring up the licensing window: 1. To obtain and install a license key: Go to the "About" tab and click "Enter New Key".2. All rights reserved. If you don't already have a license key.

com).This whole key must be entered 3. as indicated by this window: If this doesn't appear and you're having problems getting your license to work. . 2. You can use CTRL-V to paste it since right-click doesn't work in this Maya text box. 4. Copyright © 2007-2012 RenderHeads Limited. Click 'OK'. Select the meshes you want to process. Click 'Apply to Objects'. Once you have a key. 3. QuickStart The plugin launches with the most important controls visible: Unifying Texture Ratio Across Multiple Objects 1. please contact RenderHeads Support (support@renderheads. paste it into the box below. All rights reserved. Your copy of UVAutoRatio will then be licensed.

Click 'Apply to Shells'. About . 2. 3. 4. Select the object that has the desired texture ratio. Select the objects (or at least one component in each object) you want to change. 3. 4. All rights reserved. 2.1.Unifying Texture Ratio Across Multiple Shells 1.1 Ratio Tool . Settings . Click 'Apply to Objects'. 4. Select the UV shells (or at least one component in each shell) you want to change. Click 'Set Ratio from Selection'. Matching the Texture Ratio of Multiple UV Shells to the Texture Ratio of a Specific UV Shell 1.Where the action happens Copyright © 2007-2012 RenderHeads Limited. Click 'Apply to Shells'.displays information about the plugin.where the plugin is actually operated from. Select the shells you want to process so they have the same ratio. 2. Select the UV shell that has the desired texture ratio. Click 'Set Ratio from Selection'. The User Interface The user interface is divided into 3 tabbed sections: ● ● ● UVAutoRatio .1 UVAutoRatio Tab 4. . Matching the Texture Ratio of Multiple Objects to the Texture Ratio of a Specific Object 1. license and developers. 4.holds all the options for the main operations.

This will work with any selection. edges.if the selection is made up of components of an object (vertices.This is the most important panel in the whole interface as it contains the buttons: 'Apply to Objects' and 'Apply to Shells'. edges. UVs. UVs. These are the two main operations that the plugin performs. 'Apply to Shells' will scale the UVs of the selected UV shells so they have the desired ratio. or it can be set to the ratio of the current selection by clicking 'Set Ratio from Selection'. . Applying the Ratio 'Apply to Objects' will scale the UVs of each selected object (polygon mesh). Setting the Ratio The value in 'Current Ratio' can be manually edited. This can be very useful in making other objects/shells match the ratio of another object/shell/selection. The UVs are scaled so the ratio between the selected 3D area and it's 2D texture area matches (or at least comes extremely close to) the ratio specified in the box 'Current Ratio'. from a bunch of polygon meshes to a single face. Ratio Presets Copyright © 2007-2012 RenderHeads Limited. All rights reserved. If an object is selected then all of it's UV shells will be processed. faces. If the selection just contains components (vertices. etc) it will still operate on the entire object. etc) the UV shell that contains them will be processed. Running either of these operations will result in the UVs of the selection being scaled (and perhaps translated to fix overlapping UV shells if that option is selected). Whole objects don't have to be selected for this to work . faces.

2 Other Tools Fix Shell Overlaps This button will try to move overlapping UV shells apart so they are no longer overlapping.By clicking on the preset button presets can be saved and managed. This allows you to noramlise the UV's of mutliple objects without having to combine them. 4. There is an option whether to maintain the aspect ratio of the UV's UV Shell Auto-Selection Tool Copyright © 2007-2012 RenderHeads Limited.1. Normalise This is similar to Maya's own UV Normalise command except it also works with multiple objects selected. It can be pressed repeatedly to move the shells apart. but it is available as a button here for easier workflow. . There are further options for the settings in the Settings tab. All rights reserved. This option can be set to automatically happen after the Apply to Objects or Apply to Shells from the Settings tab.

Right-clicking on these tool buttons will open up their options window .Ticking this checkbox will make any component selection automatically propagate the selection to that entire UV shell. Double clicking on an item in the list will zoom the camera to that UV shell (just like the hotkey 'F' in Maya).1.3 UV Shell Finder Tool . Tools with options will display a small icon next to the cursor when hovered over.4 UV Tools .Lists UV shells in the selection This is a handy tool that displays each UV shell in the selection and then allows you to select the shells simply by selecting items in the list. . indicating that it can be right-clicked to bring up the tool options. All rights reserved. or it can be used as an easy way to build up a selection of shells to be processed. Ratio Inspector Copyright © 2007-2012 RenderHeads Limited.Handy shortcuts This panel is a collection of shortcuts to tools (most of them internal Maya ones) commonly used in conjunction with UVAutoRatio. placed here for quick and easy access. 4. This tool can be used to easily select UV shells for capturing the ratio of that shell using 'Set Ratio from Selection'. Multiple selection is supported. Left clicking will apply the tool.1. and each UV shell you select in the list will be added to the current selection. 4.

.2 Settings Tab 4.Ratio Inspector is the only non-Maya tool.1 UV Set Settings . 3. Copyright © 2007-2012 RenderHeads Limited. Since the current UV Set can vary between meshes it can be useful to force the plugin to a UV Set of a specific name.Specifying which UV set to operate on By default the UVAutoRatio Pro will operate on the 'current' UV Set of a mesh. The current UV Set in Maya is a per-mesh property and can be set in the texture editor. These settings allow you to specify alternative UV Sets to operate on. This handy tool opens up in a new window and will show you the surface and texture area of anything as you select it. 2. Select the mesh that has the desired UV Set. It also shows you the ratio between the two areas. 4.2. Click 'Update UV Set List from Selection' to fill the box with the list of UV Sets the mesh contains. To manually specify the UV set to use: 1. Select the 'Manually select UV Set' radio button. All rights reserved.

2 Display Options These display options apply to the UV Shell Finder Tool.3 Layout Options . however the results will be less accurate. This is similar to the option in Maya's 'UV Layout' command. Padding is the desired minimum distance between shells. having this option on will fix overlapping shells. Now select the desired UV Set from the list. The 'Move shells to fix overlaps' option does what it says. The mesh can either be skipped or processed using it's current UV Set.2. Even if the shells already have the desired ratio. This option decides what the plugin does about this.Automatically fixes overlapping UV shells When UV shells are scaled up they can sometimes overlap each other. 4. If any meshes are skipped. Copyright © 2007-2012 RenderHeads Limited. When selecting UV shells from the list they can either be displayed as UVs or faces. All rights reserved. 4. Iterations is how many times layout options runs internally. a warning will be logged to the script editor window showing which meshes were not processed. If you do manually specify the UV Set.2. . you can also define what happens when the plugin encounters a mesh without the named UV Set. Increasing this number will decrease the time it takes to solve the layout.4. however instead of completely rearranging the UV shells it will preserve the original layout of the shells relative to each other. Step Size is the distance it tries to move the shells each time it runs an iteration.

and the automatically fixed result: Before .shells are overlapping Copyright © 2007-2012 RenderHeads Limited. .The images below shows UV shells that are overlapping. All rights reserved.

Overlapping fixed while maintaining the original layout 4.2.4 Misc Options Scaling Axis: Copyright © 2007-2012 RenderHeads Limited. .After . All rights reserved.

These options allow you to limit the scaling to either the horizontal or vertical axis. This can be disabled by checking this "Reset Settings on Startup" option. 4. Logging Verbosity: If "Verbose Output" is enabled the plugin will write detailed information into the script editor output window about it's internal operations.3. .3 About Tab The About tab is pretty straightforward: Copyright © 2007-2012 RenderHeads Limited. Here is an example of the data it displays: Save Settings: By default the plugin will remember the last used settings and will restore them when you use the plugin in future. All rights reserved." to the current shelf.Usually the UVAutoRatio 2. Shelf: The "Add To Shelf" button will add a shortcut to the MEL command "UVAutoRatioProUI. This might be interesting/useful to advanced users. Reset Settings: Finally the settings can all be returned this their default state by pressing this button.5 Auto-Update Options 4.0 Pro will scale the object/shell equally in both horizontal and vertical directions to find the scale which gives the desired ratio.

. The plugin panel displays information about the plugin. Finally there are some links to web pages related to this plugin. This is useful for checking for updates and bugfixes. please include this data in your query.The license panel displays the details of the currently installed license. Copyright © 2007-2012 RenderHeads Limited. All rights reserved. It also allows new keys to be entered and the 'Purchase Key' button will launch the RenderHeads Store in the default web browser. show off what they've used the plugin for. This is very useful for troubleshooting. make feature requests. The User Group is an online community where users can post their opinions and queries. get access to upcoming beta versions and interact with the developers directly. When reporting a problem.

1 Tips 5. 2. open the Texture Editor window.mel resource files which contains all the text strings used by the plugin.mel" to this location. 5.2. (/resources/ja_JP for example) 3. If you do translate the plugin into your language please let us know so we can share it with the rest of the community. 4. simply select the mesh. 5. Create a folder of this name in the /resources/ folder of UVAutoRatio installation folder. run the MEL command "about -uiLanguage. You simply need to copy this resource file and modify the text strings. To fix it.res. Maya will then run the plugin in your language.res. . Copy "/scripts/UVAutoRatioPro. Translate the text into your own language.1. For Japanese it would be "ja_JP". and output: // Warning: line 1: Can't perform polyMoveUV1 on selection // We have tracked this down to a bug in Maya where it has an invalid current uvset assigned to the mesh.1.2 Known Issues 5. All rights reserved.2 How do I add support for my language to UVAutoRatio? UVAutoRatio supports multiple langauges through a . 1." to discover the language name that Maya is using. go to the UVSet menu and select the UV set (even if it's already selected).1 "Can't perform polyMoveUV on Selection" There have been reports of some models that don't work with the plugin.3 Scripting Copyright © 2007-2012 RenderHeads Limited. Other 5.1 Performance Clearing history will improve the performance of the plugin 5.5.

. the 2d texture area. use the default UV set instead of skipping it (optional Displays this parameter list -hlp -help 5. 5. default false Layout UV shells to prevent overlapping (optional).It is also possible script UVAutoRatio Pro to include it into a workflow or custom pipeline. All rights reserved. default true -op -vb -operation -verbose -lay -layout Copyright © 2007-2012 RenderHeads Limited.2 UVAutoRatioPro Command This is the main command which does the UV scaling and UV shell manipulation. Its parameters are: Short name -hlp -r -us -fb Long name -help -ratio -uvSetName -fallback float string Value type Description Displays this parameter list Desired 3D : 2D ratio The name of the UV set to use (optional) If the named UV set is not found in a mesh. Its parameters are: Short name -us -fb Long name -uvSetName -fallback Value type string Description The name of the UV set to use (optional) If the named UV set is not found in a mesh. Below is a list of the commands that come with UVAutoRatio Pro and descriptions of their parameters. 1 = uv shell Display output (optional).1 GetSurfaceUVArea Command This command uses the current selection and returns 3 floats: the 3d surface area. the ratio of surface area / texture area.3.3. use the default UV set instead of skipping it (optional) integer 0 = whole mesh.

-ss -skipscale Skip the scaling operation (useful if you only want to fix layout) (optional) Restrict scaling of UVs to horizontal axis (optional). looking something like this: Copyright © 2007-2012 RenderHeads Limited. Usage Examples 6.1 Example 1 Lets say we have 4 'rocks' all different scales and using the same texture. default false -osh -onlyScaleH -osv -onlyScaleV 6. . All rights reserved. default false Restrict scaling of UVs to vertical axis (optional).

Here are some reasons why: 1.We can see that the large 'rock' is using the same amount of texture area as all the other smaller 'rocks'. producing this result: Copyright © 2007-2012 RenderHeads Limited. 2. We want the features in the texture to be the same size across the rocks. A crack or a grain shouldn't really scale if they're made of the same material. . It is a waste of processing power to have small objects using disproportionately large regions of the texture when they don't need to. So we'll run UVAutoRatio to unify the UV ratio across multiple objects. All rights reserved. But we'd really like the texture usage to be proportional to the area of the mesh.

2 Example 2 You've finally finished unwrapping/pelting your UV shells and you have something like this: Copyright © 2007-2012 RenderHeads Limited. All rights reserved. .6.

. the more pixels you can dedicate to the details. 2. Instead let UVAutoRatio do it for you: Copyright © 2007-2012 RenderHeads Limited. If it's a character you might want to give the head/face double the resolution compared to the other parts. All rights reserved.Now you have to manually inspect each shell and try to guess what size to scale it so they're all proportional. You want to divide up your texture in proportion to how much of it will be seen in the 3D world. The less texture waste there is. This is a serious drag! You want to do this for a few reasons though: 1. otherwise it's a waste.

Copyright © 2007-2012 RenderHeads Limited. . All rights reserved.

13 October 2009 ● ● Added support for Maya 2010 Fixed crash bug when using the plugin in batch mode Version 2.0 Version 2.2 .5 .4 ● Added support for Maya 2013 to Mac May 2012 Version 2.0 ● ● ● Added support for Maya 2011 Installer can install silently and automatically license keys Added to documentation about how to translate UVAutoRatio into your own language by using the localisation system Version 2.5.7. December 2012 Version 2.6.4. All rights reserved.0 .5.4 ● ● Added support for Maya 2013 to Windows Added support for Maya 2012 to Windows and Mac .x ● -? Send us your suggestions.5. .25 March 2009 ● ● Added ability to save and load ratio presets to file Fixed compatability issues with Maya versions prior to 8.4. Release Notes Version 2.August 2010 Version 2.4.03 March 2009 ● Features: ○ Added ratio preset system: Copyright © 2007-2012 RenderHeads Limited.

.○ Exposed more Layout options for fixing overlapping UVs: ○ ○ ○ ○ The tool for fixing UV Shell overlaps now works with multiple objects too Added a Normalise UV tool that works across multiple objects Multi-language support Better UI options for faster workflow: Copyright © 2007-2012 RenderHeads Limited. All rights reserved.

.3.11 September 2008 Copyright © 2007-2012 RenderHeads Limited.● ● Improvements: ○ Progress bar updates better and gives better indication of progress ○ When cancelling the operation the logging of skipped shells now only happens when Verbose Output is enabled. ○ Cancelling during overlap fixing is much more responsive ○ Added option for showing internal timings (for profiling) ○ Better Maya version detection ○ Installer now installs for all versions of Maya automatically Bugs: ○ Fixed bug where UV Editor didn't hide when fixing overlapping shells ○ Fixing overlapping UVs now also obeys Verbose Output setting Version 2.22 October 2008 ● ● Maya 2009 support Mac OS X PPC support fixed Version 2. All rights reserved.3 .1 .

exe is running Added scripting info to documentation .2 .1 ● ● ● ● UV Shell Finder displays the shells with much more useful and friendly information Frames Remember their Collapsed State License Type Displayed Improved Documentation Version 2. .2. All rights reserved.15 August 2008 Version 2.● Added Mac OS-X support: ● Added automatic version update notification system: ● Improved license ● ● entry mechanism Windows installer now warns if maya.24 June 2008 Copyright © 2007-2012 RenderHeads Limited.

gives reassurance that the Maya hasn't frozen.0. Copyright © 2007-2012 RenderHeads Limited.1 ● .24 April 2008 Auto-Hide Texture Editor Option There is now a new option to automatically hide and then reshow the texture editor window while the plugin is doing it's work.5 and 2008 on 32-bit and 64-bit machines. 8. This makes the plugin work a lot faster for high polygon meshes.0. ● Fixed Zero Area Bug Fixed a bug with handling objects containging faces with zero area. . This now takes half the time. ● Progress Bar Added a progress window. ● Speed Increase We've increased the speed of the case where your meshes has overlapping UV shells. ● ● ● Fixed a Minor Memory Leak Bug Minor Improvements to UI Improved Documentation Version 2. ● Windows 64-bit support for Maya 8.0 Previously we didn't support 64-bit for Maya 8. and you use the option to automatically fix overlapping shells. This is useful for high polygons meshes that may take some time.● Linux Support added We add support for Maya 8. All rights reserved.

Version 2. . So if you made a mistake and told it to do some horrendous amount of work you can just hit the escape key and it'll stop.0 ● .2 April 2008 Initial Release Copyright © 2007-2012 RenderHeads Limited. so you may need to re-enter your key again. The same goes for the Ratio Inspector. ● Everything Else A new button to just run "fix overlapping UV shells". Pressing the UV Texture button when the window is open will now hide the window. The licensing changed slightly.● Interruptable The plugin can now be interrupted. All rights reserved.

com/forum/viewforum.uvAutoRatio.8. . report bugs and show off ways you've used the plugin: http://www.RenderHeads. All rights reserved. submit feature requests.com UVAutoRatio Discussion Forum Use the discussion forum to post your questions.renderheads.php?f=4 RenderHeads Details For further support please contact the developers directly: Web: www.com Phone: +447970692070 Copyright © 2007-2012 RenderHeads Limited. Support Website UVAutoRatio has it's own website where updates and news can be found: http://www. opinions.com Email: contact@renderheads.

Sign up to vote on this title
UsefulNot useful