trigger.library.tools
=====================

.. py:module:: trigger.library.tools


Functions
---------

.. autoapisummary::

   trigger.library.tools.copy_controller
   trigger.library.tools.make_stretchy_ik
   trigger.library.tools.mirror_controller
   trigger.library.tools.motion_path_spline
   trigger.library.tools.replace_controller
   trigger.library.tools.replace_curve
   trigger.library.tools.whip
   trigger.library.tools.whip_refresh


Module Contents
---------------

.. py:function:: copy_controller(a, b=None, axis=None, side_flags=('L_', 'R_'), side_bias='start')

.. py:function:: make_stretchy_ik(joint_chain, ik_handle, root_controller, end_controller, side='L', source_parent_cutoff=None, name=None, distance_start=None, distance_end=None, is_local=False)

.. py:function:: mirror_controller(axis='x', node_list=None, side_flags=('L_', 'R_'), side_bias='start', continue_on_fail=True)

.. py:function:: motion_path_spline(curve_obj, num_of_objects, object_type='joint', aim=False)

.. py:function:: replace_controller(old_controller, new_controller, mirror=True, mirror_axis='X', keep_old_shape=False, keep_copy=False, align_to_center=False)

   Replace old_controller with new_controller.

   Args:
       old_controller (str): The controller with the old shape
       new_controller (str): The new shape for the old controller
       mirror (bool): If True mirrors the controller shape
       mirror_axis (str): Mirror axis direction. Only valid if mirror set to True.
                           Defaults to "X"
       keep_old_shape (bool): If True does not delete the old controller shape
       keep_copy (bool): If True, duplicates the new controller, keeping a copy of it intact
       align_to_center (bool): If True aligns to the center

   Returns:



.. py:function:: replace_curve(orig_curve, new_curve, snap=True, transfer_color=True)

   Replace orig_curve with new_curve.

   Args:
       orig_curve (str): nurbsCurve to replace.
       new_curve (str): nurbsCurve to replace with.
       maintain_offset (bool, optional): Match position. Defaults to True.


.. py:function:: whip(node_list, attr_holder=None, create_up_grp=True, maximum_offset=5, diminish=0.8, attr_list=None)

   Create a whip like effect on the given nodes.


.. py:function:: whip_refresh()