====================
PostprocessingEffect
====================

.. py:currentmodule:: p3dsdk

.. py:class:: PostprocessingEffect


   .. py:method:: id
      :property:

      The id of the postprocessing effect.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: postprocess
      :property:

      The parent postprocess.

      :type: Postprocess, read-only

   .. py:method:: description
      :property:

      The description of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: index
      :property:

      The index of this postprocessing effect in the postprocessing effect list.

      :type: int
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      Whether the postprocessing effect is enabled.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove(force = False)

      Delete this postprocessing effect

      .. note::
         By default, only not used postprocessing effect can be deleted (:py:obj:`InUseError` is raised otherwise), use :py:obj:`force` to force deletion of used postprocessing effect.

      :param force: Force the deletion of the postprocessing effect even if it is in use.
      :type force: bool


      :raises InUseError: If :py:obj:`force` is :py:obj:`False` and the postprocessing effect is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


PostprocessingEffectAddMultiply
-------------------------------

.. py:class:: PostprocessingEffectAddMultiply

   Base class: :py:class:`PostprocessingEffect`


   .. py:method:: id
      :property:

      The id of the postprocessing effect.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: postprocess
      :property:

      The parent postprocess.

      :type: Postprocess, read-only

   .. py:method:: description
      :property:

      The description of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: index
      :property:

      The index of this postprocessing effect in the postprocessing effect list.

      :type: int
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      Whether the postprocessing effect is enabled.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: add
      :property:

      The value to add.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: multiply
      :property:

      The value to multiply.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: allow_negative_values
      :property:

      Whether negative values are allowed or not.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove(force = False)

      Delete this postprocessing effect

      .. note::
         By default, only not used postprocessing effect can be deleted (:py:obj:`InUseError` is raised otherwise), use :py:obj:`force` to force deletion of used postprocessing effect.

      :param force: Force the deletion of the postprocessing effect even if it is in use.
      :type force: bool


      :raises InUseError: If :py:obj:`force` is :py:obj:`False` and the postprocessing effect is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


PostprocessingEffectBloom
-------------------------

.. py:class:: PostprocessingEffectBloom

   Base class: :py:class:`PostprocessingEffect`


   .. py:method:: id
      :property:

      The id of the postprocessing effect.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: postprocess
      :property:

      The parent postprocess.

      :type: Postprocess, read-only

   .. py:method:: description
      :property:

      The description of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: index
      :property:

      The index of this postprocessing effect in the postprocessing effect list.

      :type: int
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      Whether the postprocessing effect is enabled.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: threshold
      :property:

      The threshold for the bloom effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: factor
      :property:

      The factor applied to the bloom effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: radius
      :property:

      The radius of the bloom effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove(force = False)

      Delete this postprocessing effect

      .. note::
         By default, only not used postprocessing effect can be deleted (:py:obj:`InUseError` is raised otherwise), use :py:obj:`force` to force deletion of used postprocessing effect.

      :param force: Force the deletion of the postprocessing effect even if it is in use.
      :type force: bool


      :raises InUseError: If :py:obj:`force` is :py:obj:`False` and the postprocessing effect is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


PostprocessingEffectBlur
------------------------

.. py:class:: PostprocessingEffectBlur

   Base class: :py:class:`PostprocessingEffect`


   .. py:method:: id
      :property:

      The id of the postprocessing effect.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: postprocess
      :property:

      The parent postprocess.

      :type: Postprocess, read-only

   .. py:method:: description
      :property:

      The description of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: index
      :property:

      The index of this postprocessing effect in the postprocessing effect list.

      :type: int
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      Whether the postprocessing effect is enabled.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: radius
      :property:

      The radius of the blur effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove(force = False)

      Delete this postprocessing effect

      .. note::
         By default, only not used postprocessing effect can be deleted (:py:obj:`InUseError` is raised otherwise), use :py:obj:`force` to force deletion of used postprocessing effect.

      :param force: Force the deletion of the postprocessing effect even if it is in use.
      :type force: bool


      :raises InUseError: If :py:obj:`force` is :py:obj:`False` and the postprocessing effect is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


PostprocessingEffectSharpen
---------------------------

.. py:class:: PostprocessingEffectSharpen

   Base class: :py:class:`PostprocessingEffect`


   .. py:method:: id
      :property:

      The id of the postprocessing effect.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: postprocess
      :property:

      The parent postprocess.

      :type: Postprocess, read-only

   .. py:method:: description
      :property:

      The description of the postprocessing  effect.

      :type: str, read-only

   .. py:method:: index
      :property:

      The index of this postprocessing effect in the postprocessing effect list.

      :type: int
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      Whether the postprocessing effect is enabled.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: amount
      :property:

      The amount for the sharpen effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: radius
      :property:

      The radius of the sharpen effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: threshold
      :property:

      The threshold for the sharpen effect.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove(force = False)

      Delete this postprocessing effect

      .. note::
         By default, only not used postprocessing effect can be deleted (:py:obj:`InUseError` is raised otherwise), use :py:obj:`force` to force deletion of used postprocessing effect.

      :param force: Force the deletion of the postprocessing effect even if it is in use.
      :type force: bool


      :raises InUseError: If :py:obj:`force` is :py:obj:`False` and the postprocessing effect is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.