Maya API Node for interactive instancing of shapes along curves.
Switch branches/tags
Nothing to show
Clone or download
mmerchante Merge pull request #7 from dukecyto/fix/check_kLibraryApp_for_mayapy
(fix) Make plug-in loadable in mayapy by checking kLibraryApp mode
Latest commit 965243e Jan 31, 2017

README.md

Instance Along Curve

Maya API plugin developed in Python that tries to simplify the process of instancing various objects along a curve. The plugin essentially creates a new dependency graph node which handles all the necessary logic. It also includes a node creation command and an Attribute Editor template for a very familiar and user friendly interface.

Patch 1.1.0 demo video: Youtube Patch Video

1.0 demo video: Youtube

Current Version: 1.1.0

(v1.1.0) NEW features

  • Added rotation manipulators, with options to reset both positions and angles
  • Added translate, rotate and scale offsets, both local and global
  • Instantiates objects based on their pivots
  • Added curve start and end values
  • Added a ramp repeat value
  • Added UI annotations

(v1.1.0) Changes

  • Reworked core logic, orientation axis easier to handle/understand
  • Objects now preserve their initial rotation

(v1.1.0) Fixes

  • Copy input transform now updating correctly
  • Distance mode now respects distance

Difference with other approaches

Because it is a DG node that is recomputed each time Maya considers necessary, there is no need to execute manual scripts or hacks or custom windows to update the instances. Also, it is very efficient in updating each instance, because every relevant instance attribute is connected to the locator, and only recomputes what is needed.

However, Maya makes instancing objects from a plugin node very difficult, so there are some known limitations.

Features

  • It's a dependency graph node, so it works gracefully with the Maya environment.
  • Instance an object by count or by distance between instances.
  • Various rotation modes, including chain mode.
  • Curve distance offset, useful for tank treads.
  • Customize the instances transformation by ramps evaluated in curve parameter space.
  • Customize the ramps' offset with keys or expressions for animations.
  • Customize how instances look in viewport.
  • Randomize instances transformations.
  • Portable.
  • User friendly, highly flexible.
  • Manually manipulate rotations, to fix complicated situations
  • Set global&local offsets for translation, rotation and scale
  • Customize which part of the curve is going to be instantiated
  • Customize how many times ramps are going to be repeated over the curve

Installation

Save instanceAlongCurve.py under MAYA_PLUG_IN_PATH (create the folder if it doesn't exist)

  • (Linux) $HOME/maya/plug-ins
  • (Mac OS X) $HOME/Library/Preferences/Autodesk/maya/plug-ins
  • (Windows) \Users\<username>\Documents\maya\plug-ins

Instructions

To use the plugin, select a curve first and the shape you want to instance and go to Edit->Instance Along Curve. You can save it as a Shelf Button if you want.

Known issues

  • When batch rendering, if the node has complex logic depending on time, it may be necessary to bake the node and its children. In some renderers, the node is not being evaluated each frame.
  • When the instancing mode is by distance, any change on the curve length is not immediatly reflected until a change on the instancing attributes is made.

License

MIT