trigger.objects.ribbon
======================

.. py:module:: trigger.objects.ribbon

.. autoapi-nested-parse::

   Creates a ribbon joint chain between given nodes



Classes
-------

.. autoapisummary::

   trigger.objects.ribbon.Ribbon


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

.. py:class:: Ribbon(start_node=None, end_node=None, name=None, ribbon_resolution=5, joint_resolution=5, controller_count=1, controller_list=None, dropoff=2.0, connect_start_aim=True, up_vector=(0, 1, 0), scaleable=True)

   Bases: :py:obj:`object`


   .. py:method:: create()


   .. py:method:: orient(node_a, node_b=None, switch_a=None, switch_b=None)

      Orients the start aim of the ribbon to given controller(s)

      Args:
          node_a: (String) The first controller that the end will be oriented to
          node_b: (String) If defined, the end will be oriented to both nodes
          switch_a: (String) Attribute that will drive the first switch. Optional
          switch_b: (String) Attribute that will drive the first switch. Optional

      Returns:
          (String) Parent Constraint (translates skipped)




   .. py:method:: pin_end(node_a, node_b=None, switch_a=None, switch_b=None)

      Connects the end of the ribbon to given controller(s)

      Args:
          node_a: (String) The first controller that the end will be pinned to
          node_b: (String) If defined, the end will be pinned to both nodes
          switch_a: (String) Attribute that will drive the first switch. Optional
          switch_b: (String) Attribute that will drive the first switch. Optional

      Returns:
          (String) Parent Constraint




   .. py:method:: pin_start(node_a, node_b=None, switch_a=None, switch_b=None)

      Connects the start of the ribbon to given controller(s)

      Args:
          node_a: (String) The first controller that the start will be pinned to
          node_b: (String) If defined, the start will be pinned to both nodes
          switch_a: (String) Attribute that will drive the first switch. Optional
          switch_b: (String) Attribute that will drive the first switch. Optional

      Returns:
          (String) Parent Constraint




   .. py:property:: connect_start_aim


   .. py:property:: controller_count


   .. py:property:: controller_list


   .. py:property:: controllers


   .. py:property:: deformer_joints


   .. py:property:: dropoff


   .. py:property:: end_aim


   .. py:property:: end_node


   .. py:property:: end_plug


   .. py:property:: end_up


   .. py:property:: joint_resolution


   .. py:property:: name


   .. py:property:: nonscale_grp


   .. py:property:: ribbon_grp


   .. py:property:: ribbon_resolution


   .. py:property:: scale_grp


   .. py:property:: scaleable


   .. py:property:: start_aim


   .. py:property:: start_node


   .. py:property:: start_plug


   .. py:property:: start_up


   .. py:property:: to_hide


   .. py:property:: up_vector