MTOGraphics3DModelArticulation
==============================

.. py:class:: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation

   Class defining MTO model articulations.

.. py:currentmodule:: MTOGraphics3DModelArticulation

Overview
--------

.. tab-set::

    .. tab-item:: Methods

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_transformation_value`
              - Get the Transformation Value given the LOD (level of detail), articulation name and the transformation name.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.set_transformation_value`
              - Set the Transformation Value given the LOD and articulation name.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_available_articulations`
              - Get the available articulations.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_available_transformations`
              - Get the available transformations.

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.enable_default_save`
              - Save the articulation value as the default for all future sessions using this model. The articulation value is saved with the object and not with the model or articulation files.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.level_of_detail_count`
              - Specify the level of detail (LOD) for defining articulations, where 0 is the finest level of detail and 1 is the coarsest model.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.read_articulation_file_on_load`
              - Read the articulation file when MTO object is loaded.
            * - :py:attr:`~ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.save_articulation_file_on_save`
              - Save the articulations to the articulation file when MTO object is saved.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import MTOGraphics3DModelArticulation


Property detail
---------------

.. py:property:: enable_default_save
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.enable_default_save
    :type: bool

    Save the articulation value as the default for all future sessions using this model. The articulation value is saved with the object and not with the model or articulation files.

.. py:property:: level_of_detail_count
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.level_of_detail_count
    :type: int

    Specify the level of detail (LOD) for defining articulations, where 0 is the finest level of detail and 1 is the coarsest model.

.. py:property:: read_articulation_file_on_load
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.read_articulation_file_on_load
    :type: bool

    Read the articulation file when MTO object is loaded.

.. py:property:: save_articulation_file_on_save
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.save_articulation_file_on_save
    :type: bool

    Save the articulations to the articulation file when MTO object is saved.


Method detail
-------------



.. py:method:: get_transformation_value(self, level_of_detail: int, articulation: str, trans: str) -> float
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_transformation_value

    Get the Transformation Value given the LOD (level of detail), articulation name and the transformation name.

    :Parameters:

        **level_of_detail** : :obj:`~int`

        **articulation** : :obj:`~str`

        **trans** : :obj:`~str`


    :Returns:

        :obj:`~float`

.. py:method:: set_transformation_value(self, level_of_detail: int, articulation: str, trans: str, transformation_value: float) -> None
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.set_transformation_value

    Set the Transformation Value given the LOD and articulation name.

    :Parameters:

        **level_of_detail** : :obj:`~int`

        **articulation** : :obj:`~str`

        **trans** : :obj:`~str`

        **transformation_value** : :obj:`~float`


    :Returns:

        :obj:`~None`

.. py:method:: get_available_articulations(self, level_of_detail: int) -> list
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_available_articulations

    Get the available articulations.

    :Parameters:

        **level_of_detail** : :obj:`~int`


    :Returns:

        :obj:`~list`

.. py:method:: get_available_transformations(self, level_of_detail: int, artic_name: str) -> Graphics3DModelTransformationCollection
    :canonical: ansys.stk.core.stkobjects.MTOGraphics3DModelArticulation.get_available_transformations

    Get the available transformations.

    :Parameters:

        **level_of_detail** : :obj:`~int`

        **artic_name** : :obj:`~str`


    :Returns:

        :obj:`~Graphics3DModelTransformationCollection`