You are viewing the documentation for Deformable v0.4.1, an older version. Read the latest, v0.9.0
Maya Plugin
License and preferences
The Deformable Preferences window in Maya, the license status, the Free license and its limit, activating and deactivating a license key, the mesh check and frame cache settings, the help items, and updating the plugin.
On this page
The plugin keeps its settings in the Deformable Preferences window. There you see your license, activate a license key, turn the mesh check on or off, set how much memory the frame cache takes, open this guide, and copy what a support email needs.
To open it, choose Deformable Scene > Preferences… or Deformable Help > License….
License status
The window’s License section starts with the status, beside an icon:
| Status | What it means |
|---|---|
| Free license: up to 2,500 tetrahedrons per scene — Buy license | No license key is active. Every feature works, and a Deformable Scene simulates up to 2,500 tetrahedrons. |
| Standard license | A Standard license key is active on this device. There is no limit. |
| Connect to the internet to renew your Standard license | The license went 7 days without a renewal, or the clock was set back. The next line shows Until then, the Free license: up to 2,500 tetrahedrons per scene. Connect to the internet and click Check Now. |
Below the status, the section shows:
- Contacting the licensing service… while the plugin renews, activates or deactivates. When that fails, the section shows why, such as This license key does not exist. Status messages lists every message and what to do.
- The license key field and Activate when no key is active, or Deactivate when one is.
- Check Now while the status asks you to go online. It contacts our licensing service right away and renews the license.
- Buy License while no key is active. It opens Buy Standard license on the Licenses page.
- Manage Licenses. It opens the Licenses page, where you open a license to copy its key and see the devices that use its seats.
The Maya plugin is always allowed online. Maya has no setting that keeps a plugin offline, so the plugin has none either: with a license key, it contacts our licensing service when it loads in Maya’s window and whenever the license needs it, and only then. Under the Free license it contacts nothing.
The license belongs to the device, not to the plugin: one Standard license covers the Blender plugin and the Maya plugin, and the C, Rust and Python SDKs, on the same device. A license activated in the Blender plugin or from an SDK shows Standard license here too. A Developer license key does not work in the plugin: Activate refuses it with Developer licenses work in the SDKs only: the plugins need a Standard license. The licenses, prices and the buying steps are on Licensing.
The Free license
Without a license key, the plugin runs under the Free license, forever: every feature works, and a Deformable Scene simulates up to 2,500 tetrahedrons. It needs no account and no internet, and the plugin sends nothing.
Every object in the scene counts, floors included, but an object that is disabled: it takes no part in the simulation. Each create action names its object with its count and the scene’s total, disabled objects included, such as Deformable: Created pPlane1: 6 tetrahedrons; scene total 198.
A bigger Deformable Scene says so, as a warning, when a create action makes it too big, at the start frame and when you play, such as Deformable: Created pSphere2: 836 tetrahedrons; scene total 3,120. Free license: the scene would simulate 3,120 tetrahedrons; the limit is 2,500 per scene. When you play it, the plugin stops the playback and shows the limit in a dialog, with Buy License, Preferences and Close. The objects that do not fit stay still, and the rest of the scene runs. To simulate the whole scene, use fewer tetrahedrons, for example with a lower Target Face Count on the object’s Deformable Autocage or a simpler cage, split the objects between two Deformable Scenes, or buy a license. See Use fewer tetrahedrons.
Buy a license
Click Buy License in the Deformable Preferences window. Your browser opens Buy Standard license on the Licenses page: sign in, or create an account first. Choose the number of seats, one per device, and pay. The license page then shows your key: copy it.
The Standard license is $99 per seat, one time, with no subscription. It is perpetual, covers all future versions (every update is included), covers the Blender and Maya plugins and the C, Rust and Python SDKs, and includes email support at support@tangerina.io.
Activate a license
- Choose Deformable Help > License….
- Paste your license key into the key field of the License section.
- Make sure the device is online, and click Activate.
The section shows Contacting the licensing service…, then Standard license, and the tetrahedron limit is gone. The plugin clears the field: the engine keeps the key. Activation needs internet one time. If it fails, the section shows why, such as Every seat of this license is in use: remove a device on the Licenses page, or buy another license. With an empty field, Activate says Paste the license key from the Licenses page first.
The objects that the limit held still simulate again by themselves.
After that, the plugin works offline between renewals. While you use it on a device that is online, it renews the license quietly, a few times a day at most, and checks each time Maya loads it. Each renewal lets it run 7 days offline. After 7 days offline, it shows Connect to the internet to renew your Standard license and the Free license runs, with its limit, until you connect and click Check Now.
Deactivate a license
A Standard license runs on 1 device per seat. To move a seat to another device, deactivate it on this one first:
- Choose Deformable Help > License….
- Click Deactivate.
- On the new device, install the plugin, then activate the same key.
Deactivating here also deactivates the Blender plugin and the SDKs on this device. The plugin forgets the license at once, even offline, and the Free license runs. Offline, the seat stays taken, and the section shows Deactivated on this device, but its seat could not be freed: remove this device on the Licenses page.
If you no longer have the old device, click Manage Licenses, open the license, click Remove beside the old device, then Remove device. Lost keys and refunds are on Licensing.
Preferences
The Settings section of the window holds:
| Preference | Default | What it does |
|---|---|---|
| Verify Meshes Before Creating Objects | On | Refuse a mesh that is not clean and closed when you create a deformable object. |
| Frame Cache Limit | 2 GB per scene | The memory each Deformable Scene keeps its simulated frames in. Past it, new frames are not kept. See Frame Cache Limit. |
Maya keeps them in your preferences, between sessions.
With Verify Meshes Before Creating Objects on, every create action checks each mesh first, and so does Add Surface Mesh to Object with Breakable on. A mesh with problems is refused, and the warning names them, such as Not verified: pSphere1: non closed boundary (84), co located vertices (2), non planar (104).
Turn it off to create objects from meshes with small problems that do not matter for your shot, such as a model with separate eyes. The tools may then still fail on the mesh, and the node shows why. To find and fix the problems instead, see Verify Mesh.
With the preference off, the create actions still refuse an object with a mirrored or flat transform, such as a negative scale. See Mesh checks before creating.
Help
The bottom of the window has two buttons:
- Documentation opens this user guide in your browser.
- Copy Support Info copies the Maya version, the operating system, the plugin and library versions and the license status. Paste it into your email to support@tangerina.io. The plugin then says Copied the support info: paste it into your email.
The Deformable Help menu has the same and more:
| Item | What it does |
|---|---|
| User Guide | Opens this user guide. |
| Scripting Reference | Opens Command line and scripting. |
| Copy Support Info | As the button above. In mayapy, it prints the lines instead. |
| About Deformable | Shows the plugin, library and Maya versions and the system. |
| License… | Opens the Deformable Preferences window. |
The pages of this guide also open from the plugin’s windows: an option window’s Help menu opens the page of its action, and the Attribute Editor’s Help menu, on a Deformable node, opens the page of its node type.
Update the plugin
To install a new version:
- Download the
.zipfile for your system from tangerina.io/deformable. - Quit Maya.
- In your modules folder, delete
deformable.modand thedeformablefolder, and unzip the new version in their place, as in Install the plugin. On a Mac, clear the download’s mark again. - Start Maya. The plugin loads by itself while Auto load is on.
A running Maya keeps the version it loaded, so always quit Maya first. The plugin rebuilds its shelf each time it loads, so the shelf always matches the version.
To remove the plugin, choose File > New Scene, turn off Loaded and Auto load in Windows >
Settings/Preferences > Plug-in Manager, quit Maya, and delete deformable.mod and the deformable folder. Your
license stays on the device.