trigger.library.icons ===================== .. py:module:: trigger.library.icons .. autoapi-nested-parse:: Module to create icons for rigging purposes. Classes ------- .. autoapisummary:: trigger.library.icons.Icon Module Contents --------------- .. py:class:: Icon Bases: :py:obj:`object` .. py:method:: arrow(name='arrow_cont') :staticmethod: .. py:method:: circle(name='circle_cont') :staticmethod: Creates a circle controller. Nothing Fancy... Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) normal: (Vector) Optional Normal as vector. Default is (0, 1, 0) Y Up Returns: Controller node .. py:method:: cog(name='cog_cont') :staticmethod: .. py:method:: create_icon(icon_type, icon_name=None, scale=(1, 1, 1), location=None, normal=(0, 1, 0)) Creates an icon of given type. .. py:method:: cube(name='cube_cont') :staticmethod: Creates a cube controller as a single shape Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: curved_arrow(name='curvedArrow_cont') :staticmethod: .. py:method:: curved_circle(name='curvedCircle_cont') :staticmethod: Creates a slightly curved circle controller Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: cylinder(name='cylinder_cont') :staticmethod: .. py:method:: diamond(name='diamond_cont') :staticmethod: .. py:method:: drop(name='drop_cont') :staticmethod: Creates a star-ish shaped controller Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) normal: (Vector) Optional normal override Returns: Controller node .. py:method:: drop_circle_x(name='dropCircle_cont') :staticmethod: .. py:method:: dual_curved_arrow(name='dualCurvedArrow_cont') :staticmethod: .. py:method:: fk_ik_switch(name='fkik_cont') :staticmethod: Creates a FK-IK controller. Args: name: (String) name of the controller. Must be a String Returns: A list Containing Controller Node (index 0) and Reverse node (1) to be used in conjunction with fk_ik attribute. [Controller Node, Reverse Node for connections] .. py:method:: get_icons_list() Return the list of icons available. .. py:method:: half_dome(name='halfDome_cont') :staticmethod: .. py:method:: lollipop(name='lollipop_cont') :staticmethod: .. py:method:: looper(name='looper_cont') :staticmethod: .. py:method:: ngon(name='ngon_cont') :staticmethod: Creates a ngon controller. Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: plus(name='plus_cont') :staticmethod: Creates a plus controller. Usually for pole vector Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: preferences(name='pref_cont') :staticmethod: .. py:method:: pyramid(name='pyramid_cont') :staticmethod: .. py:method:: rotator(name='rotator_cont') :staticmethod: .. py:method:: shoulder(name='shoulder_cont') :staticmethod: Creates a bended Eliptical controller for shoulders. Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: sphere(name='sphere_cont') :staticmethod: .. py:method:: square(name='square_cont') :staticmethod: Creates a square controller. Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: star(name='star_cont') :staticmethod: Creates a star-ish shaped controller Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) normal: (Vector) Optional normal override Returns: Controller node .. py:method:: thigh(name='thigh_cont') :staticmethod: Creates a cube controller as a single shape Args: name: (String) name of the controller. Must be a String scale: (Vector) Scale value as vector. example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: triangle(name='triangle_cont') :staticmethod: .. py:method:: triangle_arrow(name='triangleArrow_cont') :staticmethod: .. py:method:: triangle_dual_arrow(name='triangleDualArrow_cont') :staticmethod: .. py:method:: tricircle(name='triCircle_cont') :staticmethod: Creates a circle controller with triangles on each direction. Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node .. py:method:: waist(name='waist_cont') :staticmethod: Creates a plus controller. Usually for pole vector Args: name: (String) name of the controller. Must be a String scale: (Vector) scale value as vector, example (1,1.5,1) location: (Vector) Optional Location as vector. example (12,0,2) Returns: Controller node