.. _types-api:

Supporting Types
================

.. py:class:: FilterInfo

   Describes one registered filter.


.. py:currentmodule:: _qmeshlab

Attributes
----------

.. py:attribute:: FilterInfo.applicability_error
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.applicable
   :module: _qmeshlab

   (self) -> bool

.. py:attribute:: FilterInfo.id
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.key
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.name
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.plugin_id
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.plugin_name
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterInfo.python_name
   :module: _qmeshlab

   (self) -> str

Methods
-------

.. py:method:: FilterInfo.__init__(self, /, *args, **kwargs)
   :module: _qmeshlab

   Initialize self.  See help(type(self)) for accurate signature.

.. py:method:: FilterInfo.__repr__(...)
   :module: _qmeshlab

   __repr__(self) -> str

.. py:class:: FilterRunResult

   Return value from ``apply_filter``.


.. py:currentmodule:: _qmeshlab

Attributes
----------

.. py:attribute:: FilterRunResult.document_modified
   :module: _qmeshlab

   (self) -> bool

.. py:attribute:: FilterRunResult.error_message
   :module: _qmeshlab

   (self) -> str

.. py:attribute:: FilterRunResult.info_messages
   :module: _qmeshlab

   (self) -> list[str]

.. py:attribute:: FilterRunResult.new_mesh_indices
   :module: _qmeshlab

   (self) -> list[int]

.. py:attribute:: FilterRunResult.output_values
   :module: _qmeshlab

   (self) -> dict

.. py:attribute:: FilterRunResult.success
   :module: _qmeshlab

   (self) -> bool

Methods
-------

.. py:method:: FilterRunResult.__init__(self, /, *args, **kwargs)
   :module: _qmeshlab

   Initialize self.  See help(type(self)) for accurate signature.

.. py:method:: FilterRunResult.__repr__(self, /)
   :module: _qmeshlab

   Return repr(self).