tik_manager4.dcc.maya.utils
===========================

.. py:module:: tik_manager4.dcc.maya.utils

.. autoapi-nested-parse::

   Collection of utility functions for Maya

   These are essentially methods are both required by the main module and the ingest,
   extract and/or validate modules.
   To prevent circular imports, these methods are collected here.



Functions
---------

.. autoapisummary::

   tik_manager4.dcc.maya.utils.get_ranges
   tik_manager4.dcc.maya.utils.get_scene_fps
   tik_manager4.dcc.maya.utils.keepselection
   tik_manager4.dcc.maya.utils.set_ranges
   tik_manager4.dcc.maya.utils.set_scene_fps
   tik_manager4.dcc.maya.utils.unique_name


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

.. py:function:: get_ranges()

   Get the viewport ranges.
   Returns (list): [<absolute range start>, <user range start>, <user range end>,
   <absolute range end>


.. py:function:: get_scene_fps()

   Return the current FPS value set by DCC. None if not supported.


.. py:function:: keepselection(func)

   Decorator method to keep the current selection. Useful where
   the wrapped method messes with the current selection


.. py:function:: set_ranges(range_list)

   Set the timeline ranges.
   Args:
       range_list: list of ranges as [<animation start>, <user min>, <user max>,
                                       <animation end>]

   Returns: None


.. py:function:: set_scene_fps(fps_value)

   Set the FPS value in DCC if supported.
   Args:
       fps_value: (integer) fps value

   Returns: None



.. py:function:: unique_name(name, return_counter=False, suffix=None)

   Searches the scene for match and returns a unique name for given name
   Args:
       name: (String) Name to query
       return_counter: (Bool) If true, returns the next available number instead of the object name
       suffix: (String) If defined and if name ends with this suffix, the increment numbers will be put before the.

   Returns: (String) uniquename