trigger.base.actions_session
============================

.. py:module:: trigger.base.actions_session


Attributes
----------

.. autoapisummary::

   trigger.base.actions_session.LOG


Classes
-------

.. autoapisummary::

   trigger.base.actions_session.ActionsSession


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

.. py:class:: ActionsSession(progress_listwidget=None, version_controller=None, *args, **kwargs)

   Bases: :py:obj:`dict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:method:: add_action(action_name=None, action_type=None, insert_index=None)

      Adds an action to the session database
      Args:
          action_name: (String) Nice name for the action
          action_type: (String) Type of the action. Must be one of the valid types

      Returns:




   .. py:method:: delete_action(action_name)

      Deletes the action by name from the dictionary



   .. py:method:: disable_action(action_name)


   .. py:method:: duplicate_action(action_name)

      Duplicates the given action



   .. py:method:: edit_action(action_name, property, new_value)

      Edits the property values
      Args:
          action_name: (String) Action by name
          property: (String) Data Property
          new_value: (Multi) The new value. If its not match to the value data of the property, will throw error

      Returns: True if success, None or False if not




   .. py:method:: enable_action(action_name)


   .. py:method:: export_session(file_path)

      Exports the session to the given file path



   .. py:method:: get_action(action_name)

      Returns the action dictionary item by name



   .. py:method:: get_action_type(action_name)


   .. py:method:: get_all_actions()

      Returns all available actions



   .. py:method:: get_info(action_name)


   .. py:method:: get_layout_ui(action_name, ctrl, layout)


   .. py:method:: import_session(file_path, insert_index=None)

      Imports the session from the file



   .. py:method:: is_enabled(action_name)


   .. py:method:: is_modified()

      Checks if the current file is different than the saved file



   .. py:method:: list_action_names()

      Returns all available action names



   .. py:method:: list_valid_actions()

      Returns all available actions



   .. py:method:: load_session(file_path)

      Loads the session from the file



   .. py:method:: move(action_name, new_index)

      Moves the action to the given index nmb



   .. py:method:: move_down(action_name)

      Moves the action one index down



   .. py:method:: move_up(action_name)

      Moves the action one index up



   .. py:method:: new_session()

      Clears the data



   .. py:method:: query_action(action_name, property)


   .. py:method:: rename_action(action_name, new_name)


   .. py:method:: reset_actions()


   .. py:method:: run_action(action_name)


   .. py:method:: run_all_actions(reset_scene=True, until=None)

      runs all actions in the actions list



   .. py:method:: run_save_action(action_name)


   .. py:method:: save_session(file_path)

      Saves the session to the given file path



   .. py:attribute:: action_data_dict

      Structure:
      {
      actions:[
                  {
                  "name": "body_kinetics",
                  "type": "kinematics",
                  "data": {ACTION_DATA}
                  },
                  {
                  "name": "Weights_Main_Body",
                  "type": "weights",
                  "data": {ACTION_DATA}
                  },
                  {
                  "name": "Final_Cleanup",
                  "type": "cleanup",
                  "data": {ACTION_DATA}
                  }
                  {
                  "name": "Add_Extras",
                  "type": "python",
                  "data": {ACTION_DATA}
                  }       
              ]
      }



   .. py:property:: session_path


.. py:data:: LOG